Perro LogoPerro

GitHub

Resource API Docs

Audio Resource API

Resource API Index

Purpose

Audio helpers load, reserve, play, stop, trim, query length, and control master or bus volume/speed.

Audio Resource API explains behavior, constraints, and practical usage so implementation decisions stay consistent across scripts and scenes.

Jump to Docs

Resource APIall modules

API Source

Functions

audio_play!audio_stop!audio_reserve!audio_drop!audio_bus_set_volume!audio_bus_set_speed!

Enums

AudioBusID

Constants

final volume = master * bus * clip

Types

ResourceWindowAudioScriptContext

Usage Pattern

let music = audio_bus!("music");let _ = audio_bus_set_volume!(res, music, 0.7);let _ = audio_play!(res, Audio {    source: "res://music.ogg",    bus: music,    looped: true,    volume: 1.0,    speed: 1.0,    from_start: 0.0,    from_end: 0.0,});

Key Details

Audio playback is queued to the audio thread.

audio_reserve! keeps source bytes cached.

Final loudness multiplies master volume, bus volume, and Audio.volume.

Final speed multiplies bus speed and Audio.speed.

Related Docs

Resource APIall modules