Struct cubeb_core::ContextRef

source ·
pub struct ContextRef(/* private fields */);

Implementations§

source§

impl ContextRef

source

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

Safety

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

source

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

Safety

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

source

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

source§

impl ContextRef

source

pub fn backend_id(&self) -> &str

source

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

source

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

source

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

source

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

source

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

source

pub unsafe fn stream_init( &self, stream_name: Option<&CStr>, input_device: DeviceId, input_stream_params: Option<&StreamParamsRef>, output_device: DeviceId, output_stream_params: Option<&StreamParamsRef>, latency_frames: u32, data_callback: cubeb_data_callback, state_callback: cubeb_state_callback, user_ptr: *mut c_void ) -> Result<Stream>

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.

source

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

source

pub unsafe fn register_device_collection_changed( &self, devtype: DeviceType, callback: cubeb_device_collection_changed_callback, user_ptr: *mut c_void ) -> Result<()>

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§

source§

impl AsRef<ContextRef> for Context

source§

fn as_ref(&self) -> &ContextRef

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

impl Borrow<ContextRef> for Context

source§

fn borrow(&self) -> &ContextRef

Immutably borrows from an owned value. Read more
source§

impl Debug for ContextRef

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.