AlternativeAudioTrait

包	org.osmf.traits
类	public class AlternativeAudioTrait
继承	AlternativeAudioTrait MediaTraitBase EventDispatcher Object

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.6

运行时版本:

Flash Player 10, AIR 1.5

AlternativeAudioTrait 为支持替代音频流的媒体定义特征接口。它还可以用作更具体的 AlternativeAudioTrait 子类的基类。

使用 MediaElement.hasTrait(MediaTraitType.ALTERNATIVE_AUDIO) 方法查询媒体元素是否具有此类型的特征。如果 hasTrait(MediaTraitType.ALTERNATIVE_AUDIO) 返回 true，则使用 MediaElement.getTrait(MediaTraitType.ALTERNATIVE_AUDIO) 方法获取一个此类型的对象。

相关 API 元素

org.osmf.media.MediaElement

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		currentIndex : int [只读] 获取标识当前音频流的基于 0 的索引；如果未选定任何流，则获取索引 -1。	AlternativeAudioTrait
		numAlternativeAudioStreams : int [只读] 获取替代音频流的总数。	AlternativeAudioTrait
		switching : Boolean [只读] 指示替代音频流切换当前是否正在进行。	AlternativeAudioTrait
		traitType : String [只读] 此特征的 MediaTraitType。	MediaTraitBase

受保护的属性

	属性		由以下参数定义
		_indexToSwitchTo : int = -2	AlternativeAudioTrait

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		AlternativeAudioTrait(numAlternativeAudioStreams:int) 默认构造函数。	AlternativeAudioTrait
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。	EventDispatcher
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	EventDispatcher
		dispose():void 处理此特征使用的任何资源。	MediaTraitBase
		getItemForIndex(index:int):StreamingItem 返回指定索引的关联流项。	AlternativeAudioTrait
		hasEventListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	EventDispatcher
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 从 EventDispatcher 对象中删除侦听器。	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		switchTo(index:int):void 将当前音频流切换为由索引值指定的替代流。	AlternativeAudioTrait
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回指定对象的字符串表示形式。	Object
		valueOf():Object 返回指定对象的原始值。	Object
		willTrigger(type:String):Boolean 检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。	EventDispatcher

事件

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

隐藏继承的事件

显示继承的事件

	摘要	由以下参数定义
activate	[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。	EventDispatcher
audioSwitchingChange	在替代音频流切换已请求、完成或失败时调度。	AlternativeAudioTrait
deactivate	[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。	EventDispatcher
numAlternativeAudioStreamsChange	在替代音频流的总数发生更改时调度。	AlternativeAudioTrait

受保护的常量

	常量		由以下参数定义
		DEFAULT_TRANSITION_INDEX : int = -1 [静态]	AlternativeAudioTrait
		INVALID_TRANSITION_INDEX : int = -2 [静态]	AlternativeAudioTrait

属性详细信息

_indexToSwitchTo

属性

protected var _indexToSwitchTo:int = -2

currentIndex

属性

currentIndex:int [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.6

运行时版本:

Flash Player 10, AIR 1.5

获取标识当前音频流的基于 0 的索引；如果未选定任何流，则获取索引 -1。返回的值始终为 -1 和 numAlternativeAudioStreams-1。

实现
public function get currentIndex():int

numAlternativeAudioStreams

属性

numAlternativeAudioStreams:int [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.6

运行时版本:

Flash Player 10, AIR 1.5

获取替代音频流的总数。

实现
public function get numAlternativeAudioStreams():int

switching

属性

switching:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.6

运行时版本:

Flash Player 10, AIR 1.5

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

实现
public function get switching():Boolean

构造函数详细信息

()

构造函数

public function AlternativeAudioTrait(numAlternativeAudioStreams:int)

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.6

运行时版本:

Flash Player 10, AIR 1.5

默认构造函数。

参数

numAlternativeAudioStreams:int — 替代音频流的总数。

方法详细信息

getItemForIndex

()

方法

public function getItemForIndex(index:int):StreamingItem

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.6

运行时版本:

Flash Player 10, AIR 1.5

返回指定索引的关联流项。如果索引为 -1，则返回 null。

参数

index:int

StreamingItem

引发

RangeError — 如果指定索引小于 -1 或大于 (numAlternativeAudioStreams - 1)。

switchTo

()

方法

public function switchTo(index:int):void

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.6

运行时版本:

Flash Player 10, AIR 1.5

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

参数

index:int

引发

RangeError — 如果指定索引小于 -1 或大于 numAlternativeAudioStreams-1。

事件详细信息

audioSwitchingChange

事件

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

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.6

运行时版本:

Flash Player 10, AIR 1.5

在替代音频流切换已请求、完成或失败时调度。

替代音频流的切换状态发生更改时调度。通常，对于任何成功的切换操作，都会触发两个 AUDIO_SWITCHING_CHANGE 事件。切换操作开始时触发一个事件（switching 属性将设置为 true），操作结束时触发另一个事件（switching 属性将设置为 false）。

numAlternativeAudioStreamsChange

事件

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

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.6

运行时版本:

Flash Player 10, AIR 1.5

在替代音频流的总数发生更改时调度。

在可用的替代音频流数量发生更改时调度。

常量详细信息

DEFAULT_TRANSITION_INDEX

常量

protected static const DEFAULT_TRANSITION_INDEX:int = -1

INVALID_TRANSITION_INDEX

常量

protected static const INVALID_TRANSITION_INDEX:int = -2

法律声明 | 在线隐私策略

AlternativeAudioTrait - AS3 OSMF

类 x

_indexToSwitchTo

currentIndex

numAlternativeAudioStreams

switching