Struct Member

pub struct Member {
    pub id: String,
    pub on_join: String,
    pub on_leave: String,
    pub idle_timeout: Option<Duration>,
    pub reconnect_timeout: Option<Duration>,
    pub ping_interval: Option<Duration>,
    pub pipeline: HashMap<String, Element>,
    pub credentials: Option<Credentials>,
}

Media element representing a client authorized to participate in some bigger media pipeline (Room, for example).

Fields

id: String

ID of this Member.

on_join: String

URL of the callback to fire when this Member establishes a persistent connection with a media server via Client API.

on_leave: String

URL of the callback to fire when this Member finishes a persistent connection with a media server via Client API.

idle_timeout: Option<Duration>

Timeout of receiving heartbeat messages from this Member via Client API. Once reached, this Member is considered being idle.

reconnect_timeout: Option<Duration>

Timeout of reconnecting this Member via Client API. Once reached, this Member is considered disconnected.

ping_interval: Option<Duration>

Interval of pinging with heartbeat messages this Member via Client API by a media server. If empty then the default interval of a media server is used, if configured.

pipeline: HashMap<String, Element>

Media pipeline representing this Member.

credentials: Option<Credentials>

Credentials to authenticate this Member in Client API with.

Plain and hashed credentials are supported. If no credentials provided, then random plain string will be generated. If no authentication is required then empty plain string can be used.

Hashed variant only supports Argon2 hash at the moment. Member sid won’t contain a token query parameter if hashed credentials are used, so it should be appended manually on a client side.

Trait Implementations

impl Clone for Member

fn clone(&self) -> Member

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Member

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

Formats the value using the given formatter.

impl Default for Member

fn default() -> Self

Returns the “default value” for a type.

impl From<Member> for Member

fn from(member: Member) -> Self

Converts to this type from the input type.

impl Message for Member

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 Member

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

type Error = ProtobufError

The type returned in the event of a conversion error.

fn try_from(member: Member) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Member