Packageorg.openvideoplayer.advertising
Interfacepublic interface IMASTAdapter extends flash.events.IEventDispatcher

The purpose of the IMASTAdapter interface is to provide an adapter between the player and the MAST engine.



Public Properties
 PropertyDefined By
  captionsActive : Boolean
[read-only] True if captions are active and being shown
IMASTAdapter
  contentBitrate : int
[read-only] The bitrate-in-use of the current content
IMASTAdapter
  contentHeight : int
[read-only] The native height of the current content
IMASTAdapter
  contentTitle : String
[read-only] The title of the current content
IMASTAdapter
  contentUrl : String
[read-only] The URL that the current content was received from
IMASTAdapter
  contentWidth : int
[read-only] The native width of the current content
IMASTAdapter
  duration : Number
[read-only] The duration of the current content
IMASTAdapter
  fullScreen : Boolean
[read-only] True if the player is fullscreen
IMASTAdapter
  hasAudio : Boolean
[read-only] True if the current content has an audio stream
IMASTAdapter
  hasCaptions : Boolean
[read-only] True if the current content has captions available
IMASTAdapter
  hasVideo : Boolean
[read-only] True if the current content has a video stream
IMASTAdapter
  isPaused : Boolean
[read-only] True if the player is paused
IMASTAdapter
  isPlaying : Boolean
[read-only] True if the player is playing content
IMASTAdapter
  isStopped : Boolean
[read-only] True if the player is stopped, or not yet started
IMASTAdapter
  itemsPlayed : int
[read-only] The count of items that have been displayed in full or part.
IMASTAdapter
  playerHeight : int
[read-only] The physical height of the player applciation
IMASTAdapter
  playerWidth : int
[read-only] The physical width of the player applciation
IMASTAdapter
  pollingFrequency : int
[read-only] The frequency in milliseconds, a MAST engine will poll top-level property triggers.
IMASTAdapter
  position : Number
[read-only] The position of the current content
IMASTAdapter
  systemTime : Date
[read-only] The current system time
IMASTAdapter
  totalWatchedTime : Number
[read-only] The total amount of content that has been rendered in this session
IMASTAdapter
  watchedTime : Number
[read-only] The amount of time that this item has rendered, regardless of seeks
IMASTAdapter
Public Methods
 MethodDefined By
  
Called by Mainsail when a trigger is being activated
IMASTAdapter
  
addCuePoint(cp:Object):void
Add a dynamic cue point.
IMASTAdapter
  
Called by Mainsail or by the payload handler when a trigger/payload is complete or being deactivated
IMASTAdapter
  
getTargetRegionMovieClip(region:String):Sprite
Called by a plug-in that wishes to add an ad display object to the player.
IMASTAdapter
Events
 Event Summary Defined By
  A cue point event occurred.IMASTAdapter
  The player has stopped naturally, with no new contentIMASTAdapter
  An error has occurred, typically of enough severity to warrant display to the userIMASTAdapter
  Fullscreen has been toggledIMASTAdapter
  The current item is coming to the endIMASTAdapter
  A new item is being startedIMASTAdapter
  The mouse has movedIMASTAdapter
  The player was muted, or volume brought to 0IMASTAdapter
  Athe pause command is givenIMASTAdapter
  Defined as anytime the play command is issued, even after a pauseIMASTAdapter
  Player size has changedIMASTAdapter
  The player was manually seekedIMASTAdapter
  The stop command is givenIMASTAdapter
  Volume was changedIMASTAdapter
Property Detail
captionsActiveproperty
captionsActive:Boolean  [read-only]

True if captions are active and being shown


Implementation
    public function get captionsActive():Boolean
contentBitrateproperty 
contentBitrate:int  [read-only]

The bitrate-in-use of the current content


Implementation
    public function get contentBitrate():int
contentHeightproperty 
contentHeight:int  [read-only]

The native height of the current content


Implementation
    public function get contentHeight():int
contentTitleproperty 
contentTitle:String  [read-only]

The title of the current content


Implementation
    public function get contentTitle():String
contentUrlproperty 
contentUrl:String  [read-only]

The URL that the current content was received from


Implementation
    public function get contentUrl():String
contentWidthproperty 
contentWidth:int  [read-only]

The native width of the current content


Implementation
    public function get contentWidth():int
durationproperty 
duration:Number  [read-only]

The duration of the current content


Implementation
    public function get duration():Number
fullScreenproperty 
fullScreen:Boolean  [read-only]

True if the player is fullscreen


Implementation
    public function get fullScreen():Boolean
hasAudioproperty 
hasAudio:Boolean  [read-only]

True if the current content has an audio stream


Implementation
    public function get hasAudio():Boolean
hasCaptionsproperty 
hasCaptions:Boolean  [read-only]

True if the current content has captions available


Implementation
    public function get hasCaptions():Boolean
hasVideoproperty 
hasVideo:Boolean  [read-only]

True if the current content has a video stream


Implementation
    public function get hasVideo():Boolean
isPausedproperty 
isPaused:Boolean  [read-only]

True if the player is paused


Implementation
    public function get isPaused():Boolean
isPlayingproperty 
isPlaying:Boolean  [read-only]

True if the player is playing content


Implementation
    public function get isPlaying():Boolean
isStoppedproperty 
isStopped:Boolean  [read-only]

True if the player is stopped, or not yet started


Implementation
    public function get isStopped():Boolean
itemsPlayedproperty 
itemsPlayed:int  [read-only]

The count of items that have been displayed in full or part.


Implementation
    public function get itemsPlayed():int
playerHeightproperty 
playerHeight:int  [read-only]

The physical height of the player applciation


Implementation
    public function get playerHeight():int
playerWidthproperty 
playerWidth:int  [read-only]

The physical width of the player applciation


Implementation
    public function get playerWidth():int
pollingFrequencyproperty 
pollingFrequency:int  [read-only]

The frequency in milliseconds, a MAST engine will poll top-level property triggers.


Implementation
    public function get pollingFrequency():int
positionproperty 
position:Number  [read-only]

The position of the current content


Implementation
    public function get position():Number
systemTimeproperty 
systemTime:Date  [read-only]

The current system time


Implementation
    public function get systemTime():Date
totalWatchedTimeproperty 
totalWatchedTime:Number  [read-only]

The total amount of content that has been rendered in this session


Implementation
    public function get totalWatchedTime():Number
watchedTimeproperty 
watchedTime:Number  [read-only]

The amount of time that this item has rendered, regardless of seeks


Implementation
    public function get watchedTime():Number
Method Detail
activateTrigger()method
public function activateTrigger(trigger:IMASTTrigger):void

Called by Mainsail when a trigger is being activated

Parameters

trigger:IMASTTrigger

addCuePoint()method 
public function addCuePoint(cp:Object):void

Add a dynamic cue point.

Parameters

cp:Object

deactivateTrigger()method 
public function deactivateTrigger(trigger:IMASTTrigger):void

Called by Mainsail or by the payload handler when a trigger/payload is complete or being deactivated

Parameters

trigger:IMASTTrigger

getTargetRegionMovieClip()method 
public function getTargetRegionMovieClip(region:String):Sprite

Called by a plug-in that wishes to add an ad display object to the player.

Parameters

region:String

Returns
Sprite
Event Detail
OnCuePoint Event
Event Object Type: org.openvideoplayer.advertising.MASTAdapterEvent

A cue point event occurred.

OnEnd Event  
Event Object Type: org.openvideoplayer.advertising.MASTAdapterEvent

The player has stopped naturally, with no new content

OnError Event  
Event Object Type: org.openvideoplayer.advertising.MASTAdapterEvent

An error has occurred, typically of enough severity to warrant display to the user

OnFullScreenChange Event  
Event Object Type: org.openvideoplayer.advertising.MASTAdapterEvent

Fullscreen has been toggled

OnItemEnd Event  
Event Object Type: org.openvideoplayer.advertising.MASTAdapterEvent

The current item is coming to the end

OnItemStart Event  
Event Object Type: org.openvideoplayer.advertising.MASTAdapterEvent

A new item is being started

OnMouseOver Event  
Event Object Type: org.openvideoplayer.advertising.MASTAdapterEvent

The mouse has moved

OnMute Event  
Event Object Type: org.openvideoplayer.advertising.MASTAdapterEvent

The player was muted, or volume brought to 0

OnPause Event  
Event Object Type: org.openvideoplayer.advertising.MASTAdapterEvent

Athe pause command is given

OnPlay Event  
Event Object Type: org.openvideoplayer.advertising.MASTAdapterEvent

Defined as anytime the play command is issued, even after a pause

OnPlayerSizeChanged Event  
Event Object Type: org.openvideoplayer.advertising.MASTAdapterEvent

Player size has changed

OnSeek Event  
Event Object Type: org.openvideoplayer.advertising.MASTAdapterEvent

The player was manually seeked

OnStop Event  
Event Object Type: org.openvideoplayer.advertising.MASTAdapterEvent

The stop command is given

OnVolumeChange Event  
Event Object Type: org.openvideoplayer.advertising.MASTAdapterEvent

Volume was changed