Struct medea_control_api_proto::control::member::Spec

pub struct Spec {
    pub pipeline: Pipeline<Id, Spec>,
    pub credentials: Option<Credentials>,
    pub on_join: Option<Url>,
    pub on_leave: Option<Url>,
    pub idle_timeout: Option<Duration>,
    pub reconnect_timeout: Option<Duration>,
    pub ping_interval: Option<Duration>,
}

Spec of a Member media Element.

Fields

pipeline: Pipeline<Id, Spec>

Media Pipeline representing this Member media Element.

credentials: Option<Credentials>

Credentials to authenticate this Member in Client API with.

None if no authentication is required.

on_join: Option<Url>

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

on_leave: Option<Url>

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 for 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 None then the default interval of a media server is used, if configured.

Trait Implementations

impl Clone for Spec

fn clone(&self) -> Spec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Spec

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

Formats the value using the given formatter.

impl From<Spec> for PipelineSpec

fn from(original: Spec) -> PipelineSpec

Converts to this type from the input type.

impl PartialEq<Spec> for Spec

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Spec

impl StructuralEq for Spec

impl StructuralPartialEq for Spec