Packagecv.events
Classpublic class PlayProgressEvent
InheritancePlayProgressEvent Inheritance flash.events.Event

The PlayProgressEvent class defines events for media players. These events include the following:



Public Properties
 PropertyDefined by
  elapsed : Number
The reference to the elapsed time of the media playing.
PlayProgressEvent
  percent : uint
The reference to the percentage of progress for the media playing.
PlayProgressEvent
  remain : Number
The reference to the remaining time of the media playing.
PlayProgressEvent
  total : Number
The reference to the total time of the media playing.
PlayProgressEvent
Public Methods
 MethodDefined by
  
PlayProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, percent:uint = 0, elapsed:Number = 0, remain:Number = 0, total:Number = 0)
Creates a new PlayProgressEvent object with the specified parameters.
PlayProgressEvent
  
clone():Event
Creates a copy of the PlayProgressEvent object and sets the value of each parameter to match the original.
PlayProgressEvent
  
toString():String
Returns a string that contains all the properties of the PlayProgressEvent object.
PlayProgressEvent
Public Constants
 ConstantDefined by
  LOADED : String = "loaded"
[static]
PlayProgressEvent
  LOADING : String = "loading"
[static]
PlayProgressEvent
  PLAY_COMPLETE : String = "playComplete"
[static]
PlayProgressEvent
  PLAY_PROGRESS : String = "playProgress"
[static] Defines the value of the type property of an playProgress event object.
PlayProgressEvent
  PLAY_START : String = "playStart"
[static]
PlayProgressEvent
  STARTED : String = "started"
[static]
PlayProgressEvent
  STATUS : String = "status"
[static]
PlayProgressEvent
  UNLOADED : String = "unloaded"
[static]
PlayProgressEvent
Property detail
elapsedproperty
public var elapsed:Number

The reference to the elapsed time of the media playing.

percentproperty 
public var percent:uint

The reference to the percentage of progress for the media playing.

remainproperty 
public var remain:Number

The reference to the remaining time of the media playing.

totalproperty 
public var total:Number

The reference to the total time of the media playing.

Constructor detail
PlayProgressEvent()constructor
public function PlayProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, percent:uint = 0, elapsed:Number = 0, remain:Number = 0, total:Number = 0)

Creates a new PlayProgressEvent object with the specified parameters.

Parameters
type:String — The event type; this value identifies the action that caused the event.
 
bubbles:Boolean (default = false) — Indicates whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Indicates whether the behavior associated with the event can be prevented.
 
percent:uint (default = 0) — The play progress in terms of percent.
 
elapsed:Number (default = 0) — The time elapsed in terms of milliseconds.
 
remain:Number (default = 0) — The time remaining in terms of milliseconds.
 
total:Number (default = 0) — The total time in terms of milliseconds.
Method detail
clone()method
public override function clone():Event

Creates a copy of the PlayProgressEvent object and sets the value of each parameter to match the original.

Returns
Event — A new PlayProgressEvent object with parameter values that match those of the original.
toString()method 
public override function toString():String

Returns a string that contains all the properties of the PlayProgressEvent object. The string is in the following format:

[PlayProgressEvent type=value bubbles=value cancelable=value percent=value elapsed=value remain=value total=value]

Returns
String — A string representation of the PlayProgressEvent object.
Constant detail
LOADEDconstant
public static const LOADED:String = "loaded"
LOADINGconstant 
public static const LOADING:String = "loading"
PLAY_COMPLETEconstant 
public static const PLAY_COMPLETE:String = "playComplete"
PLAY_PROGRESSconstant 
public static const PLAY_PROGRESS:String = "playProgress"

Defines the value of the type property of an playProgress event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
percentThe percentage of progress for the media playing.
elapsedThe elapsed time of the media playing.
remainThe remaining time of the media playing.
totalThe total time of the media playing.
currentTargetThe object that is actively processing the event object with an event listener.
targetThe object that dispatched the event. The target is not always the object listening for the event. Use the currentTarget property to access the object that is listening for the event.
PLAY_STARTconstant 
public static const PLAY_START:String = "playStart"
STARTEDconstant 
public static const STARTED:String = "started"
STATUSconstant 
public static const STATUS:String = "status"
UNLOADEDconstant 
public static const UNLOADED:String = "unloaded"