包 | flash.media |
类 | public class Sound |
继承 | Sound EventDispatcher Object |
子类 | SoundAsset |
语言版本: | ActionScript 3.0 |
运行时版本: | AIR 1.0, Flash Player 9, Flash Lite 4 |
在 Flash Player 10 及更高版本和 AIR 1.5 及更高版本中,也可以使用此类来处理动态生成的声音。在这种情况下,Sound 对象将使用向 sampleData
事件处理函数分配的函数来轮询声音数据。从用声音数据填充的 ByteArray 对象检索声音的同时播放声音。可以使用 Sound.extract()
从 Sound 对象中提取声音数据,然后在将声音数据写回到流以进行播放之前可以对其进行操作。
要控制嵌入到 SWF 文件的声音,请使用 SoundMixer 类中的属性。
注意:ActionScript 3.0 的 Sound API 与 ActionScript 2.0 不同。在 ActionScript 3.0 中,将无法采用声音对象并在层次结构中对其进行排列以控制其属性。
在使用此类时,请考虑以下安全模型:
- 如果执行调用的 文件在网络沙箱中,并且要加载的声音文件是本地文件,则不允许加载和播放声音。
- 默认情况下,若执行调用的文件是本地文件并且试图加载和播放远程声音,则不允许加载和播放声音。用户必须授予明确许可才能允许此类访问。
- 某些处理声音的操作受到限制。除非您实现了一个跨域策略文件,否则处于其它域的 文件无法访问已加载声音中的数据。受此限制约束的与声音相关的 API 为
Sound.id3
、SoundMixer.computeSpectrum()
、SoundMixer.bufferTime
和SoundTransform
类。
但在 Adobe AIR 中,application
安全沙箱中的内容(使用 AIR 应用程序安装的内容)不受这些安全限制的约束。
有关安全性的详细信息,请参阅 Flash Player 开发人员中心主题:安全性。
相关 API 元素
属性 | 由以下参数定义 | ||
---|---|---|---|
bytesLoaded : uint [只读]
返回此声音对象中当前可用的字节数。 | Sound | ||
bytesTotal : int [只读]
返回此声音对象中总的字节数。 | Sound | ||
constructor : Object
对类对象或给定对象实例的构造函数的引用。 | Object | ||
id3 : ID3Info [只读]
提供对作为 MP3 文件一部分的元数据的访问。 | Sound | ||
isBuffering : Boolean [只读]
返回外部 MP3 文件的缓冲状态。 | Sound | ||
isURLInaccessible : Boolean [只读]
表示 Sound.url 属性是否已截断。 | Sound | ||
length : Number [只读]
当前声音的长度(以毫秒为单位)。 | Sound | ||
url : String [只读]
从中加载此声音的 URL。 | Sound |
方法 | 由以下参数定义 | ||
---|---|---|---|
创建一个新的 Sound 对象。 | Sound | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
使用 EventDispatcher 对象注册事件侦听器对象,以使侦听器能够接收事件通知。 | EventDispatcher | ||
关闭该流,从而停止所有数据的下载。 | Sound | ||
将事件调度到事件流中。 | EventDispatcher | ||
从 Sound 对象提取原始声音数据。 | Sound | ||
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。 | EventDispatcher | ||
表示对象是否已经定义了指定的属性。 | Object | ||
表示 Object 类的实例是否在指定为参数的对象的原型链中。 | Object | ||
启动从指定 URL 加载外部 MP3 文件的过程。 | Sound | ||
将 ByteArray 对象中的 MP3 声音数据加载到 Sound 对象中。 | Sound | ||
loadPCMFromByteArray(bytes:ByteArray, samples:uint, format:String = "float", stereo:Boolean = true, sampleRate:Number = 44100.0):void
将 ByteArray 对象中的 PCM 32 位浮点声音数据加载到 Sound 对象中。 | Sound | ||
play(startTime:Number = 0, loops:int = 0, sndTransform:flash.media:SoundTransform = null):SoundChannel
生成一个新的 SoundChannel 对象来播放该声音。 | Sound | ||
表示指定的属性是否存在、是否可枚举。 | Object | ||
从 EventDispatcher 对象中删除侦听器。 | EventDispatcher | ||
设置循环操作动态属性的可用性。 | Object | ||
返回此对象的字符串表示形式,其格式设置遵守区域设置特定的约定。 | Object | ||
返回指定对象的字符串表示形式。 | Object | ||
返回指定对象的原始值。 | Object | ||
检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。 | EventDispatcher |
事件 | 摘要 | 由以下参数定义 | ||
---|---|---|---|---|
[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。 | EventDispatcher | |||
成功加载数据后调度。 | Sound | |||
[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。 | EventDispatcher | |||
在存在可用于 MP3 声音的 ID3 数据时由 Sound 对象调度。 | Sound | |||
在出现输入/输出错误并由此导致加载操作失败时调度。 | Sound | |||
在加载操作开始时调度。 | Sound | |||
在加载操作进行过程中接收到数据时调度。 | Sound | |||
在运行时请求新音频数据时调度。 | Sound |
bytesLoaded | 属性 |
bytesTotal | 属性 |
id3 | 属性 |
id3:ID3Info
[只读] 语言版本: | ActionScript 3.0 |
运行时版本: | AIR 1.0, Flash Player 9, Flash Lite 4 |
提供对作为 MP3 文件一部分的元数据的访问。
MP3 声音文件可以包含 ID3 标签,ID3 标签提供有关该文件的元数据。如果使用 Sound.load()
方法加载的 MP3 声音包含 ID3 标签,则可以查询这些属性。只支持使用 UTF-8 字符集的 ID3 标签。
Flash Player 9 和更高版本以及 AIR 支持 ID3 2.0 标签,特别是 2.3 和 2.4 标签。下表列出了标准 ID3 2.0 标签以及该标签所表示的内容类型。Sound.id3
属性通过 my_sound.id3.COMM
和 my_sound.id3.TIME
等格式提供对这些标记的访问权限。第一个表描述了可通过 ID3 2.0 属性名称或 ActionScript 属性名称进行访问的标签。第二个表描述了在 ActionScript 中受支持但不具有预定义属性的 ID3 标签。
ID3 2.0 标签 | 相应的 Sound 类属性 |
COMM | Sound.id3.comment |
TALB | Sound.id3.album |
TCON | Sound.id3.genre |
TIT2 | Sound.id3.songName |
TPE1 | Sound.id3.artist |
TRCK | Sound.id3.track |
TYER | Sound.id3.year |
下表描述了在 Sound 类中受支持但不具有预定义属性的 ID3 标签。通过调用 mySound.id3.TFLT
和 mySound.id3.TIME
等来访问它们。注意:Flash Lite 4 不支持上述任何标签。
属性 | 描述 |
TFLT | 文件类型 |
TIME | 时间 |
TIT1 | 内容组说明 |
TIT2 | 标题/歌曲名称/内容说明 |
TIT3 | 副标题/说明精选 |
TKEY | 初始密钥 |
TLAN | 语言 |
TLEN | 长度 |
TMED | 媒体类型 |
TOAL | 原始唱片/影片/演出标题 |
TOFN | 原始文件名 |
TOLY | 原词作者/乐谱作者 |
TOPE | 原始艺术家/表演者 |
TORY | 原始发行年份 |
TOWN | 文件所有者/获得授权者 |
TPE1 | 主要表演者/独奏(独唱) |
TPE2 | 乐队/管弦乐队/伴奏 |
TPE3 | 指挥/主要演奏者 |
TPE4 | 翻译、混录员或以其它方式进行修改的人员 |
TPOS | 歌曲集部分 |
TPUB | 发行者 |
TRCK | 歌曲集中的曲目编号/位置 |
TRDA | 录制日期 |
TRSN | Internet 无线电台名称 |
TRSO | Internet 无线电台所有者 |
TSIZ | 大小 |
TSRC | ISRC(国际标准音像制品编码) |
TSSE | 用于编码的软件/硬件和设置 |
TYER | 年份 |
WXXX | URL 链接帧 |
使用此属性时,请考虑 Flash Player 安全模型:
- 对于与声音文件位于同一安全沙箱的 SWF 文件,始终允许 Sound 对象的
id3
属性。对于其它沙箱中的文件,则需经过安全检查。 - 使用 Sound 类的
load()
方法加载声音时,可指定context
参数,该参数为一个 SoundLoaderContext 对象。如果将 SoundLoaderContext 对象的checkPolicyFile
属性设为true
,则 Flash Player 将在从其中加载声音的服务器上查找 URL 策略文件。如果存在一个策略文件并且允许从执行加载的 SWF 文件的域进行访问,则允许该文件访问 Sound 对象的id3
属性;否则将不允许。
但在 Adobe AIR 中,application
安全沙箱中的内容(使用 AIR 应用程序安装的内容)不受这些安全限制的约束。
有关安全性的详细信息,请参阅 Flash Player 开发人员中心主题:安全性。
实现
public function get id3():ID3Info
相关 API 元素
示例 ( 如何使用本示例 )
在构造函数中,加载了声音文件,但没有将其设置为播放。此处,假定该文件位于 SWF 目录中。系统必须具有权限,才能读取加载的声音文件的 ID3 标签。如果该文件中包含 ID3 信息并允许程序读取该信息,将触发一个 Event.ID3
事件,并填充声音文件的 id3
属性。id3
属性包含一个 ID3Info
对象,其中包含所有 ID3 信息。
在 id3Handler()
方法中,将该文件的 ID3 标签存储在 ID3Info 类对象 id3
中。将实例化一个文本字段以显示 ID3 标签列表。for 循环将循环访问所有 ID3 2.0 标签,并将名称和值附加到文本字段的内容中。通过使用 ID3 信息 (ID3Info
) 属性,还可以附加歌手、歌曲名称和专辑。ActionScript 3.0 和 Flash Player 9 及更高版本支持 ID3 2.0 标签,特别是 2.3 和 2.4。如果循环访问属性(像在 for 循环中一样),则仅显示 ID3 2.0 标签。但是,来自早期版本的数据也会存储在歌曲的 id3
属性中,可通过使用 ID3 信息类属性对其进行访问。ID3 1.0 的标签位于文件结尾;而 ID3 2.0 标签位于文件开头。(有时,文件可能在相同位置包含早期版本和较新版本的标签。)如果编码的文件开头和结尾分别包含 1.0 版和 2.0 版标签,将调用两次 id3Handler()
方法。它先读取 2.0 版标签,然后再读取 1.0 版标签。如果只有 ID3 1.0 标签可用,可通过 ID3 信息属性访问该信息,如 id3.songname
。对于 ID3 2.0,id3.TITS
属性将使用新标签 (TITS) 来检索歌曲名称。
请注意,没有为本示例编写错误处理代码,如果 ID3 内容很长,结果可能会超出可查看区域。
package { import flash.display.Sprite; import flash.media.Sound; import flash.net.URLRequest; import flash.media.ID3Info; import flash.text.TextField; import flash.text.TextFieldAutoSize; import flash.events.Event; public class Sound_id3Example extends Sprite { private var snd:Sound = new Sound(); private var myTextField:TextField = new TextField(); public function Sound_id3Example() { snd.addEventListener(Event.ID3, id3Handler); snd.load(new URLRequest("mySound.mp3")); } private function id3Handler(event:Event):void { var id3:ID3Info = snd.id3; myTextField.autoSize = TextFieldAutoSize.LEFT; myTextField.border = true; myTextField.appendText("Received ID3 Info: \n"); for (var propName:String in id3) { myTextField.appendText(propName + " = " + id3[propName] + "\n"); } myTextField.appendText("\n" + "Artist: " + id3.artist + "\n"); myTextField.appendText("Song name: " + id3.songName + "\n"); myTextField.appendText("Album: " + id3.album + "\n\n"); this.addChild(myTextField); } } }
isBuffering | 属性 |
isURLInaccessible | 属性 |
isURLInaccessible:Boolean
[只读] 语言版本: | ActionScript 3.0 |
运行时版本: | Flash Player 10.1, AIR 2 |
表示 Sound.url
属性是否已截断。当 isURLInaccessible
值为 true
时,Sound.url
值只是从其中加载声音的最终 URL 的域。例如,如果从 http://www.adobe.com/assets/hello.mp3
加载声音且 Sound.url
属性的值为 http://www.adobe.com
,则该属性会被截断。仅当下列所有值也全部为 true 时,isURLInaccessible
值才为 true
:
- 加载声音文件时发生 HTTP 重定向。
- 调用
Sound.load()
的 SWF 文件与声音文件的最终 URL 来自不同的域。 - 调用
Sound.load()
的 SWF 文件无权访问该声音文件。授予访问声音文件的权限的方式与为Sound.id3
属性授予权限的方式相同:建立一个策略文件,然后使用SoundLoaderContext.checkPolicyFile
属性。
注意:isURLInaccessible
属性是为 Flash Player 10.1 和 AIR 2.0 添加的。但是,如果 Flash 运行时支持该属性,则该属性适用于所有版本的 SWF 文件。因此,在“严谨模式”下使用某些创作工具会导致出现编译错误。要避免出现此错误,请使用间接语法 mySound["isURLInaccessible"]
或禁用严格模式。如果您使用的是 Flash Professional CS5 或 Flex SDK 4.1,则可以对在 Flash Player 10.1 和 AIR 2 之前发布的运行时使用和编译此 API。
对于 AIR 中的应用程序内容,该属性的值始终为 false
。
实现
public function get isURLInaccessible():Boolean
相关 API 元素
length | 属性 |
url | 属性 |
url:String
[只读] 语言版本: | ActionScript 3.0 |
运行时版本: | AIR 1.0, Flash Player 9, Flash Lite 4 |
从中加载此声音的 URL。此属性只适用于使用 Sound.load()
方法加载的 Sound 对象。对于与 SWF 文件库中的声音资源关联的 Sound 对象,url
属性的值为 null
。
首次调用 Sound.load()
时,url
属性最初具有 null
值,因为最终 URL 未知。只要从 Sound 对象中调度了 open
事件,url
属性就会具有非空值。
url
属性包含已从其中加载了声音的最终、绝对 URL。url
的值通常与传递给 Sound.load()
的 stream
参数的值相同。但是,如果已将一个相对 URL 传递给 Sound.load()
,则 url
属性的值将表示绝对 URL。此外,如果 HTTP 服务器重定向原始 URL 请求,url
属性的值将反映从其中实际下载声音文件的最终 URL。这种报告绝对、最终 URL 的行为与 LoaderInfo.url
的行为等效。
在某些情况下,url
属性的值会被截断;有关详细信息,请参阅 isURLInaccessible
属性。
实现
public function get url():String
相关 API 元素
Sound | () | 构造函数 |
public function Sound(stream:URLRequest = null, context:SoundLoaderContext = null)
语言版本: | ActionScript 3.0 |
运行时版本: | AIR 1.0, Flash Player 9, Flash Lite 4 |
创建一个新的 Sound 对象。如果将有效的 URLRequest 对象传递到 Sound 构造函数,该构造函数将自动调用 Sound 对象的 load()
函数。如果未将有效的 URLRequest 对象传递到 Sound 构造函数,则必须自己调用 Sound 对象的 load()
函数,否则将不加载流。
一旦对某个 Sound 对象调用了 load()
,就不能再将另一个声音文件加载到该 Sound 对象中。要加载另一个声音文件,请创建新的 Sound 对象。
sampleData
事件处理函数将声音动态加载到 Sound 对象中,而不是使用 load()
。
参数 stream:URLRequest (default = null ) — 指向外部 MP3 文件的 URL。
| |
context:SoundLoaderContext (default = null ) — 一个可选的 SoundLoader 上下文对象,可以定义缓冲时间(MP3 数据保留到 Sound 对象的缓冲区中所需的最小毫秒数)并且可以指定加载声音前应用程序是否应该检查跨域策略文件。
|
close | () | 方法 |
public function close():void
语言版本: | ActionScript 3.0 |
运行时版本: | AIR 1.0, Flash Player 9, Flash Lite 4 |
关闭该流,从而停止所有数据的下载。调用 close()
方法之后,将无法从流中读取数据。
引发
IOError — 无法关闭该流,或者该流未打开。
|
示例 ( 如何使用本示例 )
Sound.close()
方法并停止声音流。
在构造函数中,为 Start 和 Stop 按钮创建了一个文本字段。当用户单击文本字段时,将调用 clickHandler()
方法。它处理声音文件的启动和停止操作。请注意,根据网络连接情况或用户单击 Stop 按钮的时间,可能已加载了大部分文件,并且可能需要经过一段时间后才能停止播放声音文件。try...catch
块用于捕获在关闭流时可能发生的任何 IO 错误。例如,如果从本地目录中加载声音而没有进行流式传输,则会捕获到错误 2029,指出“此 URLStream 对象没有打开的流”。
package { import flash.display.Sprite; import flash.net.URLRequest; import flash.media.Sound; import flash.text.TextField; import flash.text.TextFieldAutoSize; import flash.events.MouseEvent; import flash.errors.IOError; import flash.events.IOErrorEvent; public class Sound_closeExample extends Sprite { private var snd:Sound = new Sound(); private var button:TextField = new TextField(); private var req:URLRequest = new URLRequest("http://av.adobe.com/podcast/csbu_dev_podcast_epi_2.mp3"); public function Sound_closeExample() { button.x = 10; button.y = 10; button.text = "START"; button.border = true; button.background = true; button.selectable = false; button.autoSize = TextFieldAutoSize.LEFT; button.addEventListener(MouseEvent.CLICK, clickHandler); this.addChild(button); } private function clickHandler(e:MouseEvent):void { if(button.text == "START") { snd.load(req); snd.play(); snd.addEventListener(IOErrorEvent.IO_ERROR, errorHandler); button.text = "STOP"; } else if(button.text == "STOP") { try { snd.close(); button.text = "Wait for loaded stream to finish."; } catch (error:IOError) { button.text = "Couldn't close stream " + error.message; } } } private function errorHandler(event:IOErrorEvent):void { button.text = "Couldn't load the file " + event.text; } } }
extract | () | 方法 |
public function extract(target:ByteArray, length:Number, startPosition:Number = -1):Number
语言版本: | ActionScript 3.0 |
运行时版本: | Flash Player 10, AIR 1.5 |
从 Sound 对象提取原始声音数据。
当您通过将分配给 sampleData
事件的函数用于不同的 Sound 对象,从而使用动态生成的音频时,可以使用此方法。即,您可以使用此方法从 Sound 对象中提取声音数据。然后,可以将此数据写入另一 Sound 对象用于对动态音频进行流式处理的字节数组。
将音频数据放在目标字节数组中(从该字节数组的当前位置开始)。音频数据始终公开为 44100 Hz 立体声。样本类型是一个 32 位浮点值,可以使用 ByteArray.readFloat()
将该值转换为一个数字。
参数
target:ByteArray — 用于放置提取的声音样本的 ByteArray 对象。
| |
length:Number — 要提取的声音样本数。样本包含左声道和右声道,即 2 个 32 位浮点值。
| |
startPosition:Number (default = -1 ) — 开始提取处的样本。如果未指定值,则对 Sound.extract() 的第一个调用将在声音的开头启动;未指定 startPosition 值的后续调用将按顺序通过该文件。
|
Number — 在 target 参数中指定的 ByteArray 中写入的范例数量。
|
相关 API 元素
示例 ( 如何使用本示例 )
extract()
方法来访问音频数据。
此 mp3 数据将加载到 sourceSnd
Sound 对象中。当应用程序加载 mp3 数据时,它将调用 loaded()
函数(sourceSnd
对象的 complete
事件的事件处理函数)。第二个 Sound 对象 outputSound
用于播放修改后的音频。outputSound
对象具有一个 sampleData
事件侦听器;这样,一旦您调用该对象的 play()
方法,该对象将调度定期的 sampleData
事件。upOctave()
方法将返回一个基于源音频数据的修改后的音频数据的字节数组。该方法通过间隔跳过源数据中的音频采样,返回高一个八度的音频。sampleData
事件的事件处理函数将返回的字节数组写入到 outputSound
对象的 data
属性中。将 data
字节数组追加到 outputSound
对象的输出音频数据中。
要测试此示例,请将 test.mp3 文件添加到 SWF 文件所在的同一目录中。
var sourceSnd:Sound = new Sound(); var outputSnd:Sound = new Sound(); var urlReq:URLRequest = new URLRequest("test.mp3"); sourceSnd.load(urlReq); sourceSnd.addEventListener(Event.COMPLETE, loaded); function loaded(event:Event):void { outputSnd.addEventListener(SampleDataEvent.SAMPLE_DATA, processSound); outputSnd.play(); } function processSound(event:SampleDataEvent):void { var bytes:ByteArray = new ByteArray(); sourceSnd.extract(bytes, 4096); event.data.writeBytes(upOctave(bytes)); } function upOctave(bytes:ByteArray):ByteArray { var returnBytes:ByteArray = new ByteArray(); bytes.position = 0; while(bytes.bytesAvailable > 0) { returnBytes.writeFloat(bytes.readFloat()); returnBytes.writeFloat(bytes.readFloat()); if (bytes.bytesAvailable > 0) { bytes.position += 8; } } return returnBytes; }
load | () | 方法 |
public function load(stream:URLRequest, context:SoundLoaderContext = null):void
语言版本: | ActionScript 3.0 |
运行时版本: | AIR 1.0, Flash Player 9, Flash Lite 4 |
启动从指定 URL 加载外部 MP3 文件的过程。如果为 Sound 构造函数提供有效的 URLRequest 对象,该构造函数将为您调用 Sound.load()
。只有在未将有效的 URLRequest 对象传递到 Sound 构造函数或传递了 null
值的情况下,才需要自己调用 Sound.load()
。
一旦对某个 Sound 对象调用了 load()
,就不能再将另一个声音文件加载到该 Sound 对象中。要加载另一个声音文件,请创建新的 Sound 对象。
在使用此方法时,请考虑以下安全模型:
- 如果执行调用的 文件在只能与本地文件系统的内容交互的沙箱中,并且声音在网络沙箱中,则不允许调用
Sound.load()
。 - 从受信任的本地沙箱或只能与远程内容交互的沙箱进行访问需要通过 URL 策略文件获得网站的许可。
- 无法连接到常用的保留端口。有关已阻止的端口的完整列表,请参阅《ActionScript 3.0 开发人员指南》中的“限制网络 API”。
- 可以在包含 SWF 内容的 HTML 页中设置
object
和embed
标签的allowNetworking
参数,从而防止 SWF 文件使用此方法。
在 Flash Player 10 和更高版本中,如果使用包含上载(由 POST 体内的“content-disposition”标头中的“filename”参数表示)的 multipart Content-Type(例如“multipart/form-data”),则 POST 操作会受应用于上载的安全规则的约束:
- 必须执行 POST 操作以响应用户启动的操作(如鼠标单击或按键)。
- 如果 POST 操作是跨域的(POST 目标与发送 POST 请求的 SWF 文件不在同一台服务器上),则目标服务器必须提供一个允许跨域访问的 URL 策略文件。
另外,对于任何 multipart Content-Type,语法必须有效(根据 RFC2046 标准)。如果语法无效,则 POST 操作受应用于上载的安全规则约束。
在 Adobe AIR 中,application
安全沙箱中的内容(使用 AIR 应用程序安装的内容)不受这些安全限制的约束。
有关安全性的详细信息,请参阅 Flash Player 开发人员中心主题:安全性。
参数
stream:URLRequest — 指向外部 MP3 文件的 URL。
| |
context:SoundLoaderContext (default = null ) — 一个可选的 SoundLoader 上下文对象,可以定义缓冲时间(MP3 数据保留到 Sound 对象的缓冲区中所需的最小毫秒数)并且可以指定加载声音前应用程序是否应该检查跨域策略文件。
|
引发
IOError — 网络错误导致加载失败。
| |
SecurityError — 本地不受信任的 文件可能无法与 Internet 进行通信。可通过将此文件重新分类为只能与远程内容交互或受信任来解决此问题。
| |
SecurityError — 无法连接到常用的保留端口。有关已阻止的端口的完整列表,请参阅《ActionScript 3.0 开发人员指南》中的“限制网络 API”。
| |
IOError — stream 对象的 digest 属性不是 null 。如果在加载 SWZ 文件(一个 Adobe 平台组件)时调用 URLLoader.load() 方法,仅应设置 URLRequest 对象的 digest 属性。
|
示例 ( 如何使用本示例 )
在构造函数中,创建了一个 URLRequest
对象以确定声音文件(来自 Adobe 的播客)的位置。将在 try...catch
块中加载该文件,以便捕获在加载文件时可能发生的任何错误。如果发生 IO 错误,还会调用 errorHandler()
方法,并在用于显示进度报告的文本字段中写入错误消息。当加载操作正在进行时,将调度 ProgressEvent.PROGRESS
事件并调用 progressHandler()
方法。此处,使用 ProgressEvent.PROGRESS
事件作为计时器来计算加载进度。
progressHandler()
方法将随 ProgressEvent
对象传递的 bytesLoaded
值除以 bytesTotal
值,以得出正在加载的声音数据的百分比。然后,它在文本字段中显示这些值。(请注意,如果文件很小、已缓存或位于本地目录中,则进度可能不太明显。)
package { import flash.display.Sprite; import flash.net.URLRequest; import flash.media.Sound; import flash.text.TextField; import flash.text.TextFieldAutoSize; import flash.events.ProgressEvent; import flash.events.IOErrorEvent; public class Sound_loadExample extends Sprite { private var snd:Sound = new Sound(); private var statusTextField:TextField = new TextField(); public function Sound_loadExample(){ statusTextField.autoSize = TextFieldAutoSize.LEFT; var req:URLRequest = new URLRequest("http://av.adobe.com/podcast/csbu_dev_podcast_epi_2.mp3"); try { snd.load(req); snd.play(); } catch (err:Error) { trace(err.message); } snd.addEventListener(IOErrorEvent.IO_ERROR, errorHandler); snd.addEventListener(ProgressEvent.PROGRESS, progressHandler); this.addChild(statusTextField); } private function progressHandler(event:ProgressEvent):void { var loadTime:Number = event.bytesLoaded / event.bytesTotal; var LoadPercent:uint = Math.round(100 * loadTime); statusTextField.text = "Sound file's size in bytes: " + event.bytesTotal + "\n" + "Bytes being loaded: " + event.bytesLoaded + "\n" + "Percentage of sound file that is loaded " + LoadPercent + "%.\n"; } private function errorHandler(errorEvent:IOErrorEvent):void { statusTextField.text = "The sound could not be loaded: " + errorEvent.text; } } }
loadCompressedDataFromByteArray | () | 方法 |
public function loadCompressedDataFromByteArray(bytes:ByteArray, bytesLength:uint):void
语言版本: | ActionScript 3.0 |
运行时版本: | AIR 3, Flash Player 11 |
将 ByteArray 对象中的 MP3 声音数据加载到 Sound 对象中。将从当前 ByteArray 位置读取数据,并在完成后将 ByteArray 位置保留在指定字节长度结尾处。如果 MP3 声音数据包含 ID3 数据,则在此函数调用过程中将调度 ID3 事件。如果 ByteArray 对象没有包含足够的数据,此函数将引发异常。
参数
bytes:ByteArray | |
bytesLength:uint |
loadPCMFromByteArray | () | 方法 |
public function loadPCMFromByteArray(bytes:ByteArray, samples:uint, format:String = "float", stereo:Boolean = true, sampleRate:Number = 44100.0):void
语言版本: | ActionScript 3.0 |
运行时版本: | AIR 3, Flash Player 11 |
将 ByteArray 对象中的 PCM 32 位浮点声音数据加载到 Sound 对象中。将从当前 ByteArray 位置读取数据,并在完成后将 ByteArray 位置保留在乘以 1 个信道或 2 个信道的指定采样长度的结尾处(如果一次完成立体声标志设置)。
从 Flash Player 11.8 开始,可传递给此函数的音频数据量是有限的。对于 SWF 版本 >=21,如果传递给此函数的音频数据量超过 1800 秒,此函数将引发异常。也即采样/采样率应小于等于 1800。对于 SWF 21(不含)以下的版本,如果传递的音频数据量超过 12000 秒,则运行时失败且不报错。此功能仅为了满足向后兼容性而提供。
如果 ByteArray 对象没有包含足够的数据,此函数将引发异常。
参数
bytes:ByteArray | |
samples:uint | |
format:String (default = "float ")
| |
stereo:Boolean (default = true )
| |
sampleRate:Number (default = 44100.0 )
|
play | () | 方法 |
public function play(startTime:Number = 0, loops:int = 0, sndTransform:flash.media:SoundTransform = null):SoundChannel
语言版本: | ActionScript 3.0 |
运行时版本: | AIR 1.0, Flash Player 9, Flash Lite 4 |
生成一个新的 SoundChannel 对象来播放该声音。此方法返回 SoundChannel 对象,访问该对象可停止声音并监控音量。(要控制音量、平移和平衡,请访问分配给声道的 SoundTransform 对象。)
参数
startTime:Number (default = 0 ) — 应开始播放的初始位置(以毫秒为单位)。
| |
loops:int (default = 0 ) — 定义在声道停止播放之前,声音循环回 startTime 值的次数。
| |
sndTransform:flash.media:SoundTransform (default = null ) — 分配给该声道的初始 SoundTransform 对象。
|
SoundChannel — SoundChannel 对象,用于控制声音。如果没有声卡或用完了可用的声道,此方法将返回 null 。一次最多可以使用 32 个声道。
|
相关 API 元素
示例 ( 如何使用本示例 )
构造函数调用 Sound.load()
方法以开始加载声音数据。接下来,它调用 Sound.play()
方法;在加载了足够多的数据后,此方法将立即开始播放声音。Sound.play()
方法返回 SoundChannel 对象,该对象可用于控制声音播放。文本字段中显示了相关说明。要确保已加载了用户希望从中开始播放声音的内容,请创建 bar
Sprite 对象,在加载完文件后将显示该对象。成功加载文件后,将调度一个 Event.COMPLETE
事件,此事件触发 completeHandler()
方法。completeHandler()
方法随后创建图形栏,并将其添加到显示列表中。(使用 Sprite 对象来支持交互功能,而不是形状对象。)当用户单击图形栏时,将触发 clickHandler()
方法。
在 clickHandler()
方法中,使用用户单击的 x 坐标位置 event.localX
来确定用户希望从中开始播放文件的位置。由于图形栏为 100 个像素并且从 x 坐标 100 个像素处开始,因此很容易确定位置的百分比。另外,由于加载了文件,声音文件的 length
属性将具有完整文件的长度(以毫秒为单位)。通过使用声音文件的长度和行中的位置,可以确定声音文件的起始位置。停止播放声音后,声音文件将在选定的起始位置重新开始播放,此位置是作为 play()
方法的 startTime
参数传递的。
package { import flash.display.Sprite; import flash.display.Graphics; import flash.events.MouseEvent; import flash.media.Sound;; import flash.net.URLRequest; import flash.media.SoundChannel; import flash.events.ProgressEvent; import flash.events.Event; import flash.text.TextField; import flash.text.TextFieldAutoSize; import flash.events.IOErrorEvent; public class Sound_playExample1 extends Sprite { private var snd:Sound = new Sound(); private var channel:SoundChannel = new SoundChannel(); private var infoTextField:TextField = new TextField(); public function Sound_playExample1() { var req:URLRequest = new URLRequest("MySound.mp3"); infoTextField.autoSize = TextFieldAutoSize.LEFT; infoTextField.text = "Please wait for the file to be loaded.\n" + "Then select from the bar to decide where the file should start."; snd.load(req); channel = snd.play(); snd.addEventListener(IOErrorEvent.IO_ERROR, errorHandler); snd.addEventListener(Event.COMPLETE, completeHandler); this.addChild(infoTextField); } private function completeHandler(event:Event):void { infoTextField.text = "File is ready."; var bar:Sprite = new Sprite(); bar.graphics.lineStyle(5, 0xFF0000); bar.graphics.moveTo(100, 100); bar.graphics.lineTo(200, 100); bar.addEventListener(MouseEvent.CLICK, clickHandler); this.addChild(bar); } private function clickHandler(event:MouseEvent):void { var position:uint = event.localX; var percent:uint = Math.round(position) - 100; var cue:uint = (percent / 100) * snd.length; channel.stop(); channel = snd.play(cue); } private function errorHandler(errorEvent:IOErrorEvent):void { infoTextField.text = "The sound could not be loaded: " + errorEvent.text; } } }
在构造函数中,加载了声音并创建了一个简单的矩形 button
Sprite 对象。(使用 Sprite 对象来支持交互功能,而不是形状对象。)此处,假定声音文件位于与 SWF 文件相同的目录中。(没有为本示例编写错误处理代码。)
设置了两个事件侦听器以响应鼠标单击和双击。如果用户单击一下,将调用 clickHandler()
方法以播放该声音。如果用户双击按钮,将调用 doubleClickHandler()
方法以播放两次声音文件。play()
方法的第二个参数设置为 1
,表示声音将返回到声音开始时间一次并重新播放。开始时间(第一个参数)设置为 0
,表示文件将从开始处播放。
package { import flash.display.Sprite; import flash.events.MouseEvent; import flash.media.Sound; import flash.net.URLRequest; public class Sound_playExample2 extends Sprite { private var button:Sprite = new Sprite(); private var snd:Sound = new Sound(); public function Sound_playExample2() { var req:URLRequest = new URLRequest("click.mp3"); snd.load(req); button.graphics.beginFill(0x00FF00); button.graphics.drawRect(10, 10, 50, 30); button.graphics.endFill(); button.addEventListener(MouseEvent.CLICK, clickHandler); button.addEventListener(MouseEvent.DOUBLE_CLICK, doubleClickHandler); this.addChild(button); } private function clickHandler(event:MouseEvent):void { snd.play(); } private function doubleClickHandler(event:MouseEvent):void { snd.play(0, 2); } } }
在构造函数中,在 try...catch
块中加载了该文件,以便捕获在加载文件时可能发生的任何错误。在声音对象中添加了一个侦听器,它通过调用 errorHandler()
方法来响应 IOErrorEvent
事件。还为主应用程序添加了一个侦听器以响应 Event.ENTER_FRAME
事件,它用作计时机制以显示播放进度。最后,为声道添加了第三个侦听器,它通过调用 soundCompleteHandler()
方法来响应 Event.SOUND_COMPLETE
事件(完成声音播放时)。soundCompleteHandler()
方法还删除了 Event.ENTER_FRAME
事件的事件侦听器。
enterFrameHandler()
方法将随 ProgressEvent
对象传递的 bytesLoaded
值除以 bytesTotal
值,以得出正在加载的声音数据的百分比。可通过将声道的 position
属性值除以声音数据长度,来确定正在播放的声音数据的百分比。但是,如果未完全加载声音数据,声音对象的 length
属性仅显示当前加载的声音数据的大小。估计的完整声音文件的最终大小是使用以下方法计算的:将当前声音对象的 length
值除以 bytesLoaded
属性值,再乘以 bytesTotal
属性值。
请注意,如果文件很小、已缓存或位于本地目录中,则加载进度可能不太明显。另外,从声音数据开始加载到所加载的数据开始播放之间的延迟时间是由 SoundLoaderContext.buffertime
属性值确定的,此属性的默认值为 1000 毫秒,您可以对其进行重置。
package { import flash.display.Sprite; import flash.net.URLRequest; import flash.media.Sound; import flash.media.SoundChannel; import flash.text.TextField; import flash.text.TextFieldAutoSize; import flash.events.Event; import flash.events.IOErrorEvent; public class Sound_playExample3 extends Sprite { private var snd:Sound = new Sound(); private var channel:SoundChannel; private var statusTextField:TextField = new TextField(); public function Sound_playExample3(){ statusTextField.autoSize = TextFieldAutoSize.LEFT; var req:URLRequest = new URLRequest("http://av.adobe.com/podcast/csbu_dev_podcast_epi_2.mp3"); try { snd.load(req); channel = snd.play(); } catch (err:Error) { trace(err.message); } snd.addEventListener(IOErrorEvent.IO_ERROR, errorHandler); addEventListener(Event.ENTER_FRAME, enterFrameHandler); channel.addEventListener(Event.SOUND_COMPLETE, soundCompleteHandler); this.addChild(statusTextField); } private function enterFrameHandler(event:Event):void { var loadTime:Number = snd.bytesLoaded / snd.bytesTotal; var loadPercent:uint = Math.round(100 * loadTime); var estimatedLength:int = Math.ceil(snd.length / (loadTime)); var playbackPercent:uint = Math.round(100 * (channel.position / estimatedLength)); statusTextField.text = "Sound file's size is " + snd.bytesTotal + " bytes.\n" + "Bytes being loaded: " + snd.bytesLoaded + "\n" + "Percentage of sound file that is loaded " + loadPercent + "%.\n" + "Sound playback is " + playbackPercent + "% complete."; } private function errorHandler(errorEvent:IOErrorEvent):void { statusTextField.text = "The sound could not be loaded: " + errorEvent.text; } private function soundCompleteHandler(event:Event):void { statusTextField.text = "The sound has finished playing."; removeEventListener(Event.ENTER_FRAME, enterFrameHandler); } } }
complete | 事件 |
flash.events.Event
属性 Event.type =
flash.events.Event.COMPLETE
语言版本: | ActionScript 3.0 |
运行时版本: | AIR 1.0, Flash Player 9, Flash Lite 4 |
成功加载数据后调度。
Event.COMPLETE
常量定义 complete
事件对象的 type
属性值。
此事件具有以下属性:
属性 | 值 |
---|---|
bubbles | false |
cancelable | false ;没有要取消的默认行为。 |
currentTarget | 当前正在使用某个事件侦听器处理 Event 对象的对象。 |
target | 已完成加载的网络对象。 |
相关 API 元素
id3 | 事件 |
flash.events.Event
属性 Event.type =
flash.events.Event.ID3
语言版本: | ActionScript 3.0 |
运行时版本: | AIR 1.0, Flash Player 9, Flash Lite 4 |
在存在可用于 MP3 声音的 ID3 数据时由 Sound 对象调度。
Event.ID3
常量定义 id3
事件对象的 type
属性值。
此事件具有以下属性:
属性 | 值 |
---|---|
bubbles | false |
cancelable | false ;没有要取消的默认行为。 |
currentTarget | 当前正在使用某个事件侦听器处理 Event 对象的对象。 |
target | 加载 MP3 的 Sound 对象,ID3 数据现在可用于此对象。target 不一定是显示列表中注册此事件侦听器的对象。请使用 currentTarget 属性来访问显示列表中当前正在处理此事件的对象。 |
相关 API 元素
ioError | 事件 |
flash.events.IOErrorEvent
属性 IOErrorEvent.type =
flash.events.IOErrorEvent.IO_ERROR
语言版本: | ActionScript 3.0 |
运行时版本: | AIR 1.0, Flash Player 9, Flash Lite 4 |
在出现输入/输出错误并由此导致加载操作失败时调度。
定义ioError
事件对象的 type
属性值。
此事件具有以下属性:
属性 | 值 |
---|---|
bubbles | false |
cancelable | false ;没有要取消的默认行为。 |
currentTarget | 当前正在使用某个事件侦听器处理 Event 对象的对象。 |
errorID | 与特定错误关联的引用编号(仅限 AIR)。 |
target | 发生输入/输出错误的网络对象。 |
text | 要显示为错误消息的文本。 |
相关 API 元素
open | 事件 |
flash.events.Event
属性 Event.type =
flash.events.Event.OPEN
语言版本: | ActionScript 3.0 |
运行时版本: | AIR 1.0, Flash Player 9, Flash Lite 4 |
在加载操作开始时调度。
Event.OPEN
常量用于定义 open
事件对象的 type
属性值。
此事件具有以下属性:
属性 | 值 |
---|---|
bubbles | false |
cancelable | false ;没有要取消的默认行为。 |
currentTarget | 当前正在使用某个事件侦听器处理 Event 对象的对象。 |
target | 已打开连接的网络对象。 |
相关 API 元素
progress | 事件 |
flash.events.ProgressEvent
属性 ProgressEvent.type =
flash.events.ProgressEvent.PROGRESS
语言版本: | ActionScript 3.0 |
运行时版本: | AIR 1.0, Flash Player 9, Flash Lite 4 |
在加载操作进行过程中接收到数据时调度。
定义progress
事件对象的 type
属性值。
此事件具有以下属性:
属性 | 值 |
---|---|
bubbles | false |
bytesLoaded | 在侦听器处理事件时加载的项数或字节数。 |
bytesTotal | 如果加载进程成功,最终将加载的项目或字节总数。 |
cancelable | false ;没有要取消的默认行为。 |
currentTarget | 当前正在使用某个事件侦听器处理 Event 对象的对象。 |
target | 报告进度的对象。 |
相关 API 元素
sampleData | 事件 |
flash.events.SampleDataEvent
属性 SampleDataEvent.type =
flash.events.SampleDataEvent.SAMPLE_DATA
语言版本: | ActionScript 3.0 |
运行时版本: | Flash Player 10, AIR 1.5 |
在运行时请求新音频数据时调度。
定义SampleDataEvent
事件对象的 type
属性值。
此事件具有以下属性:
属性 | 值 |
---|---|
bubbles | false |
cancelable | false ;没有要取消的默认行为。 |
position | 从中提供音频数据的点。 |
示例 ( 如何使用本示例 )
var mySound:Sound = new Sound(); function sineWaveGenerator(event:SampleDataEvent):void { for ( var c:int=0; c<8192; c++ ) { event.data.writeFloat(Math.sin((Number(c+event.position)/Math.PI/2))*0.25); event.data.writeFloat(Math.sin((Number(c+event.position)/Math.PI/2))*0.25); } } mySound.addEventListener(SampleDataEvent.SAMPLE_DATA,sineWaveGenerator); mySound.play();
相关 API 元素
package { import flash.display.Sprite; import flash.events.*; import flash.media.Sound; import flash.media.SoundChannel; import flash.net.URLRequest; public class SoundExample extends Sprite { private var url:String = "MySound.mp3"; private var song:SoundChannel; public function SoundExample() { var request:URLRequest = new URLRequest(url); var soundFactory:Sound = new Sound(); soundFactory.addEventListener(Event.COMPLETE, completeHandler); soundFactory.addEventListener(Event.ID3, id3Handler); soundFactory.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler); soundFactory.addEventListener(ProgressEvent.PROGRESS, progressHandler); soundFactory.load(request); song = soundFactory.play(); } private function completeHandler(event:Event):void { trace("completeHandler: " + event); } private function id3Handler(event:Event):void { trace("id3Handler: " + event); } private function ioErrorHandler(event:Event):void { trace("ioErrorHandler: " + event); } private function progressHandler(event:ProgressEvent):void { trace("progressHandler: " + event); } } }
Tue Jun 12 2018, 11:04 AM Z