Returns the currently available number of bytes in this sound object. This is usually only useful for externally loaded files.

Returns the total number of bytes in this sound object.

Provides access to the metadata that is part of an MP3 file.

MP3 sound files can contain ID3 tags, which provide metadata about the file. If an MP3 sound that you load using the Sound.load() method contains ID3 tags, you can query these properties. Only ID3 tags that use the UTF-8 character set are supported.

The AIR runtime supports ID3 2.0 tags, specifically 2.3 and 2.4. The following tables list the standard ID3 2.0 tags and the type of content the tags represent. The Sound.id3 property provides access to these tags through the format my_sound.id3.COMM, my_sound.id3.TIME, and so on. The first table describes tags that can be accessed either through the ID3 2.0 property name or the Sound class property name. The second table describes ID3 tags that are supported but do not have predefined properties in the Sound class.

The following table describes ID3 tags that are supported but do not have predefined properties in the Sound class. You access them by calling mySound.id3.TFLT, mySound.id3.TIME, and so on.

When using this property, consider the following security model:

• The id3 property of a Sound object is always permitted for files that are in the same security sandbox as the sound file. For files in other sandboxes, there are security checks.
• When you load the sound, using the load() method of the Sound class, you can specify a context parameter, which is a SoundLoaderContext object. If you set the checkPolicyFile property of the SoundLoaderContext object to true, the application checks for a cross-domain policy file on the server from which the sound is loaded. If there is a cross-domain policy file, and the file permits the domain of the loading file, then the file is allowed to access the id3 property of the Sound object; otherwise it is not.

However, in Adobe AIR, content in the application security sandbox (content installed with the AIR application) are not restricted by these security limitations.

For more information, see the following:

• The Flash Player 9 Security white paper

See also

Returns the buffering state of external MP3 files. If the value is true, any playback is currently suspended while the object waits for more data.

The length of the current sound in milliseconds.

The URL from which this sound was loaded. This property is applicable only to Sound objects that were loaded using the Sound.load() method. For Sound objects that are associated with a sound asset from a SWF file's library, the value of the url property is null.

When you first call Sound.load(), the url property initially has a value of null, because the final URL is not yet known. The url property will have a non-null value as soon as an open event is dispatched from the Sound object.

The url property contains the final, absolute URL from which a sound was loaded. The value of url is usually the same as the value passed to the stream parameter of Sound.load(). However, if you passed a relative URL to Sound.load() the value of the url property will represent the absolute URL. Additionally, if the original URL request is redirected by an HTTP server, the value of the url property reflects the final URL from which the sound file was actually downloaded. This reporting of an absolute, final URL is equivalent to the behavior of LoaderInfo.url.

See also

Creates a new Sound object. If you pass a valid URLRequest object to the Sound constructor, the constructor automatically calls the load() function for the Sound object. If you do not pass a valid URLRequest object to the Sound constructor, you must call the load() function for the Sound object yourself, or the stream will not load.

Once load() is called on a Sound object, you can't later load a different sound file into that Sound object. To load a different sound file, create a new Sound object.

Closes the stream, causing any download of data to cease. No data may be read from the stream after the close() method is called.

Initiates loading of an external MP3 file from the specified URL. If you provide a valid URLRequest object to the Sound constructor, the constructor calls Sound.load() for you. You only need to call Sound.load() yourself if you don't pass a valid URLRequest object to the Sound constructor or you pass a null value.

Once load() is called on a Sound object, you can't later load a different sound file into that Sound object. To load a different sound file, create a new Sound object.

• Calling Sound.load() is not allowed if the calling file is in the local-with-file-system sandbox and the sound is in a network sandbox.
• Access from the local-trusted or local-with-networking sandbox requires permission from a website through a cross-domain policy file.

In Adobe AIR, content in the application security sandbox (content installed with the AIR application) are not restricted by these security limitations.

For more information, see the following:

• The security chapter in the Programming ActionScript 3.0 book and the latest comments on LiveDocs
• The "Understanding AIR Security" section of the "Getting started with Adobe AIR" chapter in the Developing AIR Applications book.
• The Flash Player 9 Security white paper

Parameters

Generates a new SoundChannel object to play back the sound. This method returns a SoundChannel object, which you access to stop the sound and to monitor volume. (To control the volume, panning, and balance, access the SoundTransform object assigned to the sound channel.)

Parameters

See also

Dispatched when data has loaded successfully.

This event has the following properties:

See also

Dispatched by a Sound object when ID3 data is available for an MP3 sound.

This event has the following properties:

See also

Dispatched when an input/output error occurs that causes a load operation to fail.

This event has the following properties:

See also

Dispatched when a load operation starts.

This event has the following properties:

See also

Dispatched when data is received as a load operation progresses.

This event has the following properties:

See also

Note: To test this example, do the following:

1. Add the AIRAliases.js file to the project directory.
2. Place a file named MySound.mp3 in the same project directory.
3. Create an application descriptor file for the project, and test the project using ADL.

<html>
    <head>
      <script src="AIRAliases.js" />
      <script>
        function init() {
            var request = new air.URLRequest("app://MySound.mp3");
            var soundFactory = new air.Sound();
            soundFactory.addEventListener(air.Event.COMPLETE, completeHandler);
            soundFactory.addEventListener(air.Event.ID3, id3Handler);
            soundFactory.addEventListener(air.IOErrorEvent.IO_ERROR, ioErrorHandler);
            soundFactory.addEventListener(air.ProgressEvent.PROGRESS, progressHandler);
            soundFactory.load(request);
            song = soundFactory.play();
        }

        function completeHandler(event) {
            air.trace("completeHandler: " + event);
        }

        function id3Handler(event) {
            air.trace("id3Handler: " + event);
        }

        function ioErrorHandler(event) {
            air.trace("ioErrorHandler: " + event);
        }

        function progressHandler(event) {
            air.trace("progressHandler: " + event);
        }
      </script>
    </head>
    <body onload='init()'>
    </body>
</html>