kira

Creates a new audio manager and opens the system audio device. The optional config table is accepted but currently ignored — default settings are always used. Only one audio manager should be active at a time.

use plugin kira::{AudioManager}

let mgr = AudioManager.new()

Loads a static sound file from the given file path. Supports common formats such as WAV, OGG, and FLAC. Returns a SoundData handle that can be passed to play multiple times.

use plugin kira::{AudioManager}

let mgr = AudioManager.new()
let sound = mgr.load_sound("assets/music.ogg")

Plays a loaded sound and returns a SoundHandle for controlling playback. The optional config table supports keys: volume (float), playback_rate (float), panning (float -1.0 to 1.0), and loop_start (float seconds).

use plugin kira::{AudioManager}

let mgr = AudioManager.new()
let sound = mgr.load_sound("assets/shoot.wav")

let handle = mgr.play(sound)

let looping = mgr.play(sound, #{"volume": 0.8, "loop_start": 0.0})

Returns a proxy handle to the audio manager's main mixing track. Use this to control the master volume of all playing sounds.

use plugin kira::{AudioManager}

let mgr = AudioManager.new()
let track = mgr.main_track()
track.set_volume(0.5)

Closes the audio manager and releases the audio device. After calling this, any further use of the manager or its handles will error.

use plugin kira::{AudioManager}

let mgr = AudioManager.new()
mgr.close()

Pauses the sound. The optional tween table controls the fade duration and easing: #{"duration": 0.5, "easing": "linear"}. Supported easing values: "linear", "in_quad", "out_quad", "in_out_quad", "in_cubic", "out_cubic", "in_out_cubic".

use plugin kira::{AudioManager}

let mgr = AudioManager.new()
let snd = mgr.load_sound("assets/bg.ogg")
let h = mgr.play(snd)
h.pause(#{"duration": 0.3, "easing": "out_quad"})

Resumes a paused sound, with optional fade-in tween.

h.resume(#{"duration": 0.3})

Stops the sound entirely. After stopping, the handle can no longer be used to resume playback.

h.stop(#{"duration": 1.0})

Sets the playback volume as an amplitude multiplier (1.0 = original, 0.5 = half volume). Optionally smoothed with a tween.

h.set_volume(0.5)
h.set_volume(0.0, #{"duration": 2.0})

Sets the playback rate (1.0 = normal speed, 2.0 = double speed, 0.5 = half speed). Also affects pitch.

h.set_playback_rate(1.5)

Sets stereo panning: -1.0 is full left, 0.0 is center, 1.0 is full right.

h.set_panning(-0.5)

Returns the current playback state as one of: "playing", "pausing", "paused", "stopping", or "stopped".

let s = h.state()
print("State: {s}")

Returns the current playback position in seconds.

let pos = h.position()
print("At {pos} seconds")

Seeks to an absolute position in seconds.

h.seek_to(30.0)

Seeks forward or backward by amount seconds relative to the current position.

h.seek_by(10.0)
h.seek_by(-5.0)

Sets the loop region starting at start seconds and looping to the end of the file. Pass nil to disable looping.

h.set_loop_region(4.0)
h.set_loop_region(nil)

Sets the master volume of the main mixing track, affecting all currently playing sounds.

use plugin kira::{AudioManager}

let mgr = AudioManager.new()
let track = mgr.main_track()
track.set_volume(0.25)

Reserved for adding audio effects to the track. Currently a stub — returns nil without applying any effect, as Kira 0.9 requires effects to be added at track construction time.

track.add_effect(#{"type": "reverb"})