Struct cubeb::StreamRef

pub struct StreamRef(_);

Methods

impl StreamRef

fn start(&self) -> Result<(), Error>

Start playback.

fn stop(&self) -> Result<(), Error>

Stop playback.

fn reset_default_device(&self) -> Result<(), Error>

Reset stream to the default device.

fn position(&self) -> Result<u64, Error>

Get the current stream playback position.

fn latency(&self) -> Result<u32, Error>

Get the latency for this stream, in frames. This is the number of frames between the time cubeb acquires the data in the callback and the listener can hear the sound.

fn set_volume(&self, volume: f32) -> Result<(), Error>

Set the volume for a stream.

fn set_panning(&self, panning: f32) -> Result<(), Error>

If the stream is stereo, set the left/right panning. If the stream is mono, this has no effect.

panning a number from -1.0 to 1.0. -1.0 means that the stream is fully mixed in the left channel, 1.0 means the stream is fully mixed in the right channel. 0.0 is equal power in the right and left channel (default).

fn current_device(&self) -> Result<&DeviceRef, Error>

Get the current output device for this stream.

fn device_destroy(&self, device: DeviceRef) -> Result<(), Error>

Destroy a cubeb_device structure.

fn register_device_changed_callback(
    &self,
    callback: Option<unsafe extern "C" fn(*mut c_void)>
) -> Result<(), Error>

Set a callback to be notified when the output device changes.

fn user_ptr(&self) -> *mut c_void

impl StreamRef

unsafe fn from_ptr<'a>(ptr: *mut cubeb_stream) -> &'a StreamRef

unsafe fn from_ptr_mut<'a>(ptr: *mut cubeb_stream) -> &'a mut StreamRef

fn as_ptr(&self) -> *mut cubeb_stream

Trait Implementations

impl Debug for StreamRef

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

Formats the value using the given formatter.