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

相關 API 元素

MediaType

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

相關 API 元素

Loader.loadFilePromise()

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 常數會定義 close 事件物件的 type 屬性值。

這個事件具有下列屬性：

屬性	值
`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 常數會定義 complete 事件物件的 type 屬性值。

這個事件具有下列屬性：

屬性	值
`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 事件。

定義 progress 事件物件的 type 屬性值。

這個事件具有下列屬性：

屬性	值
`bubbles`	`false`
`bytesLoaded`	在偵聽程式處理事件時，載入的項目或位元組數目。
`bytesTotal`	如果載入程序成功時，最終將載入的項目或位元組總數。
`cancelable`	`false`；沒有要取消的預設行為指令。
`currentTarget`	正主動使用事件偵聽程式處理 Event 物件的物件。
`target`	回報進度的物件。

法律聲明 | 線上隱私權政策

MediaPromise - AS3

類別 x

file

isAsync

mediaType

relativePath

close

open

reportError

close

complete

ioError

progress