AnyClip Players‎ > ‎

Reference: LitePlayer_FDRV

DocumentationAll Packages | All Classes | Index | Frames Adobe Logo
LitePlayer_LiveRail_FDRV_VPAIDProperties | Methods | Constants
 
PackageTop Level
Classpublic class LitePlayer_LiveRail_FDRV_VPAID
InheritanceLitePlayer_LiveRail_FDRV_VPAID Inheritance flash.display.Sprite


Protected Properties
 PropertyDefined By
  ad : *
Legacy, the inhouse ad object.
LitePlayer_LiveRail_FDRV_VPAID
  _asset : MovieClip
LitePlayer_LiveRail_FDRV_VPAID
  buyLinkImage : Sprite
LitePlayer_LiveRail_FDRV_VPAID
  clipDuration : Number
The video clip's duration returned in getDuration() when called from the Widget, can also be retrieved from the videoMetadata object
LitePlayer_LiveRail_FDRV_VPAID
  clipEnded : Boolean
A flag used to determine the next step (resume/next clip) after a failure or completion of external ad
LitePlayer_LiveRail_FDRV_VPAID
  _clipPageUrl : String
LitePlayer_LiveRail_FDRV_VPAID
  clipPageUrl : String
A getter for the clipPageUrl value
LitePlayer_LiveRail_FDRV_VPAID
  clipStartedEventDispatched : Boolean
Used as a flag to make sure the clipStarted event isn't reported twice per clip
LitePlayer_LiveRail_FDRV_VPAID
  connection : NetConnection
The video's server connection object
LitePlayer_LiveRail_FDRV_VPAID
  connectionHasEventListeners : Boolean
A flag used to determine whether the connection object has event listeners (in order to clear them between clips if the video's host is different)
LitePlayer_LiveRail_FDRV_VPAID
  currentHeight : Number
^the same, for width
LitePlayer_LiveRail_FDRV_VPAID
  currentWidth : Number
used to identify a change in external dimensions in order to prevent repetitive calls in updateDisplay() method.
LitePlayer_LiveRail_FDRV_VPAID
  eventsFunc : String
^ditto
LitePlayer_LiveRail_FDRV_VPAID
  firstClip : Boolean = true
A flag for deciding if to request a preroll from the Widget, depends on whether the current clip is the first to be played since the player loaded or not.
LitePlayer_LiveRail_FDRV_VPAID
  firstPlay : Boolean = true
A flag for deciding if it is the first time that the current clip is played? resets to "true" for each loaded clip.
LitePlayer_LiveRail_FDRV_VPAID
  houseAdEnabled : Boolean = false
Legacy, determines whether the inhouse ad should be initialized and played
LitePlayer_LiveRail_FDRV_VPAID
  inHouseAd : DisplayObject
Legacy, the inhouse ad object container.
LitePlayer_LiveRail_FDRV_VPAID
  lastNetStatusCode : String
Determines the last recieved netstatus code and checked in onNetStatus() in order to prevent "false positives" (i.e.
LitePlayer_LiveRail_FDRV_VPAID
  loadingAnimation : Sprite
LitePlayer_LiveRail_FDRV_VPAID
  logo : Sprite
LitePlayer_LiveRail_FDRV_VPAID
  midrolls : Array
Legacy, the midrolls cue points (in seconds) array
LitePlayer_LiveRail_FDRV_VPAID
  muteButton : Sprite
LitePlayer_LiveRail_FDRV_VPAID
  muted : Boolean
Current state of muting, returned through isMuted() when called from the Widget.
LitePlayer_LiveRail_FDRV_VPAID
  muteOnLoad : Boolean
determines whether the player should start in muted mode, defaulted to "true" on initFlashVars() if not specified
LitePlayer_LiveRail_FDRV_VPAID
  overlayRequested : Boolean = false
Overlay request flag, prevents concurrent requests for overlay
LitePlayer_LiveRail_FDRV_VPAID
  placementId : String
^ditto
LitePlayer_LiveRail_FDRV_VPAID
  playbackTimer : Timer
A timer sampling the current position of the clip playback, used to determine when to request overlays and midrolls (Legacy, currently)
LitePlayer_LiveRail_FDRV_VPAID
  playerId : String
legacy, but might be still used in some parts of the widget.
LitePlayer_LiveRail_FDRV_VPAID
  ratio : Number = 1
the video ratio, updated once the video metadata is recieved by making a division of the video file's original width and height.
LitePlayer_LiveRail_FDRV_VPAID
  showLogo : Boolean
determines whether the player should contain anyclip's logo
LitePlayer_LiveRail_FDRV_VPAID
  sprintLabel : String = Jaws
The Right-Click Context menu sprint label value
LitePlayer_LiveRail_FDRV_VPAID
  sprintVersion : String = 0.1.0
The Right-Click Context menu sprint version value
LitePlayer_LiveRail_FDRV_VPAID
  stream : NetStream
The video's stream object
LitePlayer_LiveRail_FDRV_VPAID
  streamFile : String
the file name including extension
LitePlayer_LiveRail_FDRV_VPAID
  streamHost : String
the video file's url including folder and subfolder
LitePlayer_LiveRail_FDRV_VPAID
  streamProtocol : String
the video file url's protocol."rtmp"/"http"
LitePlayer_LiveRail_FDRV_VPAID
  time : Number
Current clip playback position, used to determine whether the actual video time has changed before checking for overlays and midrolls
LitePlayer_LiveRail_FDRV_VPAID
  updateViewActive : Boolean
used to prevent simultanious calls to updateView() method.
LitePlayer_LiveRail_FDRV_VPAID
  video : Video
The video display object
LitePlayer_LiveRail_FDRV_VPAID
  videoMetadata : Object
A data object from the loaded video file
LitePlayer_LiveRail_FDRV_VPAID
  videoOverlay : DisplayObject
Clickable transparent video overlay, for the VIDEO_CLICK event reporting
LitePlayer_LiveRail_FDRV_VPAID
  _volume : Number = 1
local volume value (for reference only)
LitePlayer_LiveRail_FDRV_VPAID
  volume : Number
[write-only] Sets the volume for the stream, used internally only
LitePlayer_LiveRail_FDRV_VPAID
Public Methods
 MethodDefined By
  
Constructor
LitePlayer_LiveRail_FDRV_VPAID
  
addChild(child:DisplayObject):DisplayObject
[override] Overriden the default addChild method in order to force a call to udpateVide();
LitePlayer_LiveRail_FDRV_VPAID
  
onBWDone(... parameters):void
DO NOT REMOVE! Required by the connection and the stream (since their client propery is set to "this") in order to prevent an error
LitePlayer_LiveRail_FDRV_VPAID
  
onMetaData(metadata:Object):void
DO NOT REMOVE! Required by the connection and the stream (since their client propery is set to "this") Called by the connection and the stream once the video file's stream has been connected and the video metadata has been loaded
LitePlayer_LiveRail_FDRV_VPAID
  
onPlayStatus(info:Object):void
Used to determine the absolute real end of the video playback.
LitePlayer_LiveRail_FDRV_VPAID
  
unpackEmbed(assetClass:Class):void
Legacy, used for the inHouseAd embedded class - Initiates an an embedded swf unpacking to a fully working local swf with communication abilities
LitePlayer_LiveRail_FDRV_VPAID
Protected Methods
 MethodDefined By
  
Add the connection's event listeners for security, IO, and netstatus object's events
LitePlayer_LiveRail_FDRV_VPAID
  
addJS(functionName:String, callback:Function):void
Adds an internal callback for external call from JavaScript
LitePlayer_LiveRail_FDRV_VPAID
  
Adds the stream object's event listeners
LitePlayer_LiveRail_FDRV_VPAID
  
addUI():void
Add any UI related object
LitePlayer_LiveRail_FDRV_VPAID
  
arrangeZIndex(event:Event = null):void
Arranges the z-index of the UI elements in the player
LitePlayer_LiveRail_FDRV_VPAID
  
callJS(functionName:String, ... parameters):void
Calling to the external function specified in "eventsFunc" flashvar supplied externally
LitePlayer_LiveRail_FDRV_VPAID
  
callJSWithLabel(functionName:String, label:String):void
The same as callJS but with a label parameter for additional info if needed
LitePlayer_LiveRail_FDRV_VPAID
  
Checks if a midroll time has been reached and initiates a one if it does.
LitePlayer_LiveRail_FDRV_VPAID
  
Checks if an overlay time has been reached and initiates a one if it does.
LitePlayer_LiveRail_FDRV_VPAID
  
Called if the connection for the current clip's video has failed
LitePlayer_LiveRail_FDRV_VPAID
  
called once the connection is successful and proceeds to the creation of the stream and attaching it to the video object.
LitePlayer_LiveRail_FDRV_VPAID
  
error(message:String, id:int):void
Removes the connection and the stream listeners.
LitePlayer_LiveRail_FDRV_VPAID
  
getVisual(assetClass:Class):Sprite
[static] Creates a Visual and interactive Sprite object from an embedded swf asset
LitePlayer_LiveRail_FDRV_VPAID
  
hideLoading(event:Event = null):void
Hides the loading animation
LitePlayer_LiveRail_FDRV_VPAID
  
initAd(adUnit:*):void
Calls to the external Widget's initAd method to initialize an ad through AdManager.js
LitePlayer_LiveRail_FDRV_VPAID
  
Loading/Resetting the essential for playback flashvars
LitePlayer_LiveRail_FDRV_VPAID
  
Legacy, if houseAdEnabled is set to "true", the initialization of the houseAd will occur.
LitePlayer_LiveRail_FDRV_VPAID
  
Loading and Resetting the JS communication related flashvars (legacy, refer to Elie if once they're completely removed from the widget)
LitePlayer_LiveRail_FDRV_VPAID
  
Called externally once an instream ad (played externally by the widget's admanager) has ended playing, in order to continue the playback flow or move to the next clip
LitePlayer_LiveRail_FDRV_VPAID
  
Called externally once an instream ad (played externally by the widget's admanager) has failed, in order to continue the playback flow or move to the next clip
LitePlayer_LiveRail_FDRV_VPAID
  
isMuted():Boolean
Checked whether the clip is currently muted.
LitePlayer_LiveRail_FDRV_VPAID
  
loadClip(... parameters):void
Loads a clip, called externally by the widget refer to the parameters on the loadClip call from the widget.
LitePlayer_LiveRail_FDRV_VPAID
  
mute():void
Mutes the clip, also called externally
LitePlayer_LiveRail_FDRV_VPAID
  
onAsyncError(event:AsyncErrorEvent):void
LitePlayer_LiveRail_FDRV_VPAID
  
onBuyButtonClick(event:MouseEvent):void
Called when the buy move button is clicked
LitePlayer_LiveRail_FDRV_VPAID
  
onEmbedLoadComplete(event:Event):void
LitePlayer_LiveRail_FDRV_VPAID
  
onInHouseAdClick(event:MouseEvent):void
Legacy, Called when a visible InHouseAd has been clicked
LitePlayer_LiveRail_FDRV_VPAID
  
onInHouseAdEnded(event:Event):void
Legacy, called when the inHouseAd has ended playing
LitePlayer_LiveRail_FDRV_VPAID
  
onIOError(event:IOErrorEvent):void
LitePlayer_LiveRail_FDRV_VPAID
  
onLogoClick(event:MouseEvent):void
Called when the anyclip logo is clicked
LitePlayer_LiveRail_FDRV_VPAID
  
onMuteButtonClick(event:MouseEvent):void
Called when the Mute button is clicked
LitePlayer_LiveRail_FDRV_VPAID
  
onNetStatus(event:NetStatusEvent):void
The intersection between playback events and events reporting, each net NetStatusEvent is recieved from the stream and the connection objects and contains information about the current state of each of them.
LitePlayer_LiveRail_FDRV_VPAID
  
onPlaybackTimer(event:TimerEvent):void
Once the playback timer interval reached, it checks for a possible midroll and overlay
LitePlayer_LiveRail_FDRV_VPAID
  
onRollOutAlphaChange(event:MouseEvent):void
LitePlayer_LiveRail_FDRV_VPAID
  
onRollOverAlphaChange(event:MouseEvent):void
LitePlayer_LiveRail_FDRV_VPAID
  
onSecurityError(event:SecurityErrorEvent):void
LitePlayer_LiveRail_FDRV_VPAID
  
onVideoOverlayClick(event:MouseEvent):void
Called when the video is clicked (A transparent clickable overlay object above the video, to be exact)
LitePlayer_LiveRail_FDRV_VPAID
  
pause():void
Pauses the stream, also can be called externally
LitePlayer_LiveRail_FDRV_VPAID
  
Removes the current connection's event in order to free some resources.
LitePlayer_LiveRail_FDRV_VPAID
  
Removes the stream object's event listeners in order to free some resources
LitePlayer_LiveRail_FDRV_VPAID
  
resizeVideo(width:Number, height:Number):void
Resizes the video object's dimensions and position while maintains the ratio
LitePlayer_LiveRail_FDRV_VPAID
  
resume():void
Resumes the stream, also can be called externally
LitePlayer_LiveRail_FDRV_VPAID
  
setStage(event:Event):void
Defining the player's alignment, scale, and connect it to a resizing and positioning "deamon" (updateView)
LitePlayer_LiveRail_FDRV_VPAID
  
showLoading(event:Event = null):void
Shows the loading animation
LitePlayer_LiveRail_FDRV_VPAID
  
Called once the video's stream has been closed
LitePlayer_LiveRail_FDRV_VPAID
  
Called if the video's stream has failed.
LitePlayer_LiveRail_FDRV_VPAID
  
Called if the video's stream isn't found
LitePlayer_LiveRail_FDRV_VPAID
  
Called when the video's stream has been paused
LitePlayer_LiveRail_FDRV_VPAID
  
Called if the video's stream has been rejected.
LitePlayer_LiveRail_FDRV_VPAID
  
Called once the video's stream has started playing
LitePlayer_LiveRail_FDRV_VPAID
  
Called once the video's stream stopped
LitePlayer_LiveRail_FDRV_VPAID
  
Called when the video's stream has been unpaused
LitePlayer_LiveRail_FDRV_VPAID
  
switchMuteButtonAsset(asset:Class):void
Changes the mute button UI to a required embedded swf Class
LitePlayer_LiveRail_FDRV_VPAID
  
traceConsole(str:String, type:String = log):void
Log to the browser's console.
LitePlayer_LiveRail_FDRV_VPAID
  
unMute():void
UnMutes the clip, also called externally
LitePlayer_LiveRail_FDRV_VPAID
  
updateView(event:Event = null, force:Boolean = false):void
Updates the player's objects positioning and sizing, called upon each frame change, child add and whenever needed
LitePlayer_LiveRail_FDRV_VPAID
  
videoEnded():void
Called once the video playback is completed
LitePlayer_LiveRail_FDRV_VPAID
Protected Constants
 ConstantDefined By
  CLIP_ENDED : String = clipEnded
[static]
LitePlayer_LiveRail_FDRV_VPAID
  CLIP_FAILED : String = clipFailed
[static]
LitePlayer_LiveRail_FDRV_VPAID
  CLIP_READY : String = clipReady
[static]
LitePlayer_LiveRail_FDRV_VPAID
  CLIP_STARTED : String = clipStarted
[static]
LitePlayer_LiveRail_FDRV_VPAID
  FULL_MOVIE_CLICK : String = fullMovieClick
[static]
LitePlayer_LiveRail_FDRV_VPAID
  IN_HOUSE_AD_CLICK : String = inHouseAdClick
[static]
LitePlayer_LiveRail_FDRV_VPAID
  IN_HOUSE_AD_ENDED : String = inHouseAdEnded
[static]
LitePlayer_LiveRail_FDRV_VPAID
  IN_HOUSE_AD_STARTED : String = inHouseAdStarted
[static]
LitePlayer_LiveRail_FDRV_VPAID
  INSTREAM_AD_ENDED : String = instreamAdEnded
[static]
LitePlayer_LiveRail_FDRV_VPAID
  INSTREAM_AD_FAILED : String = instreamAdFailed
[static]
LitePlayer_LiveRail_FDRV_VPAID
  LOAD_CLIP : String = loadClip
[static]
LitePlayer_LiveRail_FDRV_VPAID
  LOGO_CLICK : String = logoClick
[static]
LitePlayer_LiveRail_FDRV_VPAID
  MIDROLL : String = in
[static]
LitePlayer_LiveRail_FDRV_VPAID
  MUTE : String = mute
[static]
LitePlayer_LiveRail_FDRV_VPAID
  MUTE_CLICK : String = muteClick
[static]
LitePlayer_LiveRail_FDRV_VPAID
  OVERLAY : String = ov
[static]
LitePlayer_LiveRail_FDRV_VPAID
  PAUSE : String = pause
[static]
LitePlayer_LiveRail_FDRV_VPAID
  PLAYER_LOADED : String = playerLoaded
[static]
LitePlayer_LiveRail_FDRV_VPAID
  PLAYER_LOAD_STARTED : String = playerLoadStarted
[static]
LitePlayer_LiveRail_FDRV_VPAID
  POSTROLL : String = in
[static]
LitePlayer_LiveRail_FDRV_VPAID
  PRE_INIT : String = preInit
[static]
LitePlayer_LiveRail_FDRV_VPAID
  PREROLL : String = in
[static]
LitePlayer_LiveRail_FDRV_VPAID
  READY_TO_NEXT_CLIP : String = readyToNextClip
[static]
LitePlayer_LiveRail_FDRV_VPAID
  RESUME : String = resume
[static]
LitePlayer_LiveRail_FDRV_VPAID
  STREAM_LOADING : String = streamLoading
[static]
LitePlayer_LiveRail_FDRV_VPAID
  UNMUTE : String = unmute
[static]
LitePlayer_LiveRail_FDRV_VPAID
  UNMUTE_CLICK : String = unmuteClick
[static]
LitePlayer_LiveRail_FDRV_VPAID
  VIDEO_CLICK : String = videoClick
[static]
LitePlayer_LiveRail_FDRV_VPAID
Property Detail
_assetproperty
protected var _asset:MovieClip
_clipPageUrlproperty 
protected var _clipPageUrl:String
_volumeproperty 
protected var _volume:Number = 1

local volume value (for reference only)

adproperty 
protected var ad:*

Legacy, the inhouse ad object.

buyLinkImageproperty 
protected var buyLinkImage:Sprite
clipDurationproperty 
protected var clipDuration:Number

The video clip's duration returned in getDuration() when called from the Widget, can also be retrieved from the videoMetadata object

clipEndedproperty 
protected var clipEnded:Boolean

A flag used to determine the next step (resume/next clip) after a failure or completion of external ad

clipPageUrlproperty 
clipPageUrl:String

A getter for the clipPageUrl value


Implementation 
    protected function get clipPageUrl():String
    protected function set clipPageUrl(value:String):void
clipStartedEventDispatchedproperty 
protected var clipStartedEventDispatched:Boolean

Used as a flag to make sure the clipStarted event isn't reported twice per clip

connectionproperty 
protected var connection:NetConnection

The video's server connection object

connectionHasEventListenersproperty 
protected var connectionHasEventListeners:Boolean

A flag used to determine whether the connection object has event listeners (in order to clear them between clips if the video's host is different)

currentHeightproperty 
protected var currentHeight:Number

^the same, for width

currentWidthproperty 
protected var currentWidth:Number

used to identify a change in external dimensions in order to prevent repetitive calls in updateDisplay() method.

eventsFuncproperty 
protected var eventsFunc:String

^ditto

firstClipproperty 
protected var firstClip:Boolean = true

A flag for deciding if to request a preroll from the Widget, depends on whether the current clip is the first to be played since the player loaded or not. In principle, the Widget is responsible of playing the first preroll before the player has been loaded

firstPlayproperty 
protected var firstPlay:Boolean = true

A flag for deciding if it is the first time that the current clip is played? resets to "true" for each loaded clip. used to decide whether to report if the clip is ready for playback or has actually started playing (on streamStarted() method)

houseAdEnabledproperty 
protected var houseAdEnabled:Boolean = false

Legacy, determines whether the inhouse ad should be initialized and played

inHouseAdproperty 
protected var inHouseAd:DisplayObject

Legacy, the inhouse ad object container.

lastNetStatusCodeproperty 
protected var lastNetStatusCode:String

Determines the last recieved netstatus code and checked in onNetStatus() in order to prevent "false positives" (i.e. double "Play" event which might occur and mess the reports)

loadingAnimationproperty 
protected var loadingAnimation:Sprite
logoproperty 
protected var logo:Sprite
midrollsproperty 
protected var midrolls:Array

Legacy, the midrolls cue points (in seconds) array

muteButtonproperty 
protected var muteButton:Sprite
mutedproperty 
protected var muted:Boolean

Current state of muting, returned through isMuted() when called from the Widget.

muteOnLoadproperty 
protected var muteOnLoad:Boolean

determines whether the player should start in muted mode, defaulted to "true" on initFlashVars() if not specified

overlayRequestedproperty 
protected var overlayRequested:Boolean = false

Overlay request flag, prevents concurrent requests for overlay

placementIdproperty 
protected var placementId:String

^ditto

playbackTimerproperty 
protected var playbackTimer:Timer

A timer sampling the current position of the clip playback, used to determine when to request overlays and midrolls (Legacy, currently)

playerIdproperty 
protected var playerId:String

legacy, but might be still used in some parts of the widget. originally used in callJS() to identify which player made the call to the widget (in case of many widgets).

ratioproperty 
protected var ratio:Number = 1

the video ratio, updated once the video metadata is recieved by making a division of the video file's original width and height.

showLogoproperty 
protected var showLogo:Boolean

determines whether the player should contain anyclip's logo

sprintLabelproperty 
protected var sprintLabel:String = Jaws

The Right-Click Context menu sprint label value

sprintVersionproperty 
protected var sprintVersion:String = 0.1.0

The Right-Click Context menu sprint version value

streamproperty 
protected var stream:NetStream

The video's stream object

streamFileproperty 
protected var streamFile:String

the file name including extension

streamHostproperty 
protected var streamHost:String

the video file's url including folder and subfolder

streamProtocolproperty 
protected var streamProtocol:String

the video file url's protocol."rtmp"/"http"

timeproperty 
protected var time:Number

Current clip playback position, used to determine whether the actual video time has changed before checking for overlays and midrolls

updateViewActiveproperty 
protected var updateViewActive:Boolean

used to prevent simultanious calls to updateView() method.

videoproperty 
protected var video:Video

The video display object

videoMetadataproperty 
protected var videoMetadata:Object

A data object from the loaded video file

videoOverlayproperty 
protected var videoOverlay:DisplayObject

Clickable transparent video overlay, for the VIDEO_CLICK event reporting

volumeproperty 
volume:Number  [write-only]

Sets the volume for the stream, used internally only


Implementation 
    protected function set volume(value:Number):void
Constructor Detail
LitePlayer_LiveRail_FDRV_VPAID()Constructor
public function LitePlayer_LiveRail_FDRV_VPAID()

Constructor

Method Detail
addChild()method
override public function addChild(child:DisplayObject):DisplayObject

Overriden the default addChild method in order to force a call to udpateVide();

Parameters

child:DisplayObject
Returns
DisplayObject
addConnectionListeners()method 
protected function addConnectionListeners():void

Add the connection's event listeners for security, IO, and netstatus object's events

addJS()method 
protected function addJS(functionName:String, callback:Function):void

Adds an internal callback for external call from JavaScript

Parameters

functionName:String — - the name of the function called from JavaScript
 
callback:Function — - the function instance to connect to the functionName

See also

callJS
addStreamListeners()method 
protected function addStreamListeners():void

Adds the stream object's event listeners

addUI()method 
protected function addUI():void

Add any UI related object

arrangeZIndex()method 
protected function arrangeZIndex(event:Event = null):void

Arranges the z-index of the UI elements in the player

Parameters

event:Event (default = null)
callJS()method 
protected function callJS(functionName:String, ... parameters):void

Calling to the external function specified in "eventsFunc" flashvar supplied externally

Parameters

functionName:String — - the function name of the actual function you're calling in the widget ...parameters are unlimited and sent in the "parameters" object below
 
... parameters
callJSWithLabel()method 
protected function callJSWithLabel(functionName:String, label:String):void

The same as callJS but with a label parameter for additional info if needed

Parameters

functionName:String — - the function name of the actual function you're calling in the widget
 
label:String — - a custom label to send to the required function
checkMidroll()method 
protected function checkMidroll():void

Checks if a midroll time has been reached and initiates a one if it does. currently turned off (legacy), check the code comments to activate it again.

checkOverlay()method 
protected function checkOverlay():void

Checks if an overlay time has been reached and initiates a one if it does. currently turned off (legacy), check the code comments to activate it again.

connectionFailed()method 
protected function connectionFailed():void

Called if the connection for the current clip's video has failed

connectionSuccess()method 
protected function connectionSuccess():void

called once the connection is successful and proceeds to the creation of the stream and attaching it to the video object.

See also

loadClip
error()method 
protected function error(message:String, id:int):void

Removes the connection and the stream listeners. might be a good place to send the error over to statistics if needed

Parameters

message:String
 
id:int
getVisual()method 
protected static function getVisual(assetClass:Class):Sprite

Creates a Visual and interactive Sprite object from an embedded swf asset

Parameters

assetClass:Class — - The embedded class to create a Sprite from.
Returns
Sprite
hideLoading()method 
protected function hideLoading(event:Event = null):void

Hides the loading animation

Parameters

event:Event (default = null)
initAd()method 
protected function initAd(adUnit:*):void

Calls to the external Widget's initAd method to initialize an ad through AdManager.js

Parameters

adUnit:* — - which type of ad to initialize ("ov" for overlay or "in" for instream ad)
initFlashVars()method 
protected function initFlashVars():void

Loading/Resetting the essential for playback flashvars

initInHouseAd()method 
protected function initInHouseAd():void

Legacy, if houseAdEnabled is set to "true", the initialization of the houseAd will occur.

initJSFlashVars()method 
protected function initJSFlashVars():void

Loading and Resetting the JS communication related flashvars (legacy, refer to Elie if once they're completely removed from the widget)

See also

callJS
instreamAdEnded()method 
protected function instreamAdEnded():void

Called externally once an instream ad (played externally by the widget's admanager) has ended playing, in order to continue the playback flow or move to the next clip

instreamAdFailed()method 
protected function instreamAdFailed():void

Called externally once an instream ad (played externally by the widget's admanager) has failed, in order to continue the playback flow or move to the next clip

isMuted()method 
protected function isMuted():Boolean

Checked whether the clip is currently muted. called externally

Returns
Boolean
loadClip()method 
protected function loadClip(... parameters):void

Loads a clip, called externally by the widget refer to the parameters on the loadClip call from the widget.

Parameters

... parameters
mute()method 
protected function mute():void

Mutes the clip, also called externally

onAsyncError()method 
protected function onAsyncError(event:AsyncErrorEvent):void

Parameters

event:AsyncErrorEvent
onBuyButtonClick()method 
protected function onBuyButtonClick(event:MouseEvent):void

Called when the buy move button is clicked

Parameters

event:MouseEvent
onBWDone()method 
public function onBWDone(... parameters):void

DO NOT REMOVE! Required by the connection and the stream (since their client propery is set to "this") in order to prevent an error

Parameters

... parameters
onEmbedLoadComplete()method 
protected function onEmbedLoadComplete(event:Event):void

Parameters

event:Event
onInHouseAdClick()method 
protected function onInHouseAdClick(event:MouseEvent):void

Legacy, Called when a visible InHouseAd has been clicked

Parameters

event:MouseEvent
onInHouseAdEnded()method 
protected function onInHouseAdEnded(event:Event):void

Legacy, called when the inHouseAd has ended playing

Parameters

event:Event
onIOError()method 
protected function onIOError(event:IOErrorEvent):void

Parameters

event:IOErrorEvent
onLogoClick()method 
protected function onLogoClick(event:MouseEvent):void

Called when the anyclip logo is clicked

Parameters

event:MouseEvent
onMetaData()method 
public function onMetaData(metadata:Object):void

DO NOT REMOVE! Required by the connection and the stream (since their client propery is set to "this") Called by the connection and the stream once the video file's stream has been connected and the video metadata has been loaded

Parameters

metadata:Object — - raw metadata of the video
onMuteButtonClick()method 
protected function onMuteButtonClick(event:MouseEvent):void

Called when the Mute button is clicked

Parameters

event:MouseEvent
onNetStatus()method 
protected function onNetStatus(event:NetStatusEvent):void

The intersection between playback events and events reporting, each net NetStatusEvent is recieved from the stream and the connection objects and contains information about the current state of each of them. then and responds accordingly with a method. Called automatically by event listeners.

Parameters

event:NetStatusEvent

See also

addStreamListeners
addConnectionListeners
onPlaybackTimer()method 
protected function onPlaybackTimer(event:TimerEvent):void

Once the playback timer interval reached, it checks for a possible midroll and overlay

Parameters

event:TimerEvent

See also

playbackTimer
onPlayStatus()method 
public function onPlayStatus(info:Object):void

Used to determine the absolute real end of the video playback.

Parameters

info:Object
onRollOutAlphaChange()method 
protected function onRollOutAlphaChange(event:MouseEvent):void

Parameters

event:MouseEvent
onRollOverAlphaChange()method 
protected function onRollOverAlphaChange(event:MouseEvent):void

Parameters

event:MouseEvent
onSecurityError()method 
protected function onSecurityError(event:SecurityErrorEvent):void

Parameters

event:SecurityErrorEvent
onVideoOverlayClick()method 
protected function onVideoOverlayClick(event:MouseEvent):void

Called when the video is clicked (A transparent clickable overlay object above the video, to be exact)

Parameters

event:MouseEvent
pause()method 
protected function pause():void

Pauses the stream, also can be called externally

removeConnectionListeners()method 
protected function removeConnectionListeners():void

Removes the current connection's event in order to free some resources.

removeStreamListeners()method 
protected function removeStreamListeners():void

Removes the stream object's event listeners in order to free some resources

resizeVideo()method 
protected function resizeVideo(width:Number, height:Number):void

Resizes the video object's dimensions and position while maintains the ratio

Parameters

width:Number — - the requiered width for the video in pixels
 
height:Number — - the requiered height for the video in pixels
resume()method 
protected function resume():void

Resumes the stream, also can be called externally

setStage()method 
protected function setStage(event:Event):void

Defining the player's alignment, scale, and connect it to a resizing and positioning "deamon" (updateView)

Parameters

event:Event
showLoading()method 
protected function showLoading(event:Event = null):void

Shows the loading animation

Parameters

event:Event (default = null)
streamClosed()method 
protected function streamClosed():void

Called once the video's stream has been closed

streamFailed()method 
protected function streamFailed():void

Called if the video's stream has failed.

streamNotFound()method 
protected function streamNotFound():void

Called if the video's stream isn't found

streamPaused()method 
protected function streamPaused():void

Called when the video's stream has been paused

streamRejected()method 
protected function streamRejected():void

Called if the video's stream has been rejected.

streamStarted()method 
protected function streamStarted():void

Called once the video's stream has started playing

streamStopped()method 
protected function streamStopped():void

Called once the video's stream stopped

streamUnpaused()method 
protected function streamUnpaused():void

Called when the video's stream has been unpaused

switchMuteButtonAsset()method 
protected function switchMuteButtonAsset(asset:Class):void

Changes the mute button UI to a required embedded swf Class

Parameters

asset:Class — - the required embedded swf Class
traceConsole()method 
protected function traceConsole(str:String, type:String = log):void

Log to the browser's console.

Parameters

str:String — - A string for the log
 
type:String (default = log) — - the type of the "log" can be set to "debug", "info" etc..
unMute()method 
protected function unMute():void

UnMutes the clip, also called externally

unpackEmbed()method 
public function unpackEmbed(assetClass:Class):void

Legacy, used for the inHouseAd embedded class - Initiates an an embedded swf unpacking to a fully working local swf with communication abilities

Parameters

assetClass:Class — - the inHouseAd Embedded asset Class
updateView()method 
protected function updateView(event:Event = null, force:Boolean = false):void

Updates the player's objects positioning and sizing, called upon each frame change, child add and whenever needed

Parameters

event:Event (default = null) — - specified in order to work with the event listener of ADDED_TO_Stage
 
force:Boolean (default = false) — - set to true in order to force positioning and resizing

See also

MinimalPlayer
videoEnded()method 
protected function videoEnded():void

Called once the video playback is completed

Constant Detail
CLIP_ENDEDConstant
protected static const CLIP_ENDED:String = clipEnded
CLIP_FAILEDConstant 
protected static const CLIP_FAILED:String = clipFailed
CLIP_READYConstant 
protected static const CLIP_READY:String = clipReady
CLIP_STARTEDConstant 
protected static const CLIP_STARTED:String = clipStarted
FULL_MOVIE_CLICKConstant 
protected static const FULL_MOVIE_CLICK:String = fullMovieClick
IN_HOUSE_AD_CLICKConstant 
protected static const IN_HOUSE_AD_CLICK:String = inHouseAdClick
IN_HOUSE_AD_ENDEDConstant 
protected static const IN_HOUSE_AD_ENDED:String = inHouseAdEnded
IN_HOUSE_AD_STARTEDConstant 
protected static const IN_HOUSE_AD_STARTED:String = inHouseAdStarted
INSTREAM_AD_ENDEDConstant 
protected static const INSTREAM_AD_ENDED:String = instreamAdEnded
INSTREAM_AD_FAILEDConstant 
protected static const INSTREAM_AD_FAILED:String = instreamAdFailed
LOAD_CLIPConstant 
protected static const LOAD_CLIP:String = loadClip
LOGO_CLICKConstant 
protected static const LOGO_CLICK:String = logoClick
MIDROLLConstant 
protected static const MIDROLL:String = in
MUTEConstant 
protected static const MUTE:String = mute
MUTE_CLICKConstant 
protected static const MUTE_CLICK:String = muteClick
OVERLAYConstant 
protected static const OVERLAY:String = ov
PAUSEConstant 
protected static const PAUSE:String = pause
PLAYER_LOAD_STARTEDConstant 
protected static const PLAYER_LOAD_STARTED:String = playerLoadStarted
PLAYER_LOADEDConstant 
protected static const PLAYER_LOADED:String = playerLoaded
POSTROLLConstant 
protected static const POSTROLL:String = in
PRE_INITConstant 
protected static const PRE_INIT:String = preInit
PREROLLConstant 
protected static const PREROLL:String = in
READY_TO_NEXT_CLIPConstant 
protected static const READY_TO_NEXT_CLIP:String = readyToNextClip
RESUMEConstant 
protected static const RESUME:String = resume
STREAM_LOADINGConstant 
protected static const STREAM_LOADING:String = streamLoading
UNMUTEConstant 
protected static const UNMUTE:String = unmute
UNMUTE_CLICKConstant 
protected static const UNMUTE_CLICK:String = unmuteClick
VIDEO_CLICKConstant 
protected static const VIDEO_CLICK:String = videoClick





Thu Mar 12 2015, 08:45 PM +02:00
Comments