AudioHandle

backend.AudioHandle (Typedef)

Handle to an individual audio playback instance in the Clay audio system.

An AudioHandle represents a playing or paused sound instance that can be controlled independently. Each handle allows you to:

  • Control playback (play, pause, stop)
  • Adjust volume and pitch
  • Query playback position and state
  • Apply real-time effects

Handles are obtained when playing a sound through the Audio system and remain valid until the sound completes or is explicitly stopped. The handle becomes invalid after the sound finishes playing.

See: Audio.play() To obtain an AudioHandle, AudioResource For the underlying audio data