Crate medea_client_api_proto[−][src]
Client API protocol implementation for Medea media server.
Features
jason
: EnablesDeserialize
implementation forEvent
s, andSerialize
implementation forCommand
s.medea
: EnablesDeserialize
implementation forCommand
s, andSerialize
implementation forEvent
s.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 |
IceCandidate | Represents RTCIceCandidateInit object. |
IceServer | Representation of RTCIceServer (item of |
MemberId | ID of |
PeerId | ID of |
RoomId | ID of |
RpcSettings | RPC settings of |
Track |
|
TrackId | ID of |
TrackPatchCommand | Patch of the |
TrackPatchEvent | Patch of the |
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 |
Event | WebSocket message from Medea to Jason. |
IceConnectionState | Peer Connection’s ICE connection state. |
MediaSourceKind | Media source kind. |
MediaType | Type of |
NegotiationRole |
|
PeerConnectionState | Peer Connection’s connection state. |
PeerMetrics | Web Client’s Peer Connection metrics. |
PeerUpdate |
|
ServerMsg | Message sent by |
Traits
CommandHandler | Handler of |
EventHandler | Handler of |
Incrementable | Value that is able to be incremented by |