Struct AudioContextOptions

pub struct AudioContextOptions {
    pub latency_hint: AudioContextLatencyCategory,
    pub sample_rate: Option<f32>,
    pub sink_id: String,
    pub render_size_hint: AudioContextRenderSizeCategory,
}

Specify the playback configuration for the AudioContext constructor.

All fields are optional and will default to the value best suited for interactive playback on your hardware configuration.

For future compatibility, it is best to construct a default implementation of this struct and set the fields you would like to override:

use web_audio_api::context::AudioContextOptions;

// Request a sample rate of 44.1 kHz, leave other fields to their default values
let opts = AudioContextOptions {
    sample_rate: Some(44100.),
    ..AudioContextOptions::default()
};

Fields

latency_hint: AudioContextLatencyCategory

Identify the type of playback, which affects tradeoffs between audio output latency and power consumption.

sample_rate: Option<f32>

Sample rate of the audio context and audio output hardware. Use None for a default value.

sink_id: String

The audio output device

• use "" for the default audio output device
• use "none" to process the audio graph without playing through an audio output device.
• use "sinkId" to use the specified audio sink id, obtained with enumerate_devices_sync

render_size_hint: AudioContextRenderSizeCategory

Option to request a default, optimized or specific render quantum size. It is a hint that might not be honored.

Trait Implementations

impl Clone for AudioContextOptions

fn clone(&self) -> AudioContextOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AudioContextOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AudioContextOptions

fn default() -> AudioContextOptions

Returns the “default value” for a type.

impl From<MediaTrackConstraints> for AudioContextOptions

fn from(value: MediaTrackConstraints) -> Self

Converts to this type from the input type.