Struct riddle_audio::AudioSystem

pub struct AudioSystem { /* fields omitted */ }

The Riddle audio system core state.

Manages underlying audio device and riddle audio objects' states. The recommended way to use this type is to let the riddle crate initialize and manage it for you.

It is possible to manage the audio system state independantly - the most important thing to note is that AudioSystem::process_frame must be called periodically for ClipPlayer to work properly. This is not something that needs doing if using the riddle crate to manage the AudioSystem automatically.

Implementations

impl AudioSystem

pub fn new() -> Result<AudioSystemHandle, AudioError>

Create the audio system, connected to the default audio output device.

pub fn process_frame(&self)

Update the system's state.

Updates all ClipPlayer fades. This must be called periodically for the AudioSystem to function. Do not call this if the riddle crate is being used.

Example

let audio_system = AudioSystem::new()?;

// Tick the audio system every 100ms
let start_time = std::time::Instant::now();
while std::time::Instant::now() - start_time < std::time::Duration::from_secs(2) {
    audio_system.process_frame();
    std::thread::sleep(std::time::Duration::from_millis(100));
}

Trait Implementations

impl CloneHandle for AudioSystem

type Handle = AudioSystemHandle

The type which represents a strong reference, and which may be dereferenced as Self.

type WeakHandle = AudioSystemWeak

The type which represents a weak reference.

fn clone_handle(&self) -> AudioSystemHandle

Clone a strong handle to the object.

fn clone_weak_handle(&self) -> AudioSystemWeak

Clone a weak handle to the object.