API Reference / Audio / audLoopSound

audLoopSound

Plays a sound continuously in a loop and returns a channel handle. Takes sound (sound handle from audLoadSound). Returns a channel handle that can be used to control playback.

Audio

Parameters & Returns

Parameters

sound Int

Returns

Int

Quick Summary

Plays a sound continuously in a loop and returns a channel handle. Takes sound (sound handle from audLoadSound). Returns a channel handle that can be used to control playback.

Technical Exegesis...

Plays the specified sound repeatedly in a loop and returns a channel handle that can be used to control playback. Returns 0 if the sound handle is invalid or <= 0.

The sound loops continuously until explicitly stopped with audStopChannel. Use this for background music or ambient effects. The returned channel handle can be used with audStopChannel, audPauseChannel, or audResumeChannel.

Example

Example.bam 
Local pistolSound:Int = audLoadSound(\"pistol.wav\")

Local channel:Int = audLoopSound(pistolSound)
Since: 1.0 Status: Stable
← Back to Audio