Enum Event 

pub enum Event {
    RoomJoined {
        member_id: MemberId,
        is_reconnect: bool,
    },
    RoomLeft {
        close_reason: CloseReason,
    },
    PeerCreated {
        peer_id: PeerId,
        negotiation_role: NegotiationRole,
        connection_mode: ConnectionMode,
        tracks: Vec<Track>,
        ice_servers: Vec<IceServer>,
        force_relay: bool,
        stats_scrape_interval_ms: u32,
    },
    SdpAnswerMade {
        peer_id: PeerId,
        sdp_answer: String,
    },
    LocalDescriptionApplied {
        peer_id: PeerId,
        sdp_offer: String,
    },
    IceCandidateDiscovered {
        peer_id: PeerId,
        candidate: IceCandidate,
    },
    PeersRemoved {
        peer_ids: Vec<PeerId>,
    },
    PeerUpdated {
        peer_id: PeerId,
        updates: Vec<PeerUpdate>,
        negotiation_role: Option<NegotiationRole>,
    },
    ConnectionQualityUpdated {
        partner_member_id: MemberId,
        quality_score: ConnectionQualityScore,
    },
    StateSynchronized {
        state: Room,
    },
}

Possible WebSocket messages sent from Media Server to Web Client.

Variants

RoomJoined

Media Server notifies Web Client that a Member joined a Room.

Fields

member_id: MemberId

ID of the Member who joined the Room.

is_reconnect: bool

Indicator whether Media Server considers this Room connection as a reconnect, meaning that there is already some runtime state on the Media Server for the specified MemberId-Credential pair.

Server expects Command::SynchronizeMe if this is true.

RoomLeft

Media Server notifies Web Client that a Member left a Room.

Fields

close_reason: CloseReason

CloseReason with which the Member left the Room.

PeerCreated

Media Server notifies Web Client about necessity of an RTCPeerConnection creation.

Fields

peer_id: PeerId

ID of the Peer to create an RTCPeerConnection for.

negotiation_role: NegotiationRole

NegotiationRole of the Peer.

connection_mode: ConnectionMode

Indicator whether this Peer is working in a P2P mesh or SFU mode.

tracks: Vec<Track>

Tracks to create an RTCPeerConnection with.

ice_servers: Vec<IceServer>

IceServers to create an RTCPeerConnection with.

force_relay: bool

Indicator whether the created RTCPeerConnection should be forced to use relay IceServers only.

stats_scrape_interval_ms: u32

Interval (in milliseconds) of RTCPeerConnection’s stats scraping.

0 disables stats scraping.

SdpAnswerMade

Media Server notifies Web Client about necessity to apply the specified SDP Answer to Web Client’s RTCPeerConnection.

Fields

peer_id: PeerId

ID of the Peer to apply SDP Answer to.

sdp_answer: String

SDP Answer to be applied.

LocalDescriptionApplied

Media Server notifies Web Client that his SDP offer was applied.

Fields

peer_id: PeerId

ID of the Peer which SDP offer was applied.

sdp_offer: String

SDP offer that was applied.

IceCandidateDiscovered

Media Server notifies Web Client about necessity to apply the specified ICE Candidate.

Fields

peer_id: PeerId

ID of the Peer to apply ICE Candidate to.

candidate: IceCandidate

ICE Candidate to be applied.

PeersRemoved

Media Server notifies Web Client about necessity of the RTCPeerConnection close.

Fields

peer_ids: Vec<PeerId>

IDs of Peers to be removed.

PeerUpdated

Media Server notifies about necessity to update Tracks in a Peer.

Fields

peer_id: PeerId

ID of the Peer to update Tracks in.

updates: Vec<PeerUpdate>

List of PeerUpdates which should be applied.

negotiation_role: Option<NegotiationRole>

Negotiation role basing on which should be sent Command::MakeSdpOffer or Command::MakeSdpAnswer.

If None then no (re)negotiation should be done.

ConnectionQualityUpdated

Media Server notifies about connection quality score update.

Fields

partner_member_id: MemberId

Partner MemberId of the Peer.

quality_score: ConnectionQualityScore

Estimated connection quality.

StateSynchronized

Media Server synchronizes Web Client state and reports the proper one.

Fields

state: Room

Proper state that should be assumed by Web Client.

Implementations

impl Event

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

Dispatches Event with given EventHandler.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Event

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Event

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Event

impl StructuralPartialEq for Event