Returns the currently available number of bytes in this sound object. This property is usually useful only 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.

AIR 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 ActionScript property name. The second table describes ID3 tags that are supported but do not have predefined properties in ActionScript.

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. NOTE: None of these tags are supported in Flash Lite 4.

When using this property, consider the Flash Player security model:

• The id3 property of a Sound object is always permitted for SWF 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, Flash Player checks for a URL policy file on the server from which the sound is loaded. If a policy file exists and permits access from the domain of the loading SWF 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 related to security, see the Flash Player Developer Center Topic: Security.

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.

Indicates if the Sound.url property has been truncated. When the isURLInaccessible value is true the Sound.url value is only the domain of the final URL from which the sound loaded. For example, the property is truncated if the sound is loaded from http://www.adobe.com/assets/hello.mp3, and the Sound.url property has the value http://www.adobe.com. The isURLInaccessible value is true only when all of the following are also true:

• An HTTP redirect occurred while loading the sound file.
• The SWF file calling Sound.load() is from a different domain than the sound file's final URL.
• The SWF file calling Sound.load() does not have permission to access the sound file. Permission is granted to access the sound file the same way permission is granted for the Sound.id3 property: establish a policy file and use the SoundLoaderContext.checkPolicyFile property.

Note: The isURLInaccessible property was added for Flash Player 10.1 and AIR 2.0. However, this property is made available to SWF files of all versions when the Flash runtime supports it. So, using some authoring tools in "strict mode" causes a compilation error. To work around the error use the indirect syntax mySound["isURLInaccessible"], or disable strict mode. If you are using Flash Professional CS5 or Flex SDK 4.1, you can use and compile this API for runtimes released before Flash Player 10.1 and AIR 2.

For application content in AIR, the value of this property is always false.

See also

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 represents 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.

In some cases, the value of the url property is truncated; see the isURLInaccessible property for details.

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.

Extracts raw sound data from a Sound object.

This method is designed to be used when you are working with dynamically generated audio, using a function you assign to the sampleData event for a different Sound object. That is, you can use this method to extract sound data from a Sound object. Then you can write the data to the byte array that another Sound object is using to stream dynamic audio.

The audio data is placed in the target byte array starting from the current position of the byte array. The audio data is always exposed as 44100 Hz Stereo. The sample type is a 32-bit floating-point value, which can be converted to a Number using ByteArray.readFloat().

Parameters

See also

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.

For more information related to security, see the Flash Player Developer Center Topic: Security.

Parameters

load MP3 sound data from a ByteArray object into a Sound object. The data will be read from the current ByteArray position and will leave the ByteArray position at the end of the specified bytes length once finished. If the MP3 sound data contains ID3 data ID3 events will be dispatched during this function call. This function will throw an exception if the ByteArray object does not contain enough data.

Parameters

load PCM 32-bit floating point sound data from a ByteArray object into a Sound object. The data will be read from the current ByteArray position and will leave the ByteArray position at the end of the specified sample length multiplied by either 1 channel or 2 channels if the stereo flag is set once finished. This function will throw an exception if the ByteArray object does not contain enough data.

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

Dispatched when the runtime requests new audio data.

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>