Struct cpal::Endpoint

pub struct Endpoint(_);

An opaque type that identifies an endpoint that is capable of playing audio.

Please note that endpoints may become invalid if they get disconnected. Therefore all the methods that involve an endpoint return a Result.

Methods

impl Endpoint

fn supported_formats(
    &self
) -> Result<SupportedFormatsIterator, FormatsEnumerationError>

Returns an iterator that produces the list of formats that are supported by the backend.

Can return an error if the endpoint is no longer valid (eg. it has been disconnected). The returned iterator should never be empty.

fn get_supported_formats_list(
    &self
) -> Result<SupportedFormatsIterator, FormatsEnumerationError>

Deprecated

Deprecated. Use supported_formats instead.

fn name(&self) -> String

Returns the name of the endpoint.

fn get_name(&self) -> String

Deprecated

Deprecated. Use name() instead.

Trait Implementations

impl Clone for Endpoint

fn clone(&self) -> Endpoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for Endpoint

fn eq(&self, __arg_0: &Endpoint) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &Endpoint) -> bool

This method tests for !=.

impl Eq for Endpoint