MediaPromise - Adobe ActionScript® 3（AS3 ）API リファレンス

パッケージ	flash.media
クラス	public class MediaPromise
継承	MediaPromise EventDispatcher Object
実装	IFilePromise

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.5

MediaPromise クラスは、メディアオブジェクトを配信するプロミスを示します。

MediaEvent オブジェクトの data プロパティは MediaPromise インスタンスです。MediaPromise メソッドを使用して、プロミス済みメディアオブジェクトにアクセスできます。ただし、サポートされるメディアフォーマットには画像とビデオが含まれます。

MediaPromise オブジェクトを作成できません。new MediaPromise() を呼び出すとランタイムエラーが発生します。

パブリックプロパティ

継承されるパブリックプロパティを隠す

継承されるパブリックプロパティを表示

	プロパティ		定義元
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		file : File [読み取り専用] メディアオブジェクトを示す File インスタンス（存在する場合）。	MediaPromise
		isAsync : Boolean [読み取り専用] 基礎となるデータソースが非同期か同期しているかをレポートします。	MediaPromise
		mediaType : String [読み取り専用] メディアの一般的なタイプ（画像またはビデオ）。	MediaPromise
		relativePath : String [読み取り専用] メディアオブジェクトのファイル名（存在する場合）。	MediaPromise

パブリックメソッド

継承されるパブリックメソッドを隠す

継承されるパブリックメソッドを表示

	メソッド		定義元
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		close():void データソースを閉じます。	MediaPromise
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		open():IDataInput 基礎となるデータソースを開くと、IDataInput インスタンスが読み取り可能になります。	MediaPromise
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	EventDispatcher
		reportError(e:ErrorEvent):void エラーをレポートするためにランタイムで使用されます。	MediaPromise
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

イベント

イベントの詳細についてはここをクリックしてください

継承されるイベントを隠す

継承されるイベントを表示

	概要	定義元
activate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
close	基礎となるデータストリームが閉じられると、MediaPromise オブジェクトは close イベントを送出します。	MediaPromise
complete	MediaPromise オブジェクトは、すべてのデータが読み込まれたときに、complete イベントを送出します。	MediaPromise
deactivate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher
ioError	基礎となるデータストリームを読み取るときにエラーが発生する場合、MediaPromise オブジェクトは ioError イベントを送出します。	MediaPromise
progress	データが使用できるようになると、MediaPromise オブジェクトは progress イベントを送出します。	MediaPromise

プロパティの詳細

file

プロパティ

file:File [読み取り専用]

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.5

メディアオブジェクトを示す File インスタンス（存在する場合）。

基礎となるデータソースがファイルベースで、ファイルからアプリケーションにアクセス可能な場合、このプロパティは File オブジェクトを表します。それ以外の場合、プロパティは null です。

実装
public function get file():File

isAsync

プロパティ

isAsync:Boolean [読み取り専用]

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.5

基礎となるデータソースが非同期か同期しているかをレポートします。

実装
public function get isAsync():Boolean

mediaType

プロパティ

mediaType:String [読み取り専用]

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.5

メディアの一般的なタイプ（画像またはビデオ）。

MediaType クラスの定数で、このプロパティに指定できる値を定義します。

MediaType.IMAGE
MediaType.VIDEO

実装
public function get mediaType():String

relativePath

プロパティ

relativePath:String [読み取り専用]

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.5

メディアオブジェクトのファイル名（存在する場合）。

ファイル名を使用できるのは、基礎となるデータソースがファイルベースで、ファイルからアプリケーションにアクセス可能な場合です。それ以外の場合、プロパティは null です。

実装
public function get relativePath():String

メソッドの詳細

close

()

メソッド

public function close():void

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.5

データソースを閉じます。

open

()

メソッド

public function open():IDataInput

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.5

基礎となるデータソースを開くと、IDataInput インスタンスが読み取り可能になります。

基礎となるデータソースが非同期の場合、MediaPromise オブジェクトは progress および complete イベントを送出し、データが読み取り可能かどうかを示します。データソースが同期している場合、すべてのデータは即時に使用可能なので、これらのイベントは送出されません。

注意：データを手動で読み取る代わりに、Loader クラスの loadFilePromise() メソッドを使用して、MediaPromise オブジェクトを読み込むことができます。

戻り値

IDataInput

reportError

()

メソッド

public function reportError(e:ErrorEvent):void

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.5

エラーをレポートするためにランタイムで使用されます。

アプリケーションコードでこのメソッドを呼び出さないでください。

パラメーター

e:ErrorEvent — 送出するエラーイベント。

イベントの詳細

close

イベント

イベントオブジェクトの型: flash.events.Event
プロパティ Event.type = flash.events.Event.CLOSE

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.5

基礎となるデータストリームが閉じられると、MediaPromise オブジェクトは close イベントを送出します。

Event.CLOSE 定数は、type プロパティ（close イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	`false`
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`target`	接続が閉じられたオブジェクトです。

complete

イベント

イベントオブジェクトの型: flash.events.Event
プロパティ Event.type = flash.events.Event.COMPLETE

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.5

MediaPromise オブジェクトは、すべてのデータが読み込まれたときに、complete イベントを送出します。このイベントは、基礎となるストリームで使用できるデータがなくなったことを示します。

complete イベントは、同期データソースから送出されません。

Event.COMPLETE 定数は、type プロパティ（complete イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	`false`
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`target`	読み込みが完了したネットワークオブジェクトです。

ioError

イベント

イベントオブジェクトの型: flash.events.IOErrorEvent
プロパティ IOErrorEvent.type = flash.events.IOErrorEvent.IOERROR

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.5

基礎となるデータストリームを読み取るときにエラーが発生する場合、MediaPromise オブジェクトは ioError イベントを送出します。このイベントの送出後は、データを読み取ることはできません。

progress

イベント

イベントオブジェクトの型: flash.events.ProgressEvent
プロパティ ProgressEvent.type = flash.events.ProgressEvent.PROGRESS

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.5

データが使用できるようになると、MediaPromise オブジェクトは progress イベントを送出します。

最後を除くすべての progress イベントの bytesTotal プロパティ値は 0 です。すべてのデータを即時に使用できる場合、progress イベントは送出されません。同期データソースから progress イベントは送出されません。

type プロパティ（progress イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	`false`
`bytesLoaded`	リスナーがイベントを処理しているときに読み込まれたアイテム数またはバイト数です。
`bytesTotal`	読み込みプロセスが成功した場合に最終的に読み込まれるアイテムまたはバイトの総数です。
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`target`	進行状況をレポートするオブジェクトです。

法律上の注意 | プライバシーポリシー

MediaPromise - AS3

クラス x

file

isAsync

mediaType

relativePath

close

open

reportError

close

complete

ioError

progress