MediaPlayer

Package	org.osmf.media
Class	public class MediaPlayer
Inheritance	MediaPlayer TraitEventDispatcher EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

MediaPlayer is the controller class used for interaction with all media types.

It is a high level class that shields the developer from the low level details of the media framework. The MediaPlayer class also provides some convenient features such as loop, auto-play and auto-rewind.

The MediaPlayer can play back all media types supported by the Open Source Media Framework, including media compositions.

View the examples

Public Properties

	Property		Defined By
		alternativeAudioStreamSwitching : Boolean [read-only] Indicates whether or not an alternative audio stream switch is currently in progress.	MediaPlayer
		audioPan : Number Pan property of the media.	MediaPlayer
		autoDynamicStreamSwitch : Boolean Indicates whether or not the media will automatically switch between dynamic streams.	MediaPlayer
		autoPlay : Boolean Indicates whether the MediaPlayer starts playing the media as soon as its load operation has successfully completed.	MediaPlayer
		autoRewind : Boolean Indicates whether media is returned to the beginning after playback completes.	MediaPlayer
		buffering : Boolean [read-only] Indicates whether the media is currently buffering.	MediaPlayer
		bufferLength : Number [read-only] Length of the content currently in the media's buffer, in seconds.	MediaPlayer
		bufferTime : Number Desired length of the media's buffer, in seconds.	MediaPlayer
		bytesLoaded : Number [read-only] The number of bytes of the media that have been loaded.	MediaPlayer
		bytesLoadedUpdateInterval : Number Interval between the dispatch of change events for the bytesLoaded property.	MediaPlayer
		bytesTotal : Number [read-only] The total number of bytes of the media that will be loaded.	MediaPlayer
		canBuffer : Boolean [read-only] Indicates whether the media can buffer.	MediaPlayer
		canLoad : Boolean [read-only] Indicates whether the media can be loaded.	MediaPlayer
		canPause : Boolean [read-only] Indicates whether the media can be paused.	MediaPlayer
		canPlay : Boolean [read-only] Indicates whether the media can be played.	MediaPlayer
		canSeek : Boolean [read-only] Indicates whether the media is seekable.	MediaPlayer
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentAlternativeAudioStreamIndex : int [read-only] The index of the alternative audio stream currently in use.	MediaPlayer
		currentDynamicStreamIndex : int [read-only] The index of the dynamic stream currently rendering.	MediaPlayer
		currentTime : Number [read-only] Current time of the playhead in seconds.	MediaPlayer
		currentTimeUpdateInterval : Number Interval between the dispatch of change events for the current time in milliseconds.	MediaPlayer
		displayObject : DisplayObject [read-only] DisplayObject for the media.	MediaPlayer
		drmEndDate : Date [read-only] Returns the end date for the playback window.	MediaPlayer
		drmPeriod : Number [read-only] Returns the length of the playback window, in seconds.	MediaPlayer
		drmStartDate : Date [read-only] Returns the start date for the playback window.	MediaPlayer
		drmState : String [read-only] The current state of the DRM for this media.	MediaPlayer
		duration : Number [read-only] Duration of the media's playback, in seconds.	MediaPlayer
		dvrTimeOffset : Number [read-only] Indicates the number of seconds to be added to the time-related properties (currentTime and duration) of the stream in order to obtain the real values. (OSMF always exposes a zero-based timeline) The dvrTimeOffset might have a non-zero value in case of DVR with a rolling window.	MediaPlayer
		dynamicStreamSwitching : Boolean [read-only] Indicates whether or not a dynamic stream switch is currently in progress.	MediaPlayer
		hasAlternativeAudio : Boolean [read-only] Indicates whether the media has alternative audio streams or not.	MediaPlayer
		hasAudio : Boolean [read-only] Indicates whether the media has audio.	MediaPlayer
		hasDRM : Boolean [read-only] Return if the the media element has the DRMTrait.	MediaPlayer
		isDVRRecording : Boolean [read-only] Returns true if the media is DVR-enabled and currently recording, false if the media is either not DVR-enabled, or is DVR-enabled but not currently recording.	MediaPlayer
		isDynamicStream : Boolean [read-only] Indicates whether the media consists of a dynamic stream.	MediaPlayer
		loop : Boolean Indicates whether the media should play again after playback has completed.	MediaPlayer
		maxAllowedDynamicStreamIndex : int The maximum allowed dynamic stream index.	MediaPlayer
		media : MediaElement [override] Source MediaElement controlled by this MediaPlayer.	MediaPlayer
		mediaHeight : Number [read-only] Intrinsic height of the media, in pixels.	MediaPlayer
		mediaWidth : Number [read-only] Intrinsic width of the media, in pixels.	MediaPlayer
		muted : Boolean Indicates whether the media is currently muted.	MediaPlayer
		numAlternativeAudioStreams : int [read-only] Returns the total number of alternative audio streams or 0 if there are no alternative audio streams present.	MediaPlayer
		numDynamicStreams : int [read-only] The total number of dynamic stream indices.	MediaPlayer
		paused : Boolean [read-only] Indicates whether the media is currently paused.	MediaPlayer
		playing : Boolean [read-only] Indicates whether the media is currently playing.	MediaPlayer
		seeking : Boolean [read-only] Indicates whether the media is currently seeking.	MediaPlayer
		state : String [read-only] The current state of the media.	MediaPlayer
		temporal : Boolean [read-only] Indicates whether the media is temporal.	MediaPlayer
		volume : Number Volume of the media.	MediaPlayer

Public Methods

	Method		Defined By
		MediaPlayer(media:MediaElement = null) Constructor.	MediaPlayer
		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
		authenticate(username:String = null, password:String = null):void Authenticates the media.	MediaPlayer
		authenticateWithToken(token:Object):void Authenticates the media using an object which serves as a token.	MediaPlayer
		canSeekTo(time:Number):Boolean Indicates whether the media is capable of seeking to the specified time.	MediaPlayer
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		getAlternativeAudioItemAt(index:int):StreamingItem Obtains the alternative audio stream corresponding to the specified (0-based) index.	MediaPlayer
		getBitrateForDynamicStreamIndex(index:int):Number Gets the associated bitrate, in kilobytes for the specified dynamic stream index.	MediaPlayer
		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.	MediaPlayer
		play():void Plays the media, if it is not already playing.	MediaPlayer
		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
		seek(time:Number):void Instructs the playhead to jump to the specified time.	MediaPlayer
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stop():void Immediately halts playback and returns the playhead to the beginning of the media file.	MediaPlayer
		switchAlternativeAudioIndex(streamIndex:int):void Changes the current audio stream to the alternative audio stream specified by a 0-based index value.	MediaPlayer
		switchDynamicStreamIndex(streamIndex:int):void Switch to a specific dynamic stream index.	MediaPlayer
		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

Events

Click for more information on events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
audioSwitchingChange	Dispatched when an alternative audio stream switch is requested, completed, or has failed.	TraitEventDispatcher
autoSwitchChange	Dispatched when the autoSwitch property has changed.	TraitEventDispatcher
bufferingChange	Dispatched when the buffering property has changed.	TraitEventDispatcher
bufferTimeChange	Dispatched when the bufferTime property has changed.	TraitEventDispatcher
bytesLoadedChange	Dispatched when the value of bytesLoaded has changed.	MediaPlayer
bytesTotalChange	Dispatched when the bytesTotal property has changed.	TraitEventDispatcher
canBufferChange	Dispatched when the canBuffer property has changed.	MediaPlayer
canLoadChange	Dispatched when the canLoad property has changed.	MediaPlayer
canPauseChange	Dispatched when the canPause property has changed.	TraitEventDispatcher
canPlayChange	Dispatched when the canPlay property has changed.	MediaPlayer
canSeekChange	Dispatched when the canSeek property has changed.	MediaPlayer
complete	Dispatched when the media has completed playback.	TraitEventDispatcher
currentTimeChange	Dispatched when the currentTime property of the media has changed.	MediaPlayer
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
displayObjectChange	Dispatched when the displayObject property of the media has changed.	TraitEventDispatcher
drmStateChange	Dispatched when the state of the DRMTrait has changed.	TraitEventDispatcher
durationChange	Dispatched when the duration property of the media has changed.	TraitEventDispatcher
hasAlternativeAudio	Dispatched when the hasAlternativeAudio property has changed.	MediaPlayer
hasAudioChange	Dispatched when the hasAudio property has changed.	MediaPlayer
hasDisplayObjectChange	Dispatched when the hasDisplayObjectChange property has changed.	MediaPlayer
hasDRMChange	Dispatched when the hasDRM property has changed.	MediaPlayer
isDynamicStreamChange	Dispatched when the isDynamicStream property has changed.	MediaPlayer
isRecordingChange	Dispatched when the isRecording property has changed.	TraitEventDispatcher
liveResume	Dispatched when playback resumes after a live stall	MediaPlayer
liveStall	Dispatched when playback runs out of content for a live stream but the stream is not done.	MediaPlayer
loadStateChange	Dispatched when the state of the LoadTrait has changed.	TraitEventDispatcher
mediaError	Dispatched when an error which impacts the operation of the media player occurs.	MediaPlayer
mediaPlayerStateChange	Dispatched when the MediaPlayer's state has changed.	MediaPlayer
mediaSizeChange	Dispatched when the mediaWidth and/or mediaHeight property of the media has changed.	TraitEventDispatcher
mutedChange	Dispatched when the muted property of the media has changed.	TraitEventDispatcher
numAlternativeAudioStreamsChange	Dispatched when the number of alternative audio streams has changed.	TraitEventDispatcher
numDynamicStreamsChange	Dispatched when the number of dynamic streams has changed.	TraitEventDispatcher
panChange	Dispatched when the pan property of the media has changed.	TraitEventDispatcher
playStateChange	Dispatched when the playing or paused property of the media has changed.	TraitEventDispatcher
seekingChange	Dispatched when the seeking property of the media has changed.	TraitEventDispatcher
switchingChange	Dispatched when a dynamic stream switch change occurs.	TraitEventDispatcher
temporalChange	Dispatched when the temporal property has changed.	MediaPlayer
volumeChange	Dispatched when the volume property of the media has changed.	TraitEventDispatcher

Property Detail

alternativeAudioStreamSwitching

property

alternativeAudioStreamSwitching:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.6

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether or not an alternative audio stream switch is currently in progress. This property will return true while an audio stream switch has been requested and the switch has not yet been acknowledged and no switch failure has occurred. Once the switch request has been acknowledged or a failure occurs, the property will return false.

Implementation
public function get alternativeAudioStreamSwitching():Boolean

audioPan

property

audioPan:Number

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Pan property of the media. Ranges from -1 (full pan left) to 1 (full pan right).

If the MediaElement doesn't have audio, then the pan property will be set to this value as soon as the MediaElement has audio.

Implementation
public function get audioPan():Number
public function set audioPan(value:Number):void

autoDynamicStreamSwitch

property

autoDynamicStreamSwitch:Boolean

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether or not the media will automatically switch between dynamic streams. If in manual mode the switchDynamicStreamIndex method can be used to manually switch to a specific stream.

The default is true.

Implementation
public function get autoDynamicStreamSwitch():Boolean
public function set autoDynamicStreamSwitch(value:Boolean):void

autoPlay

property

autoPlay:Boolean

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether the MediaPlayer starts playing the media as soon as its load operation has successfully completed. The default is true.

Implementation
public function get autoPlay():Boolean
public function set autoPlay(value:Boolean):void

autoRewind

property

autoRewind:Boolean

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether media is returned to the beginning after playback completes. If true, when playback completes, the player displays the first frame of the media. If false, when playback completes, the last frame is displayed. The default is true. The autoRewind property is ignored if the loop property is set to true.

Implementation
public function get autoRewind():Boolean
public function set autoRewind(value:Boolean):void

buffering

property

buffering:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether the media is currently buffering.

The default is false.

Implementation
public function get buffering():Boolean

bufferLength

property

bufferLength:Number [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Length of the content currently in the media's buffer, in seconds.

Implementation
public function get bufferLength():Number

bufferTime

property

bufferTime:Number

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Desired length of the media's buffer, in seconds.

If the passed value is non numerical or negative, it is forced to zero.

The default is zero.

Implementation
public function get bufferTime():Number
public function set bufferTime(value:Number):void

bytesLoaded

property

bytesLoaded:Number [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

The number of bytes of the media that have been loaded.

Implementation
public function get bytesLoaded():Number

bytesLoadedUpdateInterval

property

bytesLoadedUpdateInterval:Number

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Interval between the dispatch of change events for the bytesLoaded property.

The default is 250 milliseconds. A non-positive value disables the dispatch of the change events.

Implementation
public function get bytesLoadedUpdateInterval():Number
public function set bytesLoadedUpdateInterval(value:Number):void

Related API Elements

org.osmf.events..LoadEvent

bytesTotal

property

bytesTotal:Number [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

The total number of bytes of the media that will be loaded.

Implementation
public function get bytesTotal():Number

canBuffer

property

canBuffer:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether the media can buffer.

Implementation
public function get canBuffer():Boolean

canLoad

property

canLoad:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether the media can be loaded.

Implementation
public function get canLoad():Boolean

canPause

property

canPause:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether the media can be paused.

Implementation
public function get canPause():Boolean

canPlay

property

canPlay:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether the media can be played.

Implementation
public function get canPlay():Boolean

canSeek

property

canSeek:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether the media is seekable. Seekable media can jump to a specified time.

Implementation
public function get canSeek():Boolean

currentAlternativeAudioStreamIndex

property

currentAlternativeAudioStreamIndex:int [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.6

Runtime Versions:

Flash Player 10, AIR 1.5

The index of the alternative audio stream currently in use. Returns the 0-based index of the selected stream, or -1 if no stream is selected.

Implementation
public function get currentAlternativeAudioStreamIndex():int

currentDynamicStreamIndex

property

currentDynamicStreamIndex:int [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

The index of the dynamic stream currently rendering. Uses a zero-based index.

Implementation
public function get currentDynamicStreamIndex():int

currentTime

property

currentTime:Number [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Current time of the playhead in seconds.

Implementation
public function get currentTime():Number

currentTimeUpdateInterval

property

currentTimeUpdateInterval:Number

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Interval between the dispatch of change events for the current time in milliseconds.

The default is 250 milliseconds. A non-positive value disables the dispatch of the change events.

Implementation
public function get currentTimeUpdateInterval():Number
public function set currentTimeUpdateInterval(value:Number):void

Related API Elements

org.osmf.events..TimeEvent

displayObject

property

displayObject:DisplayObject [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

DisplayObject for the media.

Implementation
public function get displayObject():DisplayObject

drmEndDate

property

drmEndDate:Date [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Returns the end date for the playback window. Returns null if authentication hasn't taken place or if if hasDRM is false.

Implementation
public function get drmEndDate():Date

drmPeriod

property

drmPeriod:Number [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Returns the length of the playback window, in seconds. Returns NaN if authentication hasn't taken place or if hasDRM is false. Note that this property will generally be the difference between startDate and endDate, but is included as a property because there may be times where the duration is known up front, but the start or end dates are not (e.g. a one week rental).

Implementation
public function get drmPeriod():Number

drmStartDate

property

drmStartDate:Date [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Returns the start date for the playback window. Returns null if authentication hasn't taken place or if hasDRM is false.

Implementation
public function get drmStartDate():Date

drmState

property

drmState:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

The current state of the DRM for this media. The states are explained in the DRMState enumeration in the org.osmf.drm package. Returns DRMState.UNINITIALIZED if hasDRM is false.

Implementation
public function get drmState():String

Related API Elements

DRMState

duration

property

duration:Number [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Duration of the media's playback, in seconds.

Implementation
public function get duration():Number

dvrTimeOffset

property

dvrTimeOffset:Number [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 2.0.1

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates the number of seconds to be added to the time-related properties (currentTime and duration) of the stream in order to obtain the real values. (OSMF always exposes a zero-based timeline)

The dvrTimeOffset might have a non-zero value in case of DVR with a rolling window.

Implementation
public function get dvrTimeOffset():Number

dynamicStreamSwitching

property

dynamicStreamSwitching:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether or not a dynamic stream switch is currently in progress. This property will return true while a switch has been requested and the switch has not yet been acknowledged and no switch failure has occurred. Once the switch request has been acknowledged or a failure occurs, the property will return false.

Implementation
public function get dynamicStreamSwitching():Boolean

hasAlternativeAudio

property

hasAlternativeAudio:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.6

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether the media has alternative audio streams or not.

Implementation
public function get hasAlternativeAudio():Boolean

hasAudio

property

hasAudio:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether the media has audio.

Implementation
public function get hasAudio():Boolean

hasDRM

property

hasDRM:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Return if the the media element has the DRMTrait.

Implementation
public function get hasDRM():Boolean

isDVRRecording

property

isDVRRecording:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Returns true if the media is DVR-enabled and currently recording, false if the media is either not DVR-enabled, or is DVR-enabled but not currently recording.

Implementation
public function get isDVRRecording():Boolean

isDynamicStream

property

isDynamicStream:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether the media consists of a dynamic stream.

Implementation
public function get isDynamicStream():Boolean

loop

property

loop:Boolean

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether the media should play again after playback has completed. The loop property takes precedence over the autoRewind property, so if loop is set to true, the autoRewind property is ignored.

The default is false.

Implementation
public function get loop():Boolean
public function set loop(value:Boolean):void

maxAllowedDynamicStreamIndex

property

maxAllowedDynamicStreamIndex:int

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

The maximum allowed dynamic stream index. This can be set at run-time to provide a ceiling for the switching profile, for example, to keep from switching up to a higher quality stream when the current video is too small handle a higher quality stream.

Implementation
public function get maxAllowedDynamicStreamIndex():int
public function set maxAllowedDynamicStreamIndex(value:int):void

Throws

	`RangeError` — If the specified dynamic stream index is less than zero or greater than the highest dynamic stream index available.

	`IllegalOperationError` — If the media is not a dynamic stream.

media

property

media:MediaElement[override]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Source MediaElement controlled by this MediaPlayer. Setting the media will attempt to load media that is loadable, that isn't loading or loaded. It will automatically unload media when the property changes to a new MediaElement or null.

Implementation
override public function get media():MediaElement
override public function set media(value:MediaElement):void

mediaHeight

property

mediaHeight:Number [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Intrinsic height of the media, in pixels. The intrinsic height is the height of the media before any processing has been applied. The default if no DisplayObjectTrait is present, is NaN.

Implementation
public function get mediaHeight():Number

mediaWidth

property

mediaWidth:Number [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Intrinsic width of the media, in pixels. The intrinsic width is the width of the media before any processing has been applied. The default if no DisplayObjectTrait is present, is NaN.

Implementation
public function get mediaWidth():Number

muted

property

muted:Boolean

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether the media is currently muted.

If the MediaElement doesn't have audio, then the muted state will be set to this value as soon as the MediaElement has audio.

Implementation
public function get muted():Boolean
public function set muted(value:Boolean):void

numAlternativeAudioStreams

property

numAlternativeAudioStreams:int [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.6

Runtime Versions:

Flash Player 10, AIR 1.5

Returns the total number of alternative audio streams or 0 if there are no alternative audio streams present.

Implementation
public function get numAlternativeAudioStreams():int

numDynamicStreams

property

numDynamicStreams:int [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

The total number of dynamic stream indices.

Implementation
public function get numDynamicStreams():int

paused

property

paused:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether the media is currently paused.

Implementation
public function get paused():Boolean

playing

property

playing:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether the media is currently playing.

The MediaElement must be playable to support this property.

Implementation
public function get playing():Boolean

seeking

property

seeking:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether the media is currently seeking.

Implementation
public function get seeking():Boolean

state

property

state:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

The current state of the media. See MediaPlayerState for available values.

Implementation
public function get state():String

temporal

property

temporal:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether the media is temporal. Temporal media supports a duration and a currentTime within that duration.

Implementation
public function get temporal():Boolean

volume

property

volume:Number

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Volume of the media. Ranges from 0 (silent) to 1 (full volume).

If the MediaElement doesn't have audio, then the volume will be set to this value as soon as the MediaElement has audio.

Implementation
public function get volume():Number
public function set volume(value:Number):void

Constructor Detail

MediaPlayer

()

Constructor

public function MediaPlayer(media:MediaElement = null)

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Constructor.

Parameters

media:MediaElement (default = null) — Source MediaElement to be controlled by this MediaPlayer.

Method Detail

authenticate

()

method

public function authenticate(username:String = null, password:String = null):void

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Authenticates the media. Can be used for both anonymous and credential-based authentication. If the media has already been authenticated or authentication is anonymous, this is a no-op.

Parameters

	`username:String` (default = `null`) — The username.

	`password:String` (default = `null`) — The password.

Throws

IllegalOperationError — If the media is not initialized yet, or hasDRM is false.

authenticateWithToken

()

method

public function authenticateWithToken(token:Object):void

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Authenticates the media using an object which serves as a token. Can be used for both anonymous and credential-based authentication. If the media has already been authenticated or if the media isn't drm protected, this is a no-op.

Parameters

token:Object — The token to use for authentication.

Throws

IllegalOperationError — If the media is not initialized yet, or hasDRM is false.

canSeekTo

()

method

public function canSeekTo(time:Number):Boolean

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates whether the media is capable of seeking to the specified time.

Parameters

time:Number — Time to seek to in seconds.

Returns

Boolean — Returns true if the media can seek to the specified time.

getAlternativeAudioItemAt

()

method

public function getAlternativeAudioItemAt(index:int):StreamingItem

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.6

Runtime Versions:

Flash Player 10, AIR 1.5

Obtains the alternative audio stream corresponding to the specified (0-based) index. Returns null if the index is -1.

Parameters

index:int

Returns

StreamingItem

Throws

	`RangeError` — if the specified alternative audio stream index is less than `-1` or greater than the highest alternative audio index available.

	`IllegalOperationError` — if the currently loaded media does not have any associated alternative audio streams.

getBitrateForDynamicStreamIndex

()

method

public function getBitrateForDynamicStreamIndex(index:int):Number

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Gets the associated bitrate, in kilobytes for the specified dynamic stream index.

Parameters

index:int

Returns

Number

Throws

	`RangeError` — If the specified dynamic stream index is less than zero or greater than the highest dynamic stream index available.

	`IllegalOperationError` — If the media is not a dynamic stream.

pause

()

method

public function pause():void

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Pauses the media, if it is not already paused.

Throws

IllegalOperationError — if the media cannot be paused.

play

()

method

public function play():void

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Plays the media, if it is not already playing. To use the play() method, MediaPlayer.canPlay must be true. You must listen for the mediaPlayerStateChange event, and only call play() (or enable the UI play button) when the state is READY.

Throws

IllegalOperationError — if the media cannot be played.

seek

()

method

public function seek(time:Number):void

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Instructs the playhead to jump to the specified time.

If time is NaN or negative, does not attempt to seek.

Parameters

time:Number — Time to seek to in seconds.

Throws

IllegalOperationError — if the media cannot be seeked.

stop

()

method

public function stop():void

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Immediately halts playback and returns the playhead to the beginning of the media file.

Throws

IllegalOperationError — If the media cannot be played (and therefore cannot be stopped).

switchAlternativeAudioIndex

()

method

public function switchAlternativeAudioIndex(streamIndex:int):void

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.6

Runtime Versions:

Flash Player 10, AIR 1.5

Changes the current audio stream to the alternative audio stream specified by a 0-based index value. Passing -1 as the index value resets the current audio stream to the default audio stream. Note that if media playback is paused, the audio stream switch does not occur until after play resumes.

Parameters

streamIndex:int

Throws

	`RangeError` — if the specified alternative audio stream index is less than `-1` or greater than `numAlternativeAudioStreams - 1`.

	`IllegalOperationError` — if the currently loaded media does not have any associated alternative audio streams.

switchDynamicStreamIndex

()

method

public function switchDynamicStreamIndex(streamIndex:int):void

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Switch to a specific dynamic stream index. To switch up, use the currentDynamicStreamIndex property, such as:

mediaPlayer.switchDynamicStreamIndex(mediaPlayer.currentDynamicStreamIndex + 1);

Note: If the media is paused, switching will not take place until after play resumes.

Parameters

streamIndex:int

Throws

	`RangeError` — If the specified dynamic stream index is less than zero or greater than `maxAllowedDynamicStreamIndex`.

	`IllegalOperationError` — If the media is not a dynamic stream, or if the dynamic stream is not in manual switch mode.

Related API Elements

maxAllowedDynamicStreamIndex

Event Detail

bytesLoadedChange

Event

Event Object Type: org.osmf.events.LoadEvent
property LoadEvent.type = org.osmf.events.LoadEvent

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Dispatched when the value of bytesLoaded has changed.

canBufferChange

Event

Event Object Type: org.osmf.events.MediaPlayerCapabilityChangeEvent
property MediaPlayerCapabilityChangeEvent.type = org.osmf.events.MediaPlayerCapabilityChangeEvent.CAN_BUFFER_CHANGE

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Dispatched when the canBuffer property has changed.

The MediaPlayerCapabilityChangeEvent.CAN_BUFFER_CHANGE constant defines the value of the type property of the event object for a canBufferChange event.

canLoadChange

Event

Event Object Type: org.osmf.events.MediaPlayerCapabilityChangeEvent
property MediaPlayerCapabilityChangeEvent.type = org.osmf.events.MediaPlayerCapabilityChangeEvent.CAN_LOAD_CHANGE

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Dispatched when the canLoad property has changed.

The MediaPlayerCapabilityChangeEvent.CAN_LOAD_CHANGE constant defines the value of the type property of the event object for a canLoadChange event.

canPlayChange

Event

Event Object Type: org.osmf.events.MediaPlayerCapabilityChangeEvent
property MediaPlayerCapabilityChangeEvent.type = org.osmf.events.MediaPlayerCapabilityChangeEvent.CAN_PLAY_CHANGE

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Dispatched when the canPlay property has changed.

The MediaPlayerCapabilityChangeEvent.CAN_PLAY_CHANGE constant defines the value of the type property of the event object for a canPlayChange event.

canSeekChange

Event

Event Object Type: org.osmf.events.MediaPlayerCapabilityChangeEvent
property MediaPlayerCapabilityChangeEvent.type = org.osmf.events.MediaPlayerCapabilityChangeEvent.CAN_SEEK_CHANGE

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Dispatched when the canSeek property has changed.

The MediaPlayerCapabilityChangeEvent.CAN_SEEK_CHANGE constant defines the value of the type property of the event object for a canSeekChange event.

currentTimeChange

Event

Event Object Type: org.osmf.events.TimeEvent
property TimeEvent.type = org.osmf.events.TimeEvent.CURRENT_TIME_CHANGE

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Dispatched when the currentTime property of the media has changed. This value is updated at the interval set by the MediaPlayer's currentTimeUpdateInterval property.

The TimeEvent.CURRENT_TIME_CHANGE constant defines the value of the type property of the event object for a currentTimeChange event.

hasAlternativeAudio

Event

Event Object Type: org.osmf.events.MediaPlayerCapabilityChangeEvent
property MediaPlayerCapabilityChangeEvent.type = org.osmf.events.MediaPlayerCapabilityChangeEvent.HAS_ALTERNATIVE_AUDIO_CHANGE

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.6

Runtime Versions:

Flash Player 10, AIR 1.5

Dispatched when the hasAlternativeAudio property has changed.

This event is dispatched by MediaPlayer when its hasAlternativeAudio property has changed.

hasAudioChange

Event

Event Object Type: org.osmf.events.MediaPlayerCapabilityChangeEvent
property MediaPlayerCapabilityChangeEvent.type = org.osmf.events.MediaPlayerCapabilityChangeEvent.HAS_AUDIO_CHANGE

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Dispatched when the hasAudio property has changed.

The MediaPlayerCapabilityChangeEvent.HAS_AUDIO_CHANGE constant defines the value of the type property of the event object for a hasAudioChange event.

hasDisplayObjectChange

Event

Event Object Type: org.osmf.events.MediaPlayerCapabilityChangeEvent
property MediaPlayerCapabilityChangeEvent.type = org.osmf.events.MediaPlayerCapabilityChangeEvent.HAS_DISPLAY_OBJECT_CHANGE

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Dispatched when the hasDisplayObjectChange property has changed.

The MediaPlayerCapabilityChangeEvent.HAS_DISPLAY_OBJECT_CHANGE constant defines the value of the type property of the event object for a hasDisplayObjectChange event.

hasDRMChange

Event

Event Object Type: org.osmf.events.MediaPlayerCapabilityChangeEvent
property MediaPlayerCapabilityChangeEvent.type = org.osmf.events.MediaPlayerCapabilityChangeEvent.HAS_DRM_CHANGE

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Dispatched when the hasDRM property has changed.

The MediaPlayerCapabilityChangeEvent.HAS_DRM_CHANGE constant defines the value of the type property of the event object for a hasDRMChange event.

isDynamicStreamChange

Event

Event Object Type: org.osmf.events.MediaPlayerCapabilityChangeEvent
property MediaPlayerCapabilityChangeEvent.type = org.osmf.events.MediaPlayerCapabilityChangeEvent.IS_DYNAMIC_STREAM_CHANGE

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Dispatched when the isDynamicStream property has changed.

The MediaPlayerCapabilityChangeEvent.IS_DYNAMIC_STREAM_CHANGE constant defines the value of the type property of the event object for a isDynamicStreamChange event.

liveResume

Event

Event Object Type: org.osmf.events.PlayEvent
property PlayEvent.type = org.osmf.events.PlayEvent.LIVE_RESUME

Language Version:

ActionScript 3.0

Product Version:

OSMF 2.0

Runtime Versions:

Flash Player 10, AIR 1.5

Dispatched when playback resumes after a live stall

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

liveStall

Event

Event Object Type: org.osmf.events.PlayEvent
property PlayEvent.type = org.osmf.events.PlayEvent.LIVE_STALL

Language Version:

ActionScript 3.0

Product Version:

OSMF 2.0

Runtime Versions:

Flash Player 10, AIR 1.5

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

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.

mediaError

Event

Event Object Type: org.osmf.events.MediaErrorEvent
property MediaErrorEvent.type = org.osmf.events.MediaErrorEvent.MEDIA_ERROR

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Dispatched when an error which impacts the operation of the media player occurs.

The MediaErrorEvent.MEDIA_ERROR constant defines the value of the type property of the event object for a mediaError event.

mediaPlayerStateChange

Event

Event Object Type: org.osmf.events.MediaPlayerStateChangeEvent
property MediaPlayerStateChangeEvent.type = org.osmf.events.MediaPlayerStateChangeEvent.MEDIA_PLAYER_STATE_CHANGE

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Dispatched when the MediaPlayer's state has changed.

The MediaPlayerStateChangeEvent.MEDIA_PLAYER_STATE_CHANGE constant defines the value of the type property of the event object for a mediaPlayerStateChange event.

temporalChange

Event

Event Object Type: org.osmf.events.MediaPlayerCapabilityChangeEvent
property MediaPlayerCapabilityChangeEvent.type = org.osmf.events.MediaPlayerCapabilityChangeEvent.TEMPORAL_CHANGE

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Dispatched when the temporal property has changed.

The MediaPlayerCapabilityChangeEvent.TEMPORAL_CHANGE constant defines the value of the type property of the event object for a temporalChange event.

Examples How to use this example

MediaPlayerExample.as

package org.osmf.media
{
    import flash.display.Sprite;
    
    import org.osmf.containers.MediaContainer;
    import org.osmf.elements.AudioElement;
    import org.osmf.events.TimeEvent;
    import org.osmf.media.MediaPlayer;
    import org.osmf.media.URLResource;
    
    public class MediaPlayerExample extends Sprite
    {
        private var mediaPlayer:MediaPlayer;
        
        public function MediaPlayerExample()
        {            
            super();
                        
            mediaPlayer = new MediaPlayer();
            var audioElement:AudioElement = new AudioElement();
            audioElement.resource = new URLResource("http://mediapm.edgesuite.net/osmf/content/test/train_1500.mp3");
                                    
            mediaPlayer.volume = .5;
            mediaPlayer.loop = true;
            mediaPlayer.addEventListener(TimeEvent.CURRENT_TIME_CHANGE, onTimeUpdated);        
            mediaPlayer.addEventListener(TimeEvent.DURATION_CHANGE, onTimeUpdated);
            mediaPlayer.autoPlay = true;
            mediaPlayer.media = audioElement;    
        }
        
        private function onTimeUpdated(event:TimeEvent):void
        {
            trace('time: ' + mediaPlayer.currentTime + ' duration: ' + mediaPlayer.duration);
        }
    }
}

Legal Notices | Online Privacy Policy

MediaPlayer - AS3 OSMF

Classes x

alternativeAudioStreamSwitching

audioPan

autoDynamicStreamSwitch

autoPlay

autoRewind

buffering

bufferLength

bufferTime

bytesLoaded

bytesLoadedUpdateInterval

bytesTotal

canBuffer

canLoad

canPause

canPlay

canSeek

currentAlternativeAudioStreamIndex

currentDynamicStreamIndex

currentTime

currentTimeUpdateInterval

displayObject

drmEndDate

drmPeriod

drmStartDate

drmState

duration

dvrTimeOffset

dynamicStreamSwitching

hasAlternativeAudio

hasAudio

hasDRM

isDVRRecording

isDynamicStream

loop

maxAllowedDynamicStreamIndex

media

mediaHeight

mediaWidth

muted

numAlternativeAudioStreams

numDynamicStreams

paused

playing

seeking

state

temporal

volume

MediaPlayer

authenticate

authenticateWithToken

canSeekTo

getAlternativeAudioItemAt

getBitrateForDynamicStreamIndex

pause

play

seek

stop

switchAlternativeAudioIndex

switchDynamicStreamIndex

bytesLoadedChange

canBufferChange

canLoadChange

canPlayChange

canSeekChange

currentTimeChange

hasAlternativeAudio

hasAudioChange

hasDisplayObjectChange

hasDRMChange

isDynamicStreamChange

liveResume

liveStall

mediaError

mediaPlayerStateChange

temporalChange