Struct SipOutboundConfig 

pub struct SipOutboundConfig {
    pub hostname: String,
    pub destination_country: String,
    pub transport: i32,
    pub auth_username: String,
    pub auth_password: String,
    pub headers_to_attributes: HashMap<String, String>,
    pub attributes_to_headers: HashMap<String, String>,
    pub from_host: String,
}

Fields

hostname: String

SIP server address

destination_country: String

country where the call terminates as ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will be used by the livekit infrastructure to route calls.

transport: i32

SIP Transport used for outbound call.

auth_username: String

Username and password used to authenticate with SIP server. May be empty to have no authentication.

auth_password: String

headers_to_attributes: HashMap<String, String>

Map SIP X-* headers from 200 OK to SIP participant attributes. Keys are the names of X-* headers and values are the names of attributes they will be mapped to.

attributes_to_headers: HashMap<String, String>

Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests. Keys are the names of attributes and values are the names of X-* headers they will be mapped to.

from_host: String

Optional custom hostname for the ‘From’ SIP header. When set, outbound calls use this host instead of the default project SIP domain.

Implementations

impl SipOutboundConfig

pub fn transport(&self) -> SipTransport

Returns the enum value of transport, or the default if the field is set to an invalid enum value.

pub fn set_transport(&mut self, value: SipTransport)

Sets transport to the provided enum value.

Trait Implementations

impl Clone for SipOutboundConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SipOutboundConfig

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

Formats the value using the given formatter.

impl Default for SipOutboundConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SipOutboundConfig

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for SipOutboundConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for SipOutboundConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SipOutboundConfig

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SipOutboundConfig