phonic 0.16.0

Audio playback library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

//! Audio output device implementations and traits.

// Validate feature compatibility
#[cfg(all(target_arch = "wasm32", feature = "cpal-output"))]
compile_error!("wasm32 targets are incompatible with cpal-output. Use web-output instead");

#[cfg(feature = "cpal-output")]
pub mod cpal;
#[cfg(feature = "wav-output")]
pub mod wav;
#[cfg(feature = "web-output")]
pub mod web;

use super::source::Source;

// -------------------------------------------------------------------------------------------------

/// The default audio output device for the current platform and feature configuration.
///
/// Determined by compile-time feature flags and target archs:
/// - `cpal-output` (if not wasm32)
/// - `web-output` (for wasm32 targets)
#[cfg(feature = "cpal-output")]
pub type DefaultOutputDevice = cpal::CpalOutput;

#[cfg(all(feature = "web-output", not(feature = "cpal-output")))]
pub type DefaultOutputDevice = web::WebOutput;

// -------------------------------------------------------------------------------------------------

/// Platform-agnostic audio output device interface, abstracts platform-specific audio backends
/// for [`Player`](crate::Player).
pub trait OutputDevice: Send {
    /// Returns the output buffer channel count (e.g., 1 for mono, 2 for stereo).
    fn channel_count(&self) -> usize;
    /// Returns the output sample rate in Hz.
    fn sample_rate(&self) -> u32;
    /// Returns the current playhead position in **samples** (not frames).
    /// Tracks the total number of samples output since device creation.
    fn sample_position(&self) -> u64;

    /// Returns the current output volume (typically 0.0 to 1.0).
    fn volume(&self) -> f32;
    /// Sets the output volume.
    fn set_volume(&mut self, volume: f32);

    /// Returns `true` if audio output is suspended by the system.
    /// Only relevant for web audio backends; always returns `false` for desktop backends.
    fn is_suspended(&self) -> bool;

    /// Returns `true` if audio is currently playing (not paused).
    fn is_running(&self) -> bool;
    /// Pauses playback while keeping the output source active.
    fn pause(&mut self);
    /// Resumes playback from a paused state.
    fn resume(&mut self);

    /// Starts playback of a new audio source.
    fn play(&mut self, source: Box<dyn Source>);
    /// Stops playback and replaces the source with silence.
    fn stop(&mut self);

    /// Releases the audio device and cleans up resources.
    fn close(&mut self);
}