Crate medea_client_api_proto

Client API protocol implementation for Medea media server.

Features

• jason: Enables Deserialize implementation for Events, and Serialize implementation for Commands.
• medea: Enables Deserialize implementation for Commands, and Serialize implementation for Events.
• extended-stats: Enables unused RTC Stats DTOs.

Contribution guide

Avoid using 64 bit types. medea-jason uses wasm-bindgen to interop with JS, and exposing 64 bit types to JS will make wasm-bindgen to use BigInt64Array / BigUint64Array in its JS glue, which are not implemented or were implemented too recently in some UAs.

So its better to keep protocol 64-bit-types-clean to avoid things breaking by accident.

Modules

state	State of the Media Server which will be used for Client and Server synchronization.
stats	Contains DTOs for RTCPeerConnection metrics.

Structs

AudioSettings
CloseDescription	Description which is sent in Close WebSocket frame from Media Server to Web Client.
Credential	Credential used for Member authentication.
IceCandidate	Represents RTCIceCandidateInit object.
IceServer	Representation of RTCIceServer (item of iceServers field from RTCConfiguration).
MemberId	ID of Member.
PeerId	ID of Peer.
RoomId	ID of Room.
RpcSettings	RPC settings of Client received from Media Server.
Track	Track with specified direction.
TrackId	ID of MediaTrack.
TrackPatchCommand	Patch of the Track which Web Client can request with Command::UpdateTracks.
TrackPatchEvent	Patch of the Track which Media Server can send with Event::TracksApplied.
VideoSettings

Enums

ClientMsg	Message from 'Client' to 'Media Server'.
CloseReason	Reason of disconnecting Web Client from Media Server.
Command	WebSocket message from Web Client to Media Server.
ConnectionQualityScore	Estimated connection quality.
Direction	Direction of Track.
Event	WebSocket message from Medea to Jason.
IceConnectionState	Peer Connection's ICE connection state.
MediaSourceKind	Media source kind.
MediaType	Type of Track.
NegotiationRole	Peer's negotiation role.
PeerConnectionState	Peer Connection's connection state.
PeerMetrics	Web Client's Peer Connection metrics.
ServerMsg	Message sent by Media Server to Client.
TrackUpdate	Track update which should be applied to the Peer.

Traits

CommandHandler	Handler of Command variants.
EventHandler	Handler of Event variants.
Incrementable	Value that is able to be incremented by 1.