Short Sound Effects (Sound)
Short sound effects are intended for brief sounds that need frequent replay, such as button clicks, prompts, and status feedback. AIUI provides dedicated local short-sound playback through Sound.
Compared with the general-purpose AudioPlayer, Sound offers a narrower feature set but a more direct API, making it suitable for local sound effect resources that should play immediately.
Play a Sound Effect
import { Sound } from 'audio';
const click = new Sound('/assets/click.wav');
click.volume = 0.8;
click.play();
Behavior Notes
Soundis only used for local sound effect files.- Local sound effect paths support both relative paths and project-root absolute paths.
Sounddoes not support changingsrc, seeking to a playback position, streaming appended data, or event listeners.- Calling instance methods again after
destroy()throws an error.
Use Cases
- If you need a lighter local sound effect playback API, prefer
Sound. - If you need more complete playback control, use Audio Playback.
- If you need to record audio or use a camera, see Media Capture.
API Reference
Entry
Sound can be used directly as a global or imported from the built-in audio module:
const click = new Sound('./click.wav');
import { Sound } from 'audio';
Constructor
new Sound(src)
src: The local path to the sound effect file. It must be a non-empty string. It supports both relative paths and project-root absolute paths such as/assets/click.wav.- Only local files are supported. Remote URLs such as
http://orhttps://are not supported. - The audio source is bound during construction so it can be replayed quickly afterward.
Properties
volume
- Type:
number - Read/Write: Readable and writable
- Description: Controls the playback volume of the current sound effect instance.
Methods
play()
- Description: If the current instance is already playing, it stops the current playback first and then restarts from the beginning.
stop()
- Description: Stops the current sound effect playback.
destroy()
- Description: Releases the underlying player resources. The instance cannot continue to be used after this call.