Struct wasapi::AudioClient

pub struct AudioClient { /* fields omitted */ }

Struct wrapping an IAudioClient.

Implementations

impl AudioClient

pub fn get_mixformat(&self) -> Result<WaveFormat, Box<dyn Error>>

Get MixFormat of the device. This is the format the device uses in shared mode and should always be accepted.

pub fn is_supported(
    &self,
    wave_fmt: &WaveFormat,
    sharemode: &ShareMode
) -> Result<Option<WaveFormat>, Box<dyn Error>>

Check if a format is supported. If it’s directly supported, this returns Ok(None). If not, but a similar format is, then the supported format is returned as Ok(Some(WaveFormat)).

pub fn get_periods(&self) -> Result<(i64, i64), Box<dyn Error>>

Get default and minimum periods in 100-nanosecond units

pub fn initialize_client(
    &mut self,
    wavefmt: &WaveFormat,
    period: i64,
    direction: &Direction,
    sharemode: &ShareMode,
    convert: bool
) -> Result<(), Box<dyn Error>>

Initialize an IAudioClient for the given direction, sharemode and format. Setting convert to true enables automatic samplerate and format conversion, meaning that almost any format will be accepted.

pub fn set_get_eventhandle(&self) -> Result<Handle, Box<dyn Error>>

Create and return an event handle for an IAudioClient

pub fn get_bufferframecount(&self) -> Result<u32, Box<dyn Error>>

Get buffer size in frames

pub fn get_current_padding(&self) -> Result<u32, Box<dyn Error>>

Get current padding in frames. This represents the number of frames currently in the buffer, for both capture and render devices.

pub fn get_available_space_in_frames(&self) -> Result<u32, Box<dyn Error>>

Get buffer size minus padding in frames. Use this to find out how much free space is available in the buffer.

pub fn start_stream(&self) -> Result<(), Box<dyn Error>>

Start the stream on an IAudioClient

pub fn stop_stream(&self) -> Result<(), Box<dyn Error>>

Stop the stream on an IAudioClient

pub fn reset_stream(&self) -> Result<(), Box<dyn Error>>

Reset the stream on an IAudioClient

pub fn get_audiorenderclient(&self) -> Result<AudioRenderClient, Box<dyn Error>>

Get a rendering (playback) client

pub fn get_audiocaptureclient(
    &self
) -> Result<AudioCaptureClient, Box<dyn Error>>

Get a capture client

pub fn get_audiosessioncontrol(
    &self
) -> Result<AudioSessionControl, Box<dyn Error>>

Get the AudioSessionControl