Struct Context

pub struct Context(/* private fields */);

Implementations

impl Context

pub unsafe fn from_ptr(ptr: *mut cubeb) -> Context

Safety

This function is unsafe because it dereferences the given ptr pointer. The caller should ensure that pointer is valid.

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

impl Context

pub fn init( context_name: Option<&CStr>, backend_name: Option<&CStr>, ) -> Result<Context, Error>

Methods from Deref<Target = ContextRef>

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

pub fn backend_id(&self) -> &str

pub fn backend_id_bytes(&self) -> &[u8]

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

pub fn min_latency(&self, params: &StreamParamsRef) -> Result<u32, Error>

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

pub fn supported_input_processing_params( &self, ) -> Result<InputProcessingParams, Error>

pub unsafe fn stream_init( &self, stream_name: Option<&CStr>, input_device: *const c_void, input_stream_params: Option<&StreamParamsRef>, output_device: *const c_void, output_stream_params: Option<&StreamParamsRef>, latency_frames: u32, data_callback: Option<unsafe extern "C" fn(*mut cubeb_stream, *mut c_void, *const c_void, *mut c_void, i64) -> i64>, state_callback: Option<unsafe extern "C" fn(*mut cubeb_stream, *mut c_void, u32)>, user_ptr: *mut c_void, ) -> Result<Stream, Error>

Safety

This function is unsafe because it dereferences the given data_callback, state_callback, and user_ptr pointers. The caller should ensure those pointers are valid.

pub fn enumerate_devices( &self, devtype: DeviceType, ) -> Result<DeviceCollection<'_>, Error>

pub unsafe fn register_device_collection_changed( &self, devtype: DeviceType, callback: Option<unsafe extern "C" fn(*mut cubeb, *mut c_void)>, user_ptr: *mut c_void, ) -> Result<(), Error>

Safety

This function is unsafe because it dereferences the given callback and user_ptr pointers. The caller should ensure those pointers are valid.

Trait Implementations

impl AsRef<ContextRef> for Context

fn as_ref(&self) -> &ContextRef

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<ContextRef> for Context

fn borrow(&self) -> &ContextRef

Immutably borrows from an owned value.

impl Deref for Context

type Target = ContextRef

The resulting type after dereferencing.

fn deref(&self) -> &ContextRef

Dereferences the value.

impl DerefMut for Context

fn deref_mut(&mut self) -> &mut ContextRef

Mutably dereferences the value.

impl Drop for Context

fn drop(&mut self)

Executes the destructor for this type.