Enum Message

pub enum Message {
    Join(JoinResponse),
    Answer(SessionDescription),
    Offer(SessionDescription),
    Trickle(TrickleRequest),
    Update(ParticipantUpdate),
    TrackPublished(TrackPublishedResponse),
    Leave(LeaveRequest),
    Mute(MuteTrackRequest),
    SpeakersChanged(SpeakersChanged),
    RoomUpdate(RoomUpdate),
    ConnectionQuality(ConnectionQualityUpdate),
    StreamStateUpdate(StreamStateUpdate),
    SubscribedQualityUpdate(SubscribedQualityUpdate),
    SubscriptionPermissionUpdate(SubscriptionPermissionUpdate),
    RefreshToken(String),
    TrackUnpublished(TrackUnpublishedResponse),
    Pong(i64),
    Reconnect(ReconnectResponse),
    PongResp(Pong),
    SubscriptionResponse(SubscriptionResponse),
    RequestResponse(RequestResponse),
    TrackSubscribed(TrackSubscribed),
    RoomMoved(RoomMovedResponse),
}

Variants

Join(JoinResponse)

sent when join is accepted

Answer(SessionDescription)

sent when server answers publisher

Offer(SessionDescription)

sent when server is sending subscriber an offer

Trickle(TrickleRequest)

sent when an ICE candidate is available

Update(ParticipantUpdate)

sent when participants in the room has changed

TrackPublished(TrackPublishedResponse)

sent to the participant when their track has been published

Leave(LeaveRequest)

Immediately terminate session

Mute(MuteTrackRequest)

server initiated mute

SpeakersChanged(SpeakersChanged)

indicates changes to speaker status, including when they’ve gone to not speaking

RoomUpdate(RoomUpdate)

sent when metadata of the room has changed

ConnectionQuality(ConnectionQualityUpdate)

when connection quality changed

StreamStateUpdate(StreamStateUpdate)

when streamed tracks state changed, used to notify when any of the streams were paused due to congestion

SubscribedQualityUpdate(SubscribedQualityUpdate)

when max subscribe quality changed, used by dynamic broadcasting to disable unused layers

SubscriptionPermissionUpdate(SubscriptionPermissionUpdate)

when subscription permission changed

RefreshToken(String)

update the token the client was using, to prevent an active client from using an expired token

TrackUnpublished(TrackUnpublishedResponse)

server initiated track unpublish

Pong(i64)

respond to ping

deprecated by pong_resp (message Pong)

Reconnect(ReconnectResponse)

sent when client reconnects

PongResp(Pong)

respond to Ping

SubscriptionResponse(SubscriptionResponse)

Subscription response, client should not expect any media from this subscription if it fails

RequestResponse(RequestResponse)

Response relating to user inititated requests that carry a request_id

TrackSubscribed(TrackSubscribed)

notify to the publisher when a published track has been subscribed for the first time

RoomMoved(RoomMovedResponse)

notify to the participant when they have been moved to a new room

Implementations

impl Message

pub fn encode<B>(&self, buf: &mut B)

where B: BufMut,

Encodes the message to a buffer.

pub fn merge<B>( field: &mut Option<Message>, tag: u32, wire_type: WireType, buf: &mut B, ctx: DecodeContext, ) -> Result<(), DecodeError>

where B: Buf,

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

pub fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl PartialEq for Message

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