Struct medea_control_api_proto::grpc::api::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 which represents a client authorized to participate in a some bigger media pipeline.

Fields

id: String

ID of this Member.

on_join: String

Callback which fires when the Member establishes persistent connection with a media server via Client API.

on_leave: String

Callback which fires when the Member finishes persistent connection with a media server via Client API.

idle_timeout: Option<Duration>

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

reconnect_timeout: Option<Duration>

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

ping_interval: Option<Duration>

Interval of sending pings from a media server to the Member via Client API.

pipeline: HashMap<String, Element>

Pipeline of this Member.

credentials: Option<Credentials>

Credentials of the Member to authorize via 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 token if hashed credentials are used, so token query parameter should be appended manually.

Trait Implementations

impl Clone for Member

fn clone(&self) -> Member

Returns a copy 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 Message for Member

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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, 

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

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

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

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

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, 

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

impl PartialEq<Member> for Member

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Member