Struct AudioEndpoint 

#[non_exhaustive]
pub struct AudioEndpoint {
    pub destination: Option<String>,
    pub variables: Option<Variables>,
}

Audio device endpoint for portaudio, pulseaudio, or ALSA modules.

Wire format: {module}[/{destination}] where destination is typically empty or auto_answer (recognized by portaudio and pulseaudio).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

destination: Option<String>

Destination string (e.g. auto_answer). None for bare module name.

variables: Option<Variables>

Per-channel variables prepended as {key=value}.

Implementations

impl AudioEndpoint

pub fn new() -> Self

Create a new audio endpoint with no destination.

pub fn with_destination(self, destination: impl Into<String>) -> Self

Set the destination string.

pub fn with_variables(self, variables: Variables) -> Self

Set per-channel variables.

pub fn fmt_with_prefix(&self, f: &mut Formatter<'_>, prefix: &str) -> Result

Format with the given module prefix (portaudio, pulseaudio, alsa).

pub fn parse_with_prefix(s: &str, prefix: &str) -> Result<Self, OriginateError>

Parse from a dial string with the given module prefix.

Trait Implementations

impl Clone for AudioEndpoint

fn clone(&self) -> AudioEndpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AudioEndpoint

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

Formats the value using the given formatter.

impl Default for AudioEndpoint

fn default() -> AudioEndpoint

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AudioEndpoint

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DialString for AudioEndpoint

fn variables(&self) -> Option<&Variables>

Per-endpoint variables, if any.

fn variables_mut(&mut self) -> Option<&mut Variables>

Mutable access to per-endpoint variables.

fn set_variables(&mut self, vars: Option<Variables>)

Replace per-endpoint variables.

impl Display for AudioEndpoint

Warning: This Display impl exists only to satisfy the DialString: Display trait bound. The "audio" prefix is not a valid FreeSWITCH endpoint. Always use AudioEndpoint through Endpoint::PortAudio, Endpoint::PulseAudio, or Endpoint::Alsa which call fmt_with_prefix with the correct module name.

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

Formats the value using the given formatter.

impl PartialEq for AudioEndpoint

fn eq(&self, other: &AudioEndpoint) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AudioEndpoint

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AudioEndpoint

impl StructuralPartialEq for AudioEndpoint