PlayTrait

(Beta)

Package	org.osmf.traits
Class	public class PlayTrait
Inheritance	PlayTrait MediaTraitBase EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

PlayTrait defines the trait interface for media whose playback can be started and stopped. It can be used as the base class for a more specific PlayTrait subclass.

Use the MediaElement.hasTrait(MediaTraitType.PLAY) method to query whether a media element has a trait of this type. If hasTrait(MediaTraitType.PLAY) returns true, use the MediaElement.getTrait(MediaTraitType.PLAY) method to get an object of this type.

Related API Elements

org.osmf.media.MediaElement

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		canPause : Boolean [read-only] Indicates whether the media can be paused.	PlayTrait
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		playState : String [read-only] The current playback state, of type PlayState.	PlayTrait
		traitType : String [read-only] The MediaTraitType for this trait.	MediaTraitBase

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		PlayTrait() Constructor.	PlayTrait
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		dispose():void Disposes of any resources used by this trait.	MediaTraitBase
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		pause():void Pauses the media if it is not already paused.	PlayTrait
		play():void Plays the media if it is not already playing.	PlayTrait
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stop():void Stops the media if it is not already stopped.	PlayTrait
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Protected Methods

	Method		Defined By
		playStateChangeEnd():void Called just after the playState property value has changed.	PlayTrait
		playStateChangeStart(newPlayState:String):void Called immediately before the playState property value is changed.	PlayTrait
		setCanPause(value:Boolean):void Sets the canPause property for this PlayTrait.	PlayTrait

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
canPauseChange	Dispatched when the canPause property has changed.	PlayTrait
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
liveResume	Dispatched when playback resumes after a live stall	PlayTrait
liveStall	Dispatched when playback runs out of content for a live stream but the stream is not done.	PlayTrait
playStateChange	Dispatched when the playState of the PlayTrait has changed.	PlayTrait

Property Detail

Constructor Detail

()

Constructor

public function PlayTrait()

Constructor.

Method Detail

Event Detail

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

PlayTrait - AS3 OSMF

Packagesx

Language Elements

Appendixes

Package org.osmf.traits

canPause

playState

PlayTrait

pause

play

playStateChangeEnd

playStateChangeStart

setCanPause

stop

canPauseChange

liveResume

liveStall

playStateChange