DynamicStreamTrait

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

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

DynamicStreamTrait 定义支持动态流切换的媒体的特征界面。它还可以用作更具体的 DynamicStreamTrait 子类的基类。

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

相关 API 元素

org.osmf.media.MediaElement

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		autoSwitch : Boolean 定义特征应为手动还是自动切换模式。	DynamicStreamTrait
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		currentIndex : int [只读] 当前动态流的索引。	DynamicStreamTrait
		maxAllowedIndex : int 允许的最大索引。	DynamicStreamTrait
		numDynamicStreams : int [只读] 动态流的总数。	DynamicStreamTrait
		switching : Boolean [只读] 指示当前是否正在进行切换。	DynamicStreamTrait
		traitType : String [只读] 此特征的 MediaTraitType。	MediaTraitBase

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		DynamicStreamTrait(autoSwitch:Boolean = true, currentIndex:int = 0, numDynamicStreams:int = 1) 构造函数。	DynamicStreamTrait
		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
		getBitrateForIndex(index:int):Number 返回指定索引的关联比特率（以 KB/秒为单位）。	DynamicStreamTrait
		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 切换到特定索引。	DynamicStreamTrait
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回指定对象的字符串表示形式。	Object
		valueOf():Object 返回指定对象的原始值。	Object
		willTrigger(type:String):Boolean 检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。	EventDispatcher

受保护的方法

	方法		由以下参数定义
		autoSwitchChangeEnd():void 在 autoSwitch 属性更改后立即调用。	DynamicStreamTrait
		autoSwitchChangeStart(value:Boolean):void 在 autoSwitch 属性更改的前一刻调用。	DynamicStreamTrait
		maxAllowedIndexChangeEnd():void 在 maxAllowedIndex 属性更改后立即调用。	DynamicStreamTrait
		maxAllowedIndexChangeStart(newIndex:int):void 在 maxAllowedIndex 属性更改的前一刻调用。	DynamicStreamTrait
		setCurrentIndex(value:int):void 调用此 setter 将导致特征的 currentIndex 属性更改。	DynamicStreamTrait
		setNumDynamicStreams(value:int):void 调用此 setter 将导致特征的 numDynamicStreams 属性更改。	DynamicStreamTrait
		setSwitching(newSwitching:Boolean, index:int):void 必须在完成切换时由实现媒体调用。	DynamicStreamTrait
		switchingChangeEnd(index:int):void 在 switching 属性更改后立即调用。	DynamicStreamTrait
		switchingChangeStart(newSwitching:Boolean, index:int):void 在 switching 属性更改的前一刻调用。	DynamicStreamTrait

事件

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

隐藏继承的事件

显示继承的事件

	摘要	由以下参数定义
activate	[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。	EventDispatcher
autoSwitchChange	在 autoSwitch 属性发生变化时调度。	DynamicStreamTrait
deactivate	[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。	EventDispatcher
numDynamicStreamsChange	在动态流的数量更改时调度。	DynamicStreamTrait
switchingChange	在请求、完成或未能完成流切换时调度。	DynamicStreamTrait

属性详细信息

autoSwitch

属性

autoSwitch:Boolean

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

定义特征应为手动还是自动切换模式。如果为手动模式，则可使用 switchTo 方法手动切换到特定流。

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

currentIndex

属性

currentIndex:int [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

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

实现
public function get currentIndex():int

maxAllowedIndex

属性

maxAllowedIndex:int

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

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

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

引发

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

numDynamicStreams

属性

numDynamicStreams:int [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

动态流的总数。

实现
public function get numDynamicStreams():int

switching

属性

switching:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

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

实现
public function get switching():Boolean

构造函数详细信息

()

构造函数

public function DynamicStreamTrait(autoSwitch:Boolean = true, currentIndex:int = 0, numDynamicStreams:int = 1)

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

构造函数。

参数

	`autoSwitch:Boolean` (default = `true`) — 特征的初始 autoSwitch 状态。默认值为 true。

	`currentIndex:int` (default = `0`) — 特征的初始流索引。默认值为零。

	`numDynamicStreams:int` (default = `1`) — 动态流的总数。

方法详细信息

autoSwitchChangeEnd

()

方法

protected function autoSwitchChangeEnd():void

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

在 autoSwitch 属性更改后立即调用。调度 change 事件。

进行覆盖的子类应调用此方法以调度 change 事件。

autoSwitchChangeStart

()

方法

protected function autoSwitchChangeStart(value:Boolean):void

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

在 autoSwitch 属性更改的前一刻调用。

子类可以覆盖此方法以将更改传送到媒体。

参数

value:Boolean — autoSwitch 属性的新值。

getBitrateForIndex

()

方法

public function getBitrateForIndex(index:int):Number

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

返回指定索引的关联比特率（以 KB/秒为单位）。

参数

index:int

Number

引发

RangeError — 如果指定索引小于零或大于最大可用索引。

maxAllowedIndexChangeEnd

()

方法

protected function maxAllowedIndexChangeEnd():void

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

在 maxAllowedIndex 属性更改后立即调用。

maxAllowedIndexChangeStart

()

方法

protected function maxAllowedIndexChangeStart(newIndex:int):void

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

在 maxAllowedIndex 属性更改的前一刻调用。

子类可以覆盖此方法以将更改传送到媒体。

参数

newIndex:int — maxAllowedIndex 属性的新值。

setCurrentIndex

()

方法

protected final function setCurrentIndex(value:int):void

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

调用此 setter 将导致特征的 currentIndex 属性更改。

参数

value:int

setNumDynamicStreams

()

方法

protected final function setNumDynamicStreams(value:int):void

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

调用此 setter 将导致特征的 numDynamicStreams 属性更改。

参数

value:int

setSwitching

()

方法

protected final function setSwitching(newSwitching:Boolean, index:int):void

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

必须在完成切换时由实现媒体调用。调用 switchingChangeStart() 和 switchingChangeEnd() 方法。

参数

	`newSwitching:Boolean` — 特征的新 `switching` 值。

	`index:int` — 应（或确实已经）发生切换的索引。

switchingChangeEnd

()

方法

protected function switchingChangeEnd(index:int):void

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

在 switching 属性更改后立即调用。调度 change 事件。

进行覆盖的子类应调用此方法以调度 change 事件。

参数

index:int — 已切换到的目标流的索引。

switchingChangeStart

()

方法

protected function switchingChangeStart(newSwitching:Boolean, index:int):void

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

在 switching 属性更改的前一刻调用。

子类可以覆盖此方法以将更改传送到媒体。

参数

	`newSwitching:Boolean` — `switching` 属性的新值。

	`index:int` — 要切换至的流的索引。

switchTo

()

方法

public function switchTo(index:int):void

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

切换到特定索引。要进行切换，请使用 currentIndex 属性，例如：

obj.switchTo(obj.currentIndex + 1);

参数

index:int

引发

	`RangeError` — 如果指定的索引小于零或大于 `maxAllowedIndex`。注意：如果暂停媒体，则在继续播放后才会发生切换。

	`IllegalOperationError` — 如果流未处于手动切换模式。

autoSwitchChange

事件

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

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

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

DynamicStreamEvent.AUTO_SWITCH_CHANGE 常量为 autoSwitchChange 事件定义事件对象的 type 属性的值。

numDynamicStreamsChange

事件

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

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

在动态流的数量更改时调度。

DynamicStreamEvent.NUM_DYNAMIC_STREAMS_CHANGE 常量为 numDynamicStreamsChange 事件定义事件对象的 type 属性的值。

switchingChange

事件

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

语言版本:

ActionScript 3.0

产品版本:

OSMF 1.0

运行时版本:

Flash Player 10, AIR 1.5

在请求、完成或未能完成流切换时调度。

DynamicStreamEvent.SWITCHING_CHANGE 常量为 switchingChange 事件定义事件对象的 type 属性的值。

法律声明 | 在线隐私策略

DynamicStreamTrait - AS3 OSMF

类 x

autoSwitch

currentIndex

maxAllowedIndex

numDynamicStreams

switching