MediaPlayer

包	org.osmf.media
类	public class MediaPlayer
继承	MediaPlayer TraitEventDispatcher EventDispatcher Object

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

MediaPlayer 是控制器类，用来与所有媒体类型交互。

该类是一个高级类，可以为开发人员遮蔽媒体框架的低级详细信息。MediaPlayer 类还提供一些便于使用的功能，例如循环、自动播放和自动后退。

MediaPlayer 可以播放 Open Source Media Framework 支持的所有媒体类型，其中包括媒体组合。

查看示例

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		alternativeAudioStreamSwitching : Boolean [只读] 指示替代音频流切换当前是否正在进行。	MediaPlayer
		audioPan : Number 媒体的 pan 属性。	MediaPlayer
		autoDynamicStreamSwitch : Boolean 指示媒体是否在动态流之间自动切换。	MediaPlayer
		autoPlay : Boolean 指示 MediaPlayer 在成功完成其加载操作之后是否立即播放媒体。	MediaPlayer
		autoRewind : Boolean 指示媒体在播放完成后是否返回到开头位置。	MediaPlayer
		buffering : Boolean [只读] 指示媒体当前是否处于缓冲状态。	MediaPlayer
		bufferLength : Number [只读] 当前处于媒体缓冲区中的内容的长度（以秒为单位）。	MediaPlayer
		bufferTime : Number 媒体缓冲区所需长度（以秒为单位）。	MediaPlayer
		bytesLoaded : Number [只读] 已加载的媒体的字节数。	MediaPlayer
		bytesLoadedUpdateInterval : Number 针对 bytesLoaded 属性调度 change 事件的时间间隔。	MediaPlayer
		bytesTotal : Number [只读] 将加载的媒体的总字节数。	MediaPlayer
		canBuffer : Boolean [只读] 指示是否可以缓冲媒体。	MediaPlayer
		canLoad : Boolean [只读] 指示是否可以加载媒体。	MediaPlayer
		canPause : Boolean [只读] 指示是否可以暂停媒体。	MediaPlayer
		canPlay : Boolean [只读] 指示是否可以播放媒体。	MediaPlayer
		canSeek : Boolean [只读] 指示媒体是否可搜索。	MediaPlayer
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		currentAlternativeAudioStreamIndex : int [只读] 当前正在使用的替代音频流的索引。	MediaPlayer
		currentDynamicStreamIndex : int [只读] 当前呈示的动态流的索引。	MediaPlayer
		currentTime : Number [只读] 播放头的当前时间（以秒为单位）。	MediaPlayer
		currentTimeUpdateInterval : Number 针对当前时间调度 change 事件的时间间隔（以毫秒为单位）。	MediaPlayer
		displayObject : DisplayObject [只读] 媒体的 DisplayObject。	MediaPlayer
		drmEndDate : Date [只读] 返回播放窗口的结束日期。	MediaPlayer
		drmPeriod : Number [只读] 返回播放窗口的长度（以秒为单位）。	MediaPlayer
		drmStartDate : Date [只读] 返回播放窗口的开始日期。	MediaPlayer
		drmState : String [只读] 此媒体的 DRM 的当前状态。	MediaPlayer
		duration : Number [只读] 媒体的持续播放时间（以秒为单位）。	MediaPlayer
		dvrTimeOffset : Number [只读] 指示为了获取实际值要添加到流的时间相关属性（currentTime 和 duration）中的秒数。（OSMF 始终公开从零开始的时间轴）如果 DVR 具有滚动窗口，则 dvrTimeOffset 可能具有非零值。	MediaPlayer
		dynamicStreamSwitching : Boolean [只读] 指示动态流切换当前是否正在进行。	MediaPlayer
		hasAlternativeAudio : Boolean [只读] 指示媒体是否具有替代音频流。	MediaPlayer
		hasAudio : Boolean [只读] 指示媒体是否包含音频。	MediaPlayer
		hasDRM : Boolean [只读] 返回媒体元素是否具有 DRMTrait。	MediaPlayer
		isDVRRecording : Boolean [只读] 如果媒体启用了 DVR，且当前正在录制，则返回 true；如果媒体未启用 DVR，或启用了 DVR 但当前没有录制，则返回 false。	MediaPlayer
		isDynamicStream : Boolean [只读] 指示媒体是否包含动态流。	MediaPlayer
		loop : Boolean 指示播放已完成之后媒体是否应该重新播放。	MediaPlayer
		maxAllowedDynamicStreamIndex : int 允许的动态流索引最大值。	MediaPlayer
		media : MediaElement [覆盖] 此 MediaPlayer 控制的源 MediaElement。	MediaPlayer
		mediaHeight : Number [只读] 媒体的固有高度（以像素为单位）。	MediaPlayer
		mediaWidth : Number [只读] 媒体的固有宽度（以像素为单位）。	MediaPlayer
		muted : Boolean 指示媒体当前是否处于静音状态。	MediaPlayer
		numAlternativeAudioStreams : int [只读] 返回替代音频流的总数；如果不存在替代音频流，则返回 0。	MediaPlayer
		numDynamicStreams : int [只读] 动态流索引的总数。	MediaPlayer
		paused : Boolean [只读] 指示媒体当前是否处于暂停状态。	MediaPlayer
		playing : Boolean [只读] 指示媒体当前是否处于播放状态。	MediaPlayer
		seeking : Boolean [只读] 指示媒体当前是否处于搜索状态。	MediaPlayer
		state : String [只读] 媒体的当前状态。	MediaPlayer
		temporal : Boolean [只读] 指示媒体是否是临时媒体。	MediaPlayer
		volume : Number 媒体的音量。	MediaPlayer

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		MediaPlayer(media:MediaElement = null) 构造函数。	MediaPlayer
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。	EventDispatcher
		authenticate(username:String = null, password:String = null):void 认证媒体。	MediaPlayer
		authenticateWithToken(token:Object):void 使用用作标记的对象认证媒体。	MediaPlayer
		canSeekTo(time:Number):Boolean 指示媒体是否能够搜索到指定时间。	MediaPlayer
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	EventDispatcher
		getAlternativeAudioItemAt(index:int):StreamingItem 获取与指定（基于 0）索引对应的替代音频流。	MediaPlayer
		getBitrateForDynamicStreamIndex(index:int):Number 获取指定动态流索引的关联比特率（以千字节为单位）。	MediaPlayer
		hasEventListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	EventDispatcher
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		pause():void 暂停媒体（如果尚未暂停）。	MediaPlayer
		play():void 播放媒体（如果尚未播放）。	MediaPlayer
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 从 EventDispatcher 对象中删除侦听器。	EventDispatcher
		seek(time:Number):void 指示播放头跳到指定时间。	MediaPlayer
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		stop():void 立即终止播放，并将播放头返回到媒体文件的开头。	MediaPlayer
		switchAlternativeAudioIndex(streamIndex:int):void 将当前音频流更改为由基于 0 的索引值指定的替代音频流。	MediaPlayer
		switchDynamicStreamIndex(streamIndex:int):void 切换到特定动态流索引。	MediaPlayer
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回指定对象的字符串表示形式。	Object
		valueOf():Object 返回指定对象的原始值。	Object
		willTrigger(type:String):Boolean 检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。	EventDispatcher

事件

单击此处了解有关事件的更多信息

隐藏继承的事件

显示继承的事件

	摘要	由以下参数定义
activate	[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。	EventDispatcher
audioSwitchingChange	在替代音频流切换已请求、完成或失败时调度。	TraitEventDispatcher
autoSwitchChange	在 autoSwitch 属性发生变化时调度。	TraitEventDispatcher
bufferingChange	在 buffering 属性发生变化时调度。	TraitEventDispatcher
bufferTimeChange	在 bufferTime 属性发生变化时调度。	TraitEventDispatcher
bytesLoadedChange	在 bytesLoaded 的值发生变化时调度。	MediaPlayer
bytesTotalChange	在 bytesTotal 属性发生变化时调度。	TraitEventDispatcher
canBufferChange	在 canBuffer 属性发生变化时调度。	MediaPlayer
canLoadChange	在 canLoad 属性发生变化时调度。	MediaPlayer
canPauseChange	在 canPause 属性发生变化时调度。	TraitEventDispatcher
canPlayChange	在 canPlay 属性发生变化时调度。	MediaPlayer
canSeekChange	在 canSeek 属性发生变化时调度。	MediaPlayer
complete	在媒体完成播放时调度。	TraitEventDispatcher
currentTimeChange	在媒体的 currentTime 属性发生变化时调度。	MediaPlayer
deactivate	[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。	EventDispatcher
displayObjectChange	在媒体的 displayObject 属性发生变化时调度。	TraitEventDispatcher
drmStateChange	在 DRMTrait 的状态发生变化时调度。	TraitEventDispatcher
durationChange	在媒体的 duration 属性发生变化时调度。	TraitEventDispatcher
hasAlternativeAudio	在 hasAlternativeAudio 属性发生更改时调度。	MediaPlayer
hasAudioChange	在 hasAudio 属性发生变化时调度。	MediaPlayer
hasDisplayObjectChange	在 hasDisplayObjectChange 属性发生变化时调度。	MediaPlayer
hasDRMChange	在 hasDRM 属性发生变化时调度。	MediaPlayer
isDynamicStreamChange	在 isDynamicStream 属性发生变化时调度。	MediaPlayer
isRecordingChange	在 isRecording 属性发生变化时调度。	TraitEventDispatcher
liveResume	在实时停顿后恢复播放时调度	MediaPlayer
liveStall	当播放用完实时流的内容而流还未完成时调度。	MediaPlayer
loadStateChange	在 LoadTrait 的状态发生变化时调度。	TraitEventDispatcher
mediaError	在发生影响媒体播放器运行的错误时调度。	MediaPlayer
mediaPlayerStateChange	在 MediaPlayer 的状态发生变化时调度。	MediaPlayer
mediaSizeChange	在媒体的 mediaWidth 和/或 mediaHeight 属性发生变化时调度。	TraitEventDispatcher
mutedChange	在媒体的 muted 属性发生变化时调度。	TraitEventDispatcher
numAlternativeAudioStreamsChange	在替代音频流的数量更改时调度。	TraitEventDispatcher
numDynamicStreamsChange	在动态流的数量更改时调度。	TraitEventDispatcher
panChange	在媒体的 pan 属性发生变化时调度。	TraitEventDispatcher
playStateChange	在媒体的 playing 或 paused 属性发生变化时调度。	TraitEventDispatcher
seekingChange	在媒体的 seeking 属性发生变化时调度。	TraitEventDispatcher
switchingChange	在发生动态流切换更改时调度。	TraitEventDispatcher
temporalChange	在 temporal 属性发生变化时调度。	MediaPlayer
volumeChange	在媒体的 volume 属性发生变化时调度。	TraitEventDispatcher

属性详细信息

alternativeAudioStreamSwitching

属性

alternativeAudioStreamSwitching:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.6

运行时版本:

Flash Player 10, AIR 1.5

指示替代音频流切换当前是否正在进行。在已请求音频流切换但切换未经确认且未失败时，此属性将返回 true。一旦已确认切换请求或切换失败，此属性将返回 false。

实现
public function get alternativeAudioStreamSwitching():Boolean

audioPan

属性

audioPan:Number

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

媒体的 pan 属性。范围从 -1（左侧最大平移）至 1（右侧最大平移）。

如果 MediaElement 不包含音频，则在 MediaElement 包含音频后，会将 pan 属性设置为此值。

实现
public function get audioPan():Number
public function set audioPan(value:Number):void

autoDynamicStreamSwitch

属性

autoDynamicStreamSwitch:Boolean

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

指示媒体是否在动态流之间自动切换。如果在手动模式下，则可以使用 switchDynamicStreamIndex 方法手动切换到特定流。

默认值为 true。

实现
public function get autoDynamicStreamSwitch():Boolean
public function set autoDynamicStreamSwitch(value:Boolean):void

autoPlay

属性

autoPlay:Boolean

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

指示 MediaPlayer 在成功完成其加载操作之后是否立即播放媒体。默认值为 true。

实现
public function get autoPlay():Boolean
public function set autoPlay(value:Boolean):void

autoRewind

属性

autoRewind:Boolean

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

指示媒体在播放完成后是否返回到开头位置。如果为 true，则在播放完成后，播放器将显示媒体的第一帧。如果为 false，则在播放完成后，将显示最后一帧。默认值为 true。如果将 loop 属性设置为 true，则忽略 autoRewind 属性。

实现
public function get autoRewind():Boolean
public function set autoRewind(value:Boolean):void

buffering

属性

buffering:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

指示媒体当前是否处于缓冲状态。

默认值为 false。

实现
public function get buffering():Boolean

bufferLength

属性

bufferLength:Number [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

当前处于媒体缓冲区中的内容的长度（以秒为单位）。

实现
public function get bufferLength():Number

bufferTime

属性

bufferTime:Number

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

媒体缓冲区所需长度（以秒为单位）。

如果传递的值是非数字值或负值，则将其强制为零。

默认值为零。

实现
public function get bufferTime():Number
public function set bufferTime(value:Number):void

bytesLoaded

属性

bytesLoaded:Number [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

已加载的媒体的字节数。

实现
public function get bytesLoaded():Number

bytesLoadedUpdateInterval

属性

bytesLoadedUpdateInterval:Number

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

针对 bytesLoaded 属性调度 change 事件的时间间隔。

默认值为 250 毫秒。如果值为非正值，将禁止调度 change 事件。

实现
public function get bytesLoadedUpdateInterval():Number
public function set bytesLoadedUpdateInterval(value:Number):void

相关 API 元素

org.osmf.events..LoadEvent

bytesTotal

属性

bytesTotal:Number [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

将加载的媒体的总字节数。

实现
public function get bytesTotal():Number

canBuffer

属性

canBuffer:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

指示是否可以缓冲媒体。

实现
public function get canBuffer():Boolean

canLoad

属性

canLoad:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

指示是否可以加载媒体。

实现
public function get canLoad():Boolean

canPause

属性

canPause:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

指示是否可以暂停媒体。

实现
public function get canPause():Boolean

canPlay

属性

canPlay:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

指示是否可以播放媒体。

实现
public function get canPlay():Boolean

canSeek

属性

canSeek:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

指示媒体是否可搜索。可搜索媒体可以跳到指定时间。

实现
public function get canSeek():Boolean

currentAlternativeAudioStreamIndex

属性

currentAlternativeAudioStreamIndex:int [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.6

运行时版本:

Flash Player 10, AIR 1.5

当前正在使用的替代音频流的索引。返回选定流的基于 0 的索引；如果未选定任何流，则返回 -1。

实现
public function get currentAlternativeAudioStreamIndex():int

currentDynamicStreamIndex

属性

currentDynamicStreamIndex:int [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

当前呈示的动态流的索引。使用从零开始的索引。

实现
public function get currentDynamicStreamIndex():int

currentTime

属性

currentTime:Number [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

播放头的当前时间（以秒为单位）。

实现
public function get currentTime():Number

currentTimeUpdateInterval

属性

currentTimeUpdateInterval:Number

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

针对当前时间调度 change 事件的时间间隔（以毫秒为单位）。

默认值为 250 毫秒。如果值为非正值，将禁止调度 change 事件。

实现
public function get currentTimeUpdateInterval():Number
public function set currentTimeUpdateInterval(value:Number):void

相关 API 元素

org.osmf.events..TimeEvent

displayObject

属性

displayObject:DisplayObject [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

媒体的 DisplayObject。

实现
public function get displayObject():DisplayObject

drmEndDate

属性

drmEndDate:Date [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

返回播放窗口的结束日期。如果未进行身份验证或 hasDRM 为 false，则返回 null。

实现
public function get drmEndDate():Date

drmPeriod

属性

drmPeriod:Number [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

返回播放窗口的长度（以秒为单位）。如果未进行身份验证或 hasDRM 为 false，则返回 NaN。请注意，此属性通常是 startDate 和 endDate 之间的差值，但是作为属性提供，因为持续时间预先可能知道，但是开始日期和结束日期预先可能不知道（例如，为期一周的租赁）。

实现
public function get drmPeriod():Number

drmStartDate

属性

drmStartDate:Date [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

返回播放窗口的开始日期。如果未进行身份验证或 hasDRM 为 false，则返回 null。

实现
public function get drmStartDate():Date

drmState

属性

drmState:String [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

此媒体的 DRM 的当前状态。在 org.osmf.drm 包的 DRMState 枚举中对这些状态进行了说明。如果 hasDRM 为 false，则返回 DRMState.UNINITIALIZED。

实现
public function get drmState():String

相关 API 元素

DRMState

duration

属性

duration:Number [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

媒体的持续播放时间（以秒为单位）。

实现
public function get duration():Number

dvrTimeOffset

属性

dvrTimeOffset:Number [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 2.0.1

运行时版本:

Flash Player 10, AIR 1.5

指示为了获取实际值要添加到流的时间相关属性（currentTime 和 duration）中的秒数。（OSMF 始终公开从零开始的时间轴）

如果 DVR 具有滚动窗口，则 dvrTimeOffset 可能具有非零值。

实现
public function get dvrTimeOffset():Number

dynamicStreamSwitching

属性

dynamicStreamSwitching:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

指示动态流切换当前是否正在进行。在已请求切换但切换未经确认且未失败时，此属性将返回 true。一旦已确认切换请求或切换失败，此属性将返回 false。

实现
public function get dynamicStreamSwitching():Boolean

hasAlternativeAudio

属性

hasAlternativeAudio:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.6

运行时版本:

Flash Player 10, AIR 1.5

指示媒体是否具有替代音频流。

实现
public function get hasAlternativeAudio():Boolean

hasAudio

属性

hasAudio:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

指示媒体是否包含音频。

实现
public function get hasAudio():Boolean

hasDRM

属性

hasDRM:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

返回媒体元素是否具有 DRMTrait。

实现
public function get hasDRM():Boolean

isDVRRecording

属性

isDVRRecording:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

如果媒体启用了 DVR，且当前正在录制，则返回 true；如果媒体未启用 DVR，或启用了 DVR 但当前没有录制，则返回 false。

实现
public function get isDVRRecording():Boolean

isDynamicStream

属性

isDynamicStream:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

指示媒体是否包含动态流。

实现
public function get isDynamicStream():Boolean

loop

属性

loop:Boolean

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

指示播放已完成之后媒体是否应该重新播放。loop 属性优先于 autoRewind 属性，因此如果将 loop 设置为 true，则会忽略 autoRewind 属性。

默认值为 false。

实现
public function get loop():Boolean
public function set loop(value:Boolean):void

maxAllowedDynamicStreamIndex

属性

maxAllowedDynamicStreamIndex:int

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

允许的动态流索引最大值。例如，可在运行时设置此值以提供切换概要文件的上限值，以便在当前视频太小而无法处理高质量的流时，防止向上切换到较高质量的流。

实现
public function get maxAllowedDynamicStreamIndex():int
public function set maxAllowedDynamicStreamIndex(value:int):void

引发

	`RangeError` — 如果指定的动态流索引小于零或大于可用的最高动态流索引。

	`IllegalOperationError` — 如果媒体不是动态流。

media

属性

media:MediaElement[覆盖]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

此 MediaPlayer 控制的源 MediaElement。设置该媒体将尝试加载未在加载或尚未加载的可加载媒体。它将在属性更改为新 MediaElement 或 null 时自动卸载媒体。

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

mediaHeight

属性

mediaHeight:Number [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

媒体的固有高度（以像素为单位）。固有高度即媒体在应用任何处理之前的高度。如果不存在任何 DisplayObjectTrait，则默认值为 NaN。

实现
public function get mediaHeight():Number

mediaWidth

属性

mediaWidth:Number [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

媒体的固有宽度（以像素为单位）。固有宽度即媒体在应用任何处理之前的宽度。如果不存在任何 DisplayObjectTrait，则默认值为 NaN。

实现
public function get mediaWidth():Number

muted

属性

muted:Boolean

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

指示媒体当前是否处于静音状态。

如果 MediaElement 不包含音频，则在 MediaElement 包含音频后，会将静音状态设置为此值。

实现
public function get muted():Boolean
public function set muted(value:Boolean):void

numAlternativeAudioStreams

属性

numAlternativeAudioStreams:int [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.6

运行时版本:

Flash Player 10, AIR 1.5

返回替代音频流的总数；如果不存在替代音频流，则返回 0。

实现
public function get numAlternativeAudioStreams():int

numDynamicStreams

属性

numDynamicStreams:int [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

动态流索引的总数。

实现
public function get numDynamicStreams():int

paused

属性

paused:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

指示媒体当前是否处于暂停状态。

实现
public function get paused():Boolean

playing

属性

playing:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

指示媒体当前是否处于播放状态。

MediaElement 必须是可播放媒体，才能支持此属性。

实现
public function get playing():Boolean

seeking

属性

seeking:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

指示媒体当前是否处于搜索状态。

实现
public function get seeking():Boolean

state

属性

state:String [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

媒体的当前状态。有关可用值，请参阅 MediaPlayerState。

实现
public function get state():String

temporal

属性

temporal:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

指示媒体是否是临时媒体。临时媒体支持持续时间和该持续时间内的 currentTime。

实现
public function get temporal():Boolean

volume

属性

volume:Number

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

媒体的音量。音量范围从 0（静音）至 1（最大音量）。

如果 MediaElement 不包含音频，则在 MediaElement 包含音频后，会将音量设置为此值。

实现
public function get volume():Number
public function set volume(value:Number):void

构造函数详细信息

()

构造函数

public function MediaPlayer(media:MediaElement = null)

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

构造函数。

参数

media:MediaElement (default = null) — 此 MediaPlayer 要控制的源 MediaElement。

方法详细信息

authenticate

()

方法

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

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

认证媒体。可以用于匿名或基于凭据的身份验证。如果媒体已经过身份验证或经过匿名身份验证，则为 no-op。

参数

	`username:String` (default = `null`) — 用户名。

	`password:String` (default = `null`) — 密码。

引发

IllegalOperationError — 如果尚未初始化媒体或 hasDRM 为 false。

authenticateWithToken

()

方法

public function authenticateWithToken(token:Object):void

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

使用用作标记的对象认证媒体。可以用于匿名或基于凭据的身份验证。如果媒体已经过身份验证或媒体不受 DRM 保护，则为 no-op。

参数

token:Object — 用于身份验证的标记。

引发

IllegalOperationError — 如果尚未初始化媒体或 hasDRM 为 false。

canSeekTo

()

方法

public function canSeekTo(time:Number):Boolean

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

指示媒体是否能够搜索到指定时间。

参数

time:Number — 要搜索到的时间（以秒为单位）。

Boolean — 如果媒体能够搜索到指定时间，则返回 true。

getAlternativeAudioItemAt

()

方法

public function getAlternativeAudioItemAt(index:int):StreamingItem

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.6

运行时版本:

Flash Player 10, AIR 1.5

获取与指定（基于 0）索引对应的替代音频流。如果索引为 -1，则返回 null。

参数

index:int

StreamingItem

引发

	`RangeError` — 如果指定替代音频流索引小于 `-1` 或大于可用的最高替代音频索引。

	`IllegalOperationError` — 如果当前加载的媒体没有任何关联的替代音频流。

getBitrateForDynamicStreamIndex

()

方法

public function getBitrateForDynamicStreamIndex(index:int):Number

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

获取指定动态流索引的关联比特率（以千字节为单位）。

参数

index:int

Number

引发

	`RangeError` — 如果指定的动态流索引小于零或大于可用的最高动态流索引。

	`IllegalOperationError` — 如果媒体不是动态流。

pause

()

方法

public function pause():void

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

暂停媒体（如果尚未暂停）。

引发

IllegalOperationError — 如果无法暂停媒体。

play

()

方法

public function play():void

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

播放媒体（如果尚未播放）。要使用 play() 方法，MediaPlayer.canPlay 必须为 true。您必须侦听 mediaPlayerStateChange 事件，并在处于 READY 状态时仅调用 play()（或启用 UI 播放按钮）。

引发

IllegalOperationError — 如果无法播放媒体。

seek

()

方法

public function seek(time:Number):void

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

指示播放头跳到指定时间。

如果 time 为 NaN 或负值，则不会尝试搜索。

参数

time:Number — 要搜索到的时间（以秒为单位）。

引发

IllegalOperationError — 如果无法搜索媒体。

stop

()

方法

public function stop():void

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

立即终止播放，并将播放头返回到媒体文件的开头。

引发

IllegalOperationError — 如果无法播放媒体（因此无法停止）。

switchAlternativeAudioIndex

()

方法

public function switchAlternativeAudioIndex(streamIndex:int):void

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.6

运行时版本:

Flash Player 10, AIR 1.5

将当前音频流更改为由基于 0 的索引值指定的替代音频流。将 -1 作为索引值传递会将当前音频流重置为默认音频流。请注意，如果媒体播放已暂停，则在继续播放之前，不会发生音频流切换。

参数

streamIndex:int

引发

	`RangeError` — 如果指定替代音频流索引小于 `-1` 或大于 `numAlternativeAudioStreams - 1`。

	`IllegalOperationError` — 如果当前加载的媒体没有任何关联的替代音频流。

switchDynamicStreamIndex

()

方法

public function switchDynamicStreamIndex(streamIndex:int):void

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

切换到特定动态流索引。要向上切换，请使用 currentDynamicStreamIndex 属性，例如：

mediaPlayer.switchDynamicStreamIndex(mediaPlayer.currentDynamicStreamIndex + 1);

注意：如果暂停媒体，则在继续播放后才会发生切换。

参数

streamIndex:int

引发

	`RangeError` — 如果指定的动态流索引小于零或大于 `maxAllowedDynamicStreamIndex`。

	`IllegalOperationError` — 如果媒体不是动态流，或者动态流不在手动切换模式下。

相关 API 元素

maxAllowedDynamicStreamIndex

事件详细信息

bytesLoadedChange

事件

事件对象类型: org.osmf.events.LoadEvent
属性 LoadEvent.type = org.osmf.events.LoadEvent

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

在 bytesLoaded 的值发生变化时调度。

canBufferChange

事件

事件对象类型: org.osmf.events.MediaPlayerCapabilityChangeEvent
属性 MediaPlayerCapabilityChangeEvent.type = org.osmf.events.MediaPlayerCapabilityChangeEvent.CAN_BUFFER_CHANGE

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

在 canBuffer 属性发生变化时调度。

MediaPlayerCapabilityChangeEvent.CAN_BUFFER_CHANGE 常量为 canBufferChange 事件定义事件对象的 type 属性的值。

canLoadChange

事件

事件对象类型: org.osmf.events.MediaPlayerCapabilityChangeEvent
属性 MediaPlayerCapabilityChangeEvent.type = org.osmf.events.MediaPlayerCapabilityChangeEvent.CAN_LOAD_CHANGE

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

在 canLoad 属性发生变化时调度。

MediaPlayerCapabilityChangeEvent.CAN_LOAD_CHANGE 常量为 canLoadChange 事件定义事件对象的 type 属性的值。

canPlayChange

事件

事件对象类型: org.osmf.events.MediaPlayerCapabilityChangeEvent
属性 MediaPlayerCapabilityChangeEvent.type = org.osmf.events.MediaPlayerCapabilityChangeEvent.CAN_PLAY_CHANGE

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

在 canPlay 属性发生变化时调度。

MediaPlayerCapabilityChangeEvent.CAN_PLAY_CHANGE 常量为 canPlayChange 事件定义事件对象的 type 属性的值。

canSeekChange

事件

事件对象类型: org.osmf.events.MediaPlayerCapabilityChangeEvent
属性 MediaPlayerCapabilityChangeEvent.type = org.osmf.events.MediaPlayerCapabilityChangeEvent.CAN_SEEK_CHANGE

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

在 canSeek 属性发生变化时调度。

MediaPlayerCapabilityChangeEvent.CAN_SEEK_CHANGE 常量为 canSeekChange 事件定义事件对象的 type 属性的值。

currentTimeChange

事件

事件对象类型: org.osmf.events.TimeEvent
属性 TimeEvent.type = org.osmf.events.TimeEvent.CURRENT_TIME_CHANGE

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

在媒体的 currentTime 属性发生变化时调度。此值按 MediaPlayer 的 currentTimeUpdateInterval 属性设置的时间间隔更新。

TimeEvent.CURRENT_TIME_CHANGE 常量可为 currentTimeChange 事件定义事件对象的 type 属性的值。

hasAlternativeAudio

事件

事件对象类型: org.osmf.events.MediaPlayerCapabilityChangeEvent
属性 MediaPlayerCapabilityChangeEvent.type = org.osmf.events.MediaPlayerCapabilityChangeEvent.HAS_ALTERNATIVE_AUDIO_CHANGE

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.6

运行时版本:

Flash Player 10, AIR 1.5

在 hasAlternativeAudio 属性发生更改时调度。

此事件由 MediaPlayer 在其 hasAlternativeAudio 属性发生更改时调度。

hasAudioChange

事件

事件对象类型: org.osmf.events.MediaPlayerCapabilityChangeEvent
属性 MediaPlayerCapabilityChangeEvent.type = org.osmf.events.MediaPlayerCapabilityChangeEvent.HAS_AUDIO_CHANGE

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

在 hasAudio 属性发生变化时调度。

MediaPlayerCapabilityChangeEvent.HAS_AUDIO_CHANGE 常量为 hasAudioChange 事件定义事件对象的 type 属性的值。

hasDisplayObjectChange

事件

事件对象类型: org.osmf.events.MediaPlayerCapabilityChangeEvent
属性 MediaPlayerCapabilityChangeEvent.type = org.osmf.events.MediaPlayerCapabilityChangeEvent.HAS_DISPLAY_OBJECT_CHANGE

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

在 hasDisplayObjectChange 属性发生变化时调度。

MediaPlayerCapabilityChangeEvent.HAS_DISPLAY_OBJECT_CHANGE 常量为 hasDisplayObjectChange 事件定义事件对象的 type 属性的值。

hasDRMChange

事件

事件对象类型: org.osmf.events.MediaPlayerCapabilityChangeEvent
属性 MediaPlayerCapabilityChangeEvent.type = org.osmf.events.MediaPlayerCapabilityChangeEvent.HAS_DRM_CHANGE

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

在 hasDRM 属性发生变化时调度。

MediaPlayerCapabilityChangeEvent.HAS_DRM_CHANGE 常量为 hasDRMChange 事件定义事件对象的 type 属性的值。

isDynamicStreamChange

事件

事件对象类型: org.osmf.events.MediaPlayerCapabilityChangeEvent
属性 MediaPlayerCapabilityChangeEvent.type = org.osmf.events.MediaPlayerCapabilityChangeEvent.IS_DYNAMIC_STREAM_CHANGE

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

在 isDynamicStream 属性发生变化时调度。

MediaPlayerCapabilityChangeEvent.IS_DYNAMIC_STREAM_CHANGE 常量为 isDynamicStreamChange 事件定义事件对象的 type 属性的值。

liveResume

事件

事件对象类型: org.osmf.events.PlayEvent
属性 PlayEvent.type = org.osmf.events.PlayEvent.LIVE_RESUME

语言版本:

ActionScript 3.0

产品版本:

OSMF 2.0

运行时版本:

Flash Player 10, AIR 1.5

在实时停顿后恢复播放时调度

PlayEvent.LIVE_RESUME 常量为 liveResume 事件的事件对象定义 type 属性的值。

在实时停顿后恢复播放时调度

liveStall

事件

事件对象类型: org.osmf.events.PlayEvent
属性 PlayEvent.type = org.osmf.events.PlayEvent.LIVE_STALL

语言版本:

ActionScript 3.0

产品版本:

OSMF 2.0

运行时版本:

Flash Player 10, AIR 1.5

当播放用完实时流的内容而流还未完成时调度。

PlayEvent.LIVE_STALL 常量为 liveStall 事件的事件对象定义 type 属性的值。

当播放用完实时流的内容而流还未完成时调度。

mediaError

事件

事件对象类型: org.osmf.events.MediaErrorEvent
属性 MediaErrorEvent.type = org.osmf.events.MediaErrorEvent.MEDIA_ERROR

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

在发生影响媒体播放器运行的错误时调度。

MediaErrorEvent.MEDIA_ERROR 常量为 mediaError 事件定义事件对象的 type 属性的值。

mediaPlayerStateChange

事件

事件对象类型: org.osmf.events.MediaPlayerStateChangeEvent
属性 MediaPlayerStateChangeEvent.type = org.osmf.events.MediaPlayerStateChangeEvent.MEDIA_PLAYER_STATE_CHANGE

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

在 MediaPlayer 的状态发生变化时调度。

MediaPlayerStateChangeEvent.MEDIA_PLAYER_STATE_CHANGE 常量可为 mediaPlayerStateChange 事件定义事件对象的 type 属性的值。

temporalChange

事件

事件对象类型: org.osmf.events.MediaPlayerCapabilityChangeEvent
属性 MediaPlayerCapabilityChangeEvent.type = org.osmf.events.MediaPlayerCapabilityChangeEvent.TEMPORAL_CHANGE

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

在 temporal 属性发生变化时调度。

MediaPlayerCapabilityChangeEvent.TEMPORAL_CHANGE 常量为 temporalChange 事件定义事件对象的 type 属性的值。

示例如何使用本示例

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);
        }
    }
}

法律声明 | 在线隐私策略

MediaPlayer - AS3 OSMF

类 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