Struct CreateSIPParticipantOptions

pub struct CreateSIPParticipantOptions {
    pub participant_identity: String,
    pub participant_name: Option<String>,
    pub participant_metadata: Option<String>,
    pub participant_attributes: Option<HashMap<String, String>>,
    pub sip_number: Option<String>,
    pub dtmf: Option<String>,
    pub play_dialtone: Option<bool>,
    pub hide_phone_number: Option<bool>,
    pub ringing_timeout: Option<Duration>,
    pub max_call_duration: Option<Duration>,
    pub enable_krisp: Option<bool>,
}

Fields

participant_identity: String

Optional identity of the participant in LiveKit room

participant_name: Option<String>

Optionally set the name of the participant in a LiveKit room

participant_metadata: Option<String>

Optionally set the free-form metadata of the participant in a LiveKit room

participant_attributes: Option<HashMap<String, String>>

sip_number: Option<String>

dtmf: Option<String>

Optionally send following DTMF digits (extension codes) when making a call. Character ‘w’ can be used to add a 0.5 sec delay.

play_dialtone: Option<bool>

Optionally play dialtone in the room as an audible indicator for existing participants

hide_phone_number: Option<bool>

ringing_timeout: Option<Duration>

max_call_duration: Option<Duration>

enable_krisp: Option<bool>

Trait Implementations

impl Clone for CreateSIPParticipantOptions

fn clone(&self) -> CreateSIPParticipantOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateSIPParticipantOptions

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

Formats the value using the given formatter.

impl Default for CreateSIPParticipantOptions

fn default() -> CreateSIPParticipantOptions

Returns the “default value” for a type.