Packageimpression.events
Classpublic class VideoStatusEvent
InheritanceVideoStatusEvent Inheritance StoryboardEvent Inheritance flash.events.Event

The SWFVideoPlayer dispatches a VideoStatusEvent object when a status change occurs.



Public Properties
 PropertyDefined By
  currentStep : int
[read-only] The current step displayed by the player.
VideoStatusEvent
  previousStep : int
[read-only] The previous step displayed by the player.
VideoStatusEvent
 Inheritedsb : Storyboard
[read-only] The Storyboard object assigned to the target.
StoryboardEvent
  status : String
[read-only] The status of the player.
VideoStatusEvent
  totalSteps : int
[read-only] The total number of steps in the video.
VideoStatusEvent
Public Methods
 MethodDefined By
  
VideoStatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, sb:Storyboard = null, previousStep:int = -1, currentStep:int = -1, totalSteps:int = -1, status:String = null)
Creates a new instance of a VideoStatusEvent object.
VideoStatusEvent
  
clone():Event
[override] Duplicates an instance of the event object.
VideoStatusEvent
  
toString():String
[override] Returns a string containing all the properties of the VideoStatusEvent object.
VideoStatusEvent
Public Constants
 ConstantDefined By
 InheritedCOMPLETE : String = complete
[static] The StoryboardEvent.COMPLETE constant defines the value of the type property of a complete event object.
StoryboardEvent
 InheritedCONTENT_LOAD_BEGIN : String = contentLoadBegin
[static] The StoryboardEvent.CONTENT_LOAD_BEGIN constant defines the value of the type property of a content load begin event object.
StoryboardEvent
 InheritedCONTENT_LOAD_END : String = contentLoadEnd
[static] The StoryboardEvent.CONTENT_LOAD_END constant defines the value of the type property of a content load end event object.
StoryboardEvent
 InheritedINITIALIZE : String = initialize
[static] The StoryboardEvent.INITIALIZE constant defines the value of the type property of a initialize event object.
StoryboardEvent
 InheritedLOAD_COMPLETE : String = loadComplete
[static] The StoryboardEvent.LOAD_COMPLETE constant defines the value of the type property of a load event object.
StoryboardEvent
 InheritedLOAD_START : String = loadStart
[static] The StoryboardEvent.LOAD_START constant defines the value of the type property of an load start event object.
StoryboardEvent
  STATUS_CHANGE : String = videoStatusChange
[static] The VideoStatusEvent.STATUS_CHANGE constant defines the value of the type property of a status change event object.
VideoStatusEvent
 InheritedUNLOAD : String = unload
[static] The StoryboardEvent.UNLOAD constant defines the value of the type property of an unload event object.
StoryboardEvent
Property Detail
currentStepproperty
currentStep:int  [read-only]

The current step displayed by the player.


Implementation
    public function get currentStep():int
previousStepproperty 
previousStep:int  [read-only]

The previous step displayed by the player.


Implementation
    public function get previousStep():int
statusproperty 
status:String  [read-only]

The status of the player. When dispatched by the SWFVideoPlayer, this value will be one of the VideoPlayerStatusTypes constant values.


Implementation
    public function get status():String

See also

totalStepsproperty 
totalSteps:int  [read-only]

The total number of steps in the video.


Implementation
    public function get totalSteps():int
Constructor Detail
VideoStatusEvent()Constructor
public function VideoStatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, sb:Storyboard = null, previousStep:int = -1, currentStep:int = -1, totalSteps:int = -1, status:String = null)

Creates a new instance of a VideoStatusEvent object.

Parameters
type:String — The type of the event. Event listeners can access this information through the inherited type property.
 
bubbles:Boolean (default = false) — Determines whether the event object participates in the bubbling phase of the event flow. Event listeners can access this information through the inheritied bubbles property.
 
cancelable:Boolean (default = false) — Determines whether the event object can be canceled. Event listeners can access this information through the inherited cancelable property.
 
sb:Storyboard (default = null) — The Storyboard object assigned to the target. Event listeners can access this information through the inherited sb property.
 
previousStep:int (default = -1) — The previous step displayed by the player. Event listeners can access this information through the previousStep property.
 
currentStep:int (default = -1) — The current step displayed by the player. Event listeners can access this information through the currentStep property.
 
totalSteps:int (default = -1) — The total number of steps in the video. Event listeners can access this information through the totalSteps property.
 
status:String (default = null) — The status of the player. Event listeners can access this information through the status property.
Method Detail
clone()method
override public function clone():Event

Duplicates an instance of the event object.

Returns a new VideoStatusEvent object that is a copy of the original instance of the VideoStatusEvent object. You do not normally call clone(); the EventDispatcher class calls it automatically when you redispatch an event--that is, when you call dispatchEvent(event) from a handler that is handling event.

Returns
Event — A new VideoStatusEvent object that is identical to the original.
toString()method 
override public function toString():String

Returns a string containing all the properties of the VideoStatusEvent object. The string is in the following format:

[VideoStatusEvent type=value bubbles=value cancelable=value eventPhase=value sb=value previousStep=value currentStep=value totalSteps=value status=value]

Returns
String — A string containing all the properties of the VideoStatusEvent object.
Constant Detail
STATUS_CHANGEConstant
public static const STATUS_CHANGE:String = videoStatusChange

The VideoStatusEvent.STATUS_CHANGE constant defines the value of the type property of a status change event object. This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object that raised the event.
sbThe Storyboard object assigned to the target.
previousStepThe previous step displayed by the player.
currentStepThe current step displayed by the player.
totalStepsThe total number of steps in the video.
statusThe status of the player.