Enum ConferenceVariable 

#[non_exhaustive]
pub enum ConferenceVariable {
    ConferenceName,
    ConferenceUuid,
    ConferenceMemberId,
    ConferenceModerator,
    ConferenceGhost,
    ConferenceRecording,
    ConferenceRecordingCanvas,
    ConferenceCallKey,
    ConferenceLastMatchingDigits,
    LastTransferedConference,
    ConferenceSilentEntry,
    ConferenceFlags,
    ConferenceMemberFlags,
    ConferenceControls,
    ConferencePosition,
    ConferenceJoinVolumeIn,
    ConferenceJoinVolumeOut,
    ConferenceJoinEnergyLevel,
    ConferenceMaxMembers,
    ConferenceModeratorPin,
    ConferenceEnforceSecurity,
    ConferenceEndconferenceGraceTime,
    ConferenceEnterSound,
    ConferenceExitSound,
    ConferenceMohSound,
    ConferencePerpetualSound,
    ConferencePermanentWaitModMoh,
    ConferenceAutoRecord,
    ConferenceInviteUri,
    ConferenceForceRate,
    ConferenceForceInterval,
    ConferenceForceChannels,
    ConferenceForceCanvasSize,
    ConferenceAutoOutcallCallerIdName,
    ConferenceAutoOutcallCallerIdNumber,
    ConferenceAutoOutcallTimeout,
    ConferenceAutoOutcallProfile,
    ConferenceAutoOutcallAnnounce,
    ConferenceAutoOutcallPrefix,
    ConferenceAutoOutcallMaxwait,
    ConferenceAutoOutcallDelimiter,
    ConferenceAutoOutcallSkipMemberBeep,
    ConferenceUtilsAutoOutcallFlags,
    HangupAfterConference,
    SuppliedPin,
    VideoBannerText,
}

mod_conference channel variable names (the part after the variable_ prefix).

Use with HeaderLookup::variable() for type-safe lookups.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ConferenceName

ConferenceUuid

The conference object’s UUID, minted per conference instance.

Not a correlation key on its own: a name is reusable as soon as the conference holding it tears down, and this value reaches an event stream only through a channel dump. A consumer grouping members across a log without dumps has to mint its own instance identity.

ConferenceMemberId

ConferenceModerator

true/false.

ConferenceGhost

true/false.

ConferenceRecording

Recording filename.

ConferenceRecordingCanvas

Canvas index, 1-based.

ConferenceCallKey

conference_<name>_<domain>_<caller_id_number>, cleared when the member leaves.

ConferenceLastMatchingDigits

Digits that matched a caller-control binding.

LastTransferedConference

Conference name, cleared once the transfer completes.

ConferenceSilentEntry

ConferenceFlags

ConferenceMemberFlags

ConferenceControls

ConferencePosition

ConferenceJoinVolumeIn

ConferenceJoinVolumeOut

ConferenceJoinEnergyLevel

ConferenceMaxMembers

ConferenceModeratorPin

ConferenceEnforceSecurity

ConferenceEndconferenceGraceTime

ConferenceEnterSound

ConferenceExitSound

ConferenceMohSound

ConferencePerpetualSound

ConferencePermanentWaitModMoh

ConferenceAutoRecord

ConferenceInviteUri

ConferenceForceRate

ConferenceForceInterval

ConferenceForceChannels

ConferenceForceCanvasSize

ConferenceAutoOutcallCallerIdName

ConferenceAutoOutcallCallerIdNumber

ConferenceAutoOutcallTimeout

ConferenceAutoOutcallProfile

ConferenceAutoOutcallAnnounce

ConferenceAutoOutcallPrefix

ConferenceAutoOutcallMaxwait

ConferenceAutoOutcallDelimiter

ConferenceAutoOutcallSkipMemberBeep

ConferenceUtilsAutoOutcallFlags

HangupAfterConference

SuppliedPin

PIN carried as a URI parameter, searched for the configured parameter name before the digits are read.

VideoBannerText

Video overlay text, cleared by mod_conference once applied to the member.

Implementations

impl ConferenceVariable

pub const ALL: &'static [ConferenceVariable]

All variants, in declaration order (respecting any #[cfg] attributes).

pub fn as_str(&self) -> &'static str

Canonical protocol string.

Trait Implementations

impl AsRef<str> for ConferenceVariable

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ConferenceVariable

fn clone(&self) -> ConferenceVariable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ConferenceVariable

impl Debug for ConferenceVariable

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

Formats the value using the given formatter.

impl Display for ConferenceVariable

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

Formats the value using the given formatter.

impl Eq for ConferenceVariable

impl FromStr for ConferenceVariable

type Err = ParseConferenceVariableError

The associated error which can be returned from parsing.

fn from_str( s: &str, ) -> Result<ConferenceVariable, <ConferenceVariable as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for ConferenceVariable

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ConferenceVariable

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ConferenceVariable

impl VariableName for ConferenceVariable

fn as_str(&self) -> &str

Wire-format variable name (e.g. "sip_call_id").