Struct ChannelDefinition

#[non_exhaustive]
pub struct ChannelDefinition {
    pub channel_id: i32,
    pub participant_role: Option<ParticipantRole>,
}

Makes it possible to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).

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.

channel_id: i32

Specify the audio channel you want to define.

participant_role: Option<ParticipantRole>

Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.

Implementations

impl ChannelDefinition

pub fn channel_id(&self) -> i32

Specify the audio channel you want to define.

pub fn participant_role(&self) -> Option<&ParticipantRole>

Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.

impl ChannelDefinition

pub fn builder() -> ChannelDefinitionBuilder

Creates a new builder-style object to manufacture ChannelDefinition.

Trait Implementations

impl Clone for ChannelDefinition

fn clone(&self) -> ChannelDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelDefinition

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

Formats the value using the given formatter.

impl PartialEq for ChannelDefinition

fn eq(&self, other: &ChannelDefinition) -> 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 StructuralPartialEq for ChannelDefinition