Working with sound assets

Using sound assets, instead of loading sounds from a web URL or a file system path, is another possibility for playing audio. In some cases sound assets will be embedded in the generated binary, and in others, they will be included as separate files. However, the API for working with either option is the same, allowing you to write code once and target many platforms.

Specifying sound assets

In a Lime project.xml file, include sound files using the <assets> element. Sounds assets may be of one of the following types:

  • music
  • sound

Some targets can only support playing one music file at a time. You should use "music" for files which are designed to play as background music, and "sound" for all other audio.

<assets path="assets">
    <sound path="sound/MySound.wav" id="MySound" />
    <music path="sound/BackgroundMusic.ogg" />

Using sound assts

The following code works with a sound asset with the id "MySound". The code get an instance of the sound asset and calls the play() method on that instance:

import openfl.utils.Assets;
import openfl.display.Sprite;

class SoundAssetExample extends Sprite
    public function new()
        var smallSound:Sound = Assets.getSound("MySound");;

More Help topics

results matching ""

    No results matching ""