Struct RoomConfiguration

pub struct RoomConfiguration {
    pub name: String,
    pub empty_timeout: u32,
    pub departure_timeout: u32,
    pub max_participants: u32,
    pub egress: Option<RoomEgress>,
    pub min_playout_delay: u32,
    pub max_playout_delay: u32,
    pub sync_streams: bool,
    pub agents: Vec<RoomAgentDispatch>,
}

Fields

name: String

Used as ID, must be unique

empty_timeout: u32

number of seconds to keep the room open if no one joins

departure_timeout: u32

number of seconds to keep the room open after everyone leaves

max_participants: u32

limit number of participants that can be in a room, excluding Egress and Ingress participants

egress: Option<RoomEgress>

egress

min_playout_delay: u32

playout delay of subscriber

max_playout_delay: u32

sync_streams: bool

improves A/V sync when playout_delay set to a value larger than 200ms. It will disables transceiver re-use so not recommended for rooms with frequent subscription changes

agents: Vec<RoomAgentDispatch>

Define agents that should be dispatched to this room

Trait Implementations

impl Clone for RoomConfiguration

fn clone(&self) -> RoomConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoomConfiguration

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

Formats the value using the given formatter.

impl Default for RoomConfiguration

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RoomConfiguration

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for RoomConfiguration

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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

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

where B: Buf, Self: Sized,

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

impl PartialEq for RoomConfiguration

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

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 RoomConfiguration