| Package | org.openvideoplayer.plugins |
| Interface | public interface IOvpPlayer extends flash.events.IEventDispatcher |
| Property | Defined By | ||
|---|---|---|---|
| advertisingMode : Boolean [write-only]
Puts the player in advertising mode, meaning:
the video is paused.
all transport controls are disabled
| IOvpPlayer | ||
| captionsActive : Boolean [read-only]
True if the player is in caption mode (displaying closed captions). | IOvpPlayer | ||
| contentHeight : int [read-only]
The rendering content's current height. | IOvpPlayer | ||
| contentTitle : String [read-only]
The rendering content's current title. | IOvpPlayer | ||
| contentURL : String [read-only]
The rendering content's URL. | IOvpPlayer | ||
| contentWidth : int [read-only]
The rendering content's current width. | IOvpPlayer | ||
| currentBitrate : int [read-only]
Returns the bitrate of the currently loaded video, in kilobits per second, for example 500 means 500kbps. | IOvpPlayer | ||
| duration : Number [read-only]
The duration of the currently rendering content. | IOvpPlayer | ||
| flashvars : Object [read-only]
Returns the flashvars passed into the player as an Object. | IOvpPlayer | ||
| fullScreen : Boolean [read-only]
True if the player is in full screen mode. | IOvpPlayer | ||
| hasAudio : Boolean [read-only]
True if the rendering content contains audio. | IOvpPlayer | ||
| hasCaptions : Boolean [read-only]
True if the rending content has caption, this does not
necessary mean they are active. | IOvpPlayer | ||
| hasVideo : Boolean [read-only]
True if the rendering content contains video. | IOvpPlayer | ||
| itemCount : int [read-only]
Number of items in the current play list. | IOvpPlayer | ||
| itemsPlayed : int [read-only]
Number of items that have played. | IOvpPlayer | ||
| playerHeight : int [read-only]
The current player height. | IOvpPlayer | ||
| playerWidth : int [read-only]
The current player width. | IOvpPlayer | ||
| plugins : Array [read-only]
Returns an Array of Sprite objects. | IOvpPlayer | ||
| position : int [read-only]
The current position of the rendering content. | IOvpPlayer | ||
| Method | Defined By | ||
|---|---|---|---|
addCuePoint(cuePoint:Object):void
Adds an ActionScript cue point. | IOvpPlayer | ||
getSpriteById(id:String):Sprite
Asks the player to return a specific sprite with the ID specified. | IOvpPlayer | ||
pausePlayer():void
Pauses the current content. | IOvpPlayer | ||
resumePlayer():void
Resumes (after pause) the current content. | IOvpPlayer | ||
startPlayer():void
Starts the current content playing. | IOvpPlayer | ||
stopPlayer():void
Stops the current content. | IOvpPlayer | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when an ActionScript cue point requested by the plug-in has been reached. | IOvpPlayer | |||
| Plug-ins can dispatch this event to allow a player to easily show an end-user what is happening. | IOvpPlayer | |||
| The player can dispatch serious errors if it wishes to. | IOvpPlayer | |||
| The player dispatches this event when it's state has changed. | IOvpPlayer | |||
| The player can dispatch this event when the server acknowledges the switch request. | IOvpPlayer | |||
| The player can dispatch this event when the switch has completed and is visible to the user. | IOvpPlayer | |||
| The player can dispatch this event when it is playing multi-bitrate content (dynamic streaming). | IOvpPlayer | |||
| The volume changed in the player. | IOvpPlayer | |||
| advertisingMode | property |
advertisingMode:Boolean [write-only] Puts the player in advertising mode, meaning:
public function set advertisingMode(value:Boolean):void| captionsActive | property |
captionsActive:Boolean [read-only] True if the player is in caption mode (displaying closed captions).
public function get captionsActive():Boolean| contentHeight | property |
contentHeight:int [read-only] The rendering content's current height.
public function get contentHeight():int| contentTitle | property |
contentTitle:String [read-only] The rendering content's current title.
public function get contentTitle():String| contentURL | property |
contentURL:String [read-only] The rendering content's URL.
public function get contentURL():String| contentWidth | property |
contentWidth:int [read-only] The rendering content's current width.
public function get contentWidth():int| currentBitrate | property |
currentBitrate:int [read-only] Returns the bitrate of the currently loaded video, in kilobits per second, for example 500 means 500kbps. The player should return 0 if no video is loaded.
public function get currentBitrate():int| duration | property |
duration:Number [read-only] The duration of the currently rendering content.
public function get duration():Number| flashvars | property |
flashvars:Object [read-only] Returns the flashvars passed into the player as an Object.
public function get flashvars():Object| fullScreen | property |
fullScreen:Boolean [read-only] True if the player is in full screen mode.
public function get fullScreen():Boolean| hasAudio | property |
hasAudio:Boolean [read-only] True if the rendering content contains audio.
public function get hasAudio():Boolean| hasCaptions | property |
hasCaptions:Boolean [read-only] True if the rending content has caption, this does not necessary mean they are active.
public function get hasCaptions():BooleanSee also
| hasVideo | property |
hasVideo:Boolean [read-only] True if the rendering content contains video.
public function get hasVideo():Boolean| itemCount | property |
itemCount:int [read-only] Number of items in the current play list.
public function get itemCount():int| itemsPlayed | property |
itemsPlayed:int [read-only] Number of items that have played.
public function get itemsPlayed():int| playerHeight | property |
playerHeight:int [read-only] The current player height.
public function get playerHeight():int| playerWidth | property |
playerWidth:int [read-only] The current player width.
public function get playerWidth():int| plugins | property |
plugins:Array [read-only] Returns an Array of Sprite objects. Each object is the main display object for the plug-in.
public function get plugins():Array| position | property |
position:int [read-only] The current position of the rendering content.
public function get position():int| addCuePoint | () | method |
public function addCuePoint(cuePoint:Object):voidAdds an ActionScript cue point.
Parameters
cuePoint:Object |
| getSpriteById | () | method |
public function getSpriteById(id:String):SpriteAsks the player to return a specific sprite with the ID specified. This allows a plug-in to add itself as a child to a sprite in the player.
Parameters
id:String |
Sprite |
| pausePlayer | () | method |
public function pausePlayer():voidPauses the current content.
| resumePlayer | () | method |
public function resumePlayer():voidResumes (after pause) the current content.
| startPlayer | () | method |
public function startPlayer():voidStarts the current content playing.
| stopPlayer | () | method |
public function stopPlayer():voidStops the current content.
| cuepoint | Event |
org.openvideoplayer.plugins.OvpPlayerEventDispatched when an ActionScript cue point requested by the plug-in has been reached. Plug-ins can set ActionScript cue points via the addCuePoint method.
| debugmsg | Event |
org.openvideoplayer.plugins.OvpPlayerEventPlug-ins can dispatch this event to allow a player to easily show an end-user what is happening. The data object will be the debug message as a String.
| error | Event |
org.openvideoplayer.plugins.OvpPlayerEventThe player can dispatch serious errors if it wishes to. The data object will be an error message in this case.
| statechange | Event |
org.openvideoplayer.plugins.OvpPlayerEvent
The player dispatches this event when it's state has changed. The data object will contain one
of the STATE_CHANGE event data values found in the OvpPlayerEvent class. See the
OvpPlayerEvent class for the possible states for this event.
| switchAcknowledged | Event |
org.openvideoplayer.plugins.OvpPlayerEvent
The player can dispatch this event when the server acknowledges the switch request. See the OvpPlayerEvent
class for details on this event.
| switchComplete | Event |
org.openvideoplayer.plugins.OvpPlayerEvent
The player can dispatch this event when the switch has completed and is visible to the user.
See the OvpPlayerEvent class for details on this event.
| switchRequested | Event |
org.openvideoplayer.plugins.OvpPlayerEvent
The player can dispatch this event when it is playing multi-bitrate content (dynamic streaming). This event
indicates a switch has been requested. The data object within the event object contains
details of the switch request. See the OvpPlayerEvent class for properties on the
data object for this event.
| volumechange | Event |
org.openvideoplayer.plugins.OvpPlayerEventThe volume changed in the player. The data object will be an Number with a value from 0 (muted) to 1 (full volume);