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 — 要调度的 error 事件。

事件详细信息

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