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 現在のオーディオストリームを index の値によって指定された代替ストリームに切り替えます。	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 の値によって指定された代替ストリームに切り替えます。 index の値として -1 を渡すと、現在のオーディオストリームがデフォルトのオーディオストリームにリセットされます。 メモ：メディアの再生が現在一時停止中の場合は、再生が再開されるまで、オーディオストリームの切り替えは行われません。

パラメーター

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

代替オーディオストリームの切り替えが、要求された場合、完了した場合、または失敗した場合に送出されます。

代替オーディオストリームの切り替え状態が変更されたときに送出されます。通常は、切り替え操作が成功すると、2 つの AUDIO_SWITCHING_CHANGE イベントがトリガーされます。切り替え処理が開始される（switching プロパティが true に設定される）ときに 1 つ、および操作が終了する（switching プロパティが false に設定される）ときに 1 つです。

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