Struct cubeb_core::StreamRef

pub struct StreamRef(_);

Methods

impl StreamRef

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

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

pub fn as_ptr(&self) -> *mut cubeb_stream

impl StreamRef

pub fn start(&self) -> Result<()>

Start playback.

pub fn stop(&self) -> Result<()>

Stop playback.

pub fn reset_default_device(&self) -> Result<()>

Reset stream to the default device.

pub fn position(&self) -> Result<u64>

Get the current stream playback position.

pub fn latency(&self) -> Result<u32>

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.

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

Set the volume for a stream.

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

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).

pub fn current_device(&self) -> Result<&DeviceRef>

Get the current output device for this stream.

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

Destroy a cubeb_device structure.

pub fn register_device_changed_callback(
    &self,
    callback: cubeb_device_changed_callback
) -> Result<()>

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

pub fn user_ptr(&self) -> *mut c_void

Trait Implementations

impl AsRef<StreamRef> for Stream

fn as_ref(&self) -> &StreamRef

Performs the conversion.

impl Debug for StreamRef

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

Formats the value using the given formatter.

impl Borrow<StreamRef> for Stream

fn borrow(&self) -> &StreamRef

Immutably borrows from an owned value.