Function play

  • play the specified sound

    Parameters

    • sound_name: string

      audio clip name - case sensitive

    • Optionalloop: boolean = false

      loop audio

    • Optionalonend: Function

      Function to call when sound instance ends playing.

    • Optionalvolume: number

      Float specifying volume (0.0 - 1.0 values accepted).

    Returns number

    the sound instance ID.

    // play the "cling" audio clip
    me.audio.play("cling");
    // play & repeat the "engine" audio clip
    me.audio.play("engine", true);
    // play the "gameover_sfx" audio clip and call myFunc when finished
    me.audio.play("gameover_sfx", false, myFunc);
    // play the "gameover_sfx" audio clip with a lower volume level
    me.audio.play("gameover_sfx", false, null, 0.5);