Enum Command

pub enum Command {
    JoinRoom {
        member_id: MemberId,
        credential: Credential,
        capabilities: Capabilities,
    },
    LeaveRoom {
        member_id: MemberId,
    },
    MakeSdpOffer {
        peer_id: PeerId,
        sdp_offer: String,
        mids: HashMap<TrackId, String>,
        transceivers_statuses: HashMap<TrackId, bool>,
    },
    MakeSdpAnswer {
        peer_id: PeerId,
        sdp_answer: String,
        transceivers_statuses: HashMap<TrackId, bool>,
    },
    SetIceCandidate {
        peer_id: PeerId,
        candidate: IceCandidate,
    },
    AddPeerConnectionMetrics {
        peer_id: PeerId,
        metrics: PeerMetrics,
    },
    UpdateTracks {
        peer_id: PeerId,
        tracks_patches: Vec<TrackPatchCommand>,
    },
    SynchronizeMe {
        state: Room,
    },
}

Possible commands sent by Web Client to Media Server.

Variants

JoinRoom

Request to join a Room.

Fields

member_id: MemberId

ID of the Member who joins the Room.

credential: Credential

Credential of the Member to authenticate with.

capabilities: Capabilities

Capabilities reported by Web Client (e.g. available codecs, platform).

LeaveRoom

Request to leave a Room.

Fields

member_id: MemberId

ID of the Member who leaves the Room.

MakeSdpOffer

Web Client sends SDP Offer.

Fields

peer_id: PeerId

ID of the Peer SDP Offer is sent for.

sdp_offer: String

SDP Offer of the Peer.

mids: HashMap<TrackId, String>

Associations between Track and transceiver’s media description.

mid is basically an ID of m=<media> section in SDP.

transceivers_statuses: HashMap<TrackId, bool>

Statuses of the Peer transceivers.

MakeSdpAnswer

Web Client sends SDP Answer.

Fields

peer_id: PeerId

ID of the Peer SDP Answer is sent for.

sdp_answer: String

SDP Answer of the Peer.

transceivers_statuses: HashMap<TrackId, bool>

Statuses of the Peer transceivers.

SetIceCandidate

Web Client sends an Ice Candidate.

Fields

peer_id: PeerId

ID of the Peer the Ice Candidate is sent for.

candidate: IceCandidate

IceCandidate sent by the Peer.

AddPeerConnectionMetrics

Web Client sends Peer Connection metrics.

Fields

peer_id: PeerId

ID of the Peer metrics are sent for.

metrics: PeerMetrics

Metrics of the Peer.

UpdateTracks

Web Client asks permission to update Tracks in the specified Peer. Media Server gives permission by sending Event::PeerUpdated.

Fields

peer_id: PeerId

ID of the Peer to update Tracks in.

tracks_patches: Vec<TrackPatchCommand>

Patches for updating the Tracks.

SynchronizeMe

Web Client asks Media Server to synchronize Client State with a Server State.

Fields

state: Room

Whole Client State of the Room.

Implementations

impl Command

pub fn dispatch_with<T: CommandHandler>( self, handler: &mut T, ) -> <T as CommandHandler>::Output

Dispatches Command with given CommandHandler.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Command

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Command

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

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 Command