Struct CodecNegotiation

pub struct CodecNegotiation { /* private fields */ }

Selects a codec and a set of capabilities for that codec, based on a preferential list of partially-defined codec capabilities, using each codec’s support to find best compatable matching capability. Currently supports SBC and AAC codec capabilities.

Implementations

impl CodecNegotiation

pub fn build( codecs: Vec<ServiceCapability>, direction: EndpointType, ) -> Result<Self>

Make a new codec negotiation set using codecs as an ordered list “ideal” capabilities. Capabilities earlier in the list are preferred if compatible when selecting. When selecting endpoints, ones of direction are chosen over ones other directions. Returns an error if any of the capabilities provided can’t be negotiated, or aren’t codecs.

pub fn select( &self, endpoints: &[StreamEndpoint], ) -> Option<(Vec<ServiceCapability>, StreamEndpointId)>

Given a set of endpoints, return the endpoint id, and the ServiceCapabilities we should request when configuring that endpoint for streaming, based on our preferences for codecs and delay reporting. Returns None if none of the endpoints can be supported by the supported codecs.

pub fn select_codec( &self, endpoints: &[StreamEndpoint], ) -> Option<(ServiceCapability, StreamEndpointId)>

Given a set of endpoints, return the endpoint id, and a ServiceCapability representing the selected compatible codec parameters for that endpoint, based on our preferences. Returns None if none of the endpoints can be supported by the preferred codecs.

pub fn set_direction(&mut self, direction: EndpointType)

Change the preferred direction. Calls to select after this call will prefer to match endpoints that are of direction

pub fn direction(&self) -> EndpointType

Returns the currently preferred direction

Trait Implementations

impl Clone for CodecNegotiation

fn clone(&self) -> CodecNegotiation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CodecNegotiation

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

Formats the value using the given formatter.