Struct AudioDevice

pub struct AudioDevice { /* private fields */ }

Represents an open audio device (playback or recording).

Implementations

impl AudioDevice

pub fn id(&self) -> AudioDeviceID

pub fn new(device_id: AudioDeviceID, audio_subsystem: AudioSubsystem) -> Self

pub fn name(&self) -> Result<String, Error>

Get the name of the audio device.

pub fn open_device_stream( self, spec: Option<&AudioSpec>, ) -> Result<AudioStreamOwner, Error>

Create an AudioStream for this device with the specified spec. This device will be closed when the stream is dropped. The device begins paused, so you must call stream.resume() to start playback.

pub fn bind_stream(&self, stream: &AudioStream) -> Result<(), Error>

Binds an audio stream to this device.

pub fn bind_streams(&self, streams: &[&AudioStream]) -> Result<(), Error>

Binds multiple audio streams to this device.

pub fn open_playback<'a, D>( _a: &AudioSubsystem, device: D, spec: &AudioSpec, ) -> Result<AudioDevice, Error>

where D: Into<Option<&'a AudioDeviceID>>,

Opens a new audio device for playback (given the desired parameters).

pub fn open_recording<'a, D>( _a: &AudioSubsystem, device: D, spec: &AudioSpec, ) -> Result<AudioDevice, Error>

where D: Into<Option<&'a AudioDeviceID>>,

Opens a new audio device for recording (given the desired parameters).

pub fn pause(&self) -> bool

Pauses playback of the audio device.

pub fn resume(&self) -> bool

Starts playback of the audio device.

pub fn open_playback_stream_with_callback<CB, Channel>( &self, spec: &AudioSpec, callback: CB, ) -> Result<AudioStreamWithCallback<CB>, Error>

where CB: AudioCallback<Channel>, Channel: AudioFormatNum + 'static,

Opens a new audio stream for this device with the specified spec. The device begins paused, so you must call stream.resume() to start playback.

pub fn open_recording_stream_with_callback<CB, Channel>( &self, spec: &AudioSpec, callback: CB, ) -> Result<AudioStreamWithCallback<CB>, Error>

where CB: AudioRecordingCallback<Channel>, Channel: AudioFormatNum + 'static,

Opens a new audio stream for recording with the specified spec. The device begins paused, so you must call stream.resume() to start recording.

Trait Implementations

impl Clone for AudioDevice

fn clone(&self) -> AudioDevice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Drop for AudioDevice

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for AudioDevice

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for AudioDevice