ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
org.osmf.events 

PlayEvent  - AS3 OSMF
Packageorg.osmf.events
Classpublic class PlayEvent
InheritancePlayEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

A PlayEvent is dispatched when the properties of a PlayTrait change.


Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
  canPause : Boolean
[read-only] New canPause state of the PlayTrait.
PlayEvent
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  playState : String
[read-only] New PlayState of the PlayTrait.
PlayEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
PlayEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, playState:String = null, canPause:Boolean = false)
Constructor.
PlayEvent
 Inherited
clone():Event
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  CAN_PAUSE_CHANGE : String = "canPauseChange"
[static] The PlayEvent.CAN_PAUSE_CHANGE constant defines the value of the type property of the event object for a canPauseChange event.
PlayEvent
  LIVE_RESUME : String = "liveResume"
[static] The PlayEvent.LIVE_RESUME constant defines the value of the type property of the event object for a liveResume event. Dispatched when playback resumes after a live stall
PlayEvent
  LIVE_STALL : String = "liveStall"
[static] The PlayEvent.LIVE_STALL constant defines the value of the type property of the event object for a liveStall event. Dispatched when playback runs out of content for a live stream but the stream is not done.
PlayEvent
  PLAY_STATE_CHANGE : String = "playStateChange"
[static] The PlayEvent.PLAY_STATE_CHANGE constant defines the value of the type property of the event object for a playStateChange event.
PlayEvent
Property Detail

canPause

property
canPause:Boolean  [read-only]

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

New canPause state of the PlayTrait.



Implementation
    public function get canPause():Boolean

playState

property 
playState:String  [read-only]

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

New PlayState of the PlayTrait.



Implementation
    public function get playState():String
Constructor Detail

PlayEvent

()Constructor
public function PlayEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, playState:String = null, canPause:Boolean = false)

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

Constructor.

Parameters
type:String — Event type.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Specifies whether the behavior associated with the event can be prevented.
 
playState:String (default = null) — New PlayState of the PlayTrait.
 
canPause:Boolean (default = false) — New value of bytesLoaded or bytesTotal.
Constant Detail

CAN_PAUSE_CHANGE

Constant
public static const CAN_PAUSE_CHANGE:String = "canPauseChange"

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

The PlayEvent.CAN_PAUSE_CHANGE constant defines the value of the type property of the event object for a canPauseChange event.

LIVE_RESUME

Constant 
public static const LIVE_RESUME:String = "liveResume"

Language Version: ActionScript 3.0
Product Version: OSMF 2.0
Runtime Versions: Flash Player 10, AIR 1.5

The PlayEvent.LIVE_RESUME constant defines the value of the type property of the event object for a liveResume event.

Dispatched when playback resumes after a live stall

LIVE_STALL

Constant 
public static const LIVE_STALL:String = "liveStall"

Language Version: ActionScript 3.0
Product Version: OSMF 2.0
Runtime Versions: Flash Player 10, AIR 1.5

The PlayEvent.LIVE_STALL constant defines the value of the type property of the event object for a liveStall event.

Dispatched when playback runs out of content for a live stream but the stream is not done.

PLAY_STATE_CHANGE

Constant 
public static const PLAY_STATE_CHANGE:String = "playStateChange"

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

The PlayEvent.PLAY_STATE_CHANGE constant defines the value of the type property of the event object for a playStateChange event.




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy