Expand description
§Medea Control API protocol
Control API protocol implementation for Medea media server.
Only gRPC and direct (channel based) are supported at the moment.
§License
Copyright © 2021-2025 Instrumentisto Team https://github.com/instrumentisto
This software is subject to the terms of the Blue Oak Model License 1.0.0. If a copy of the BlueOak-1.0.0 license was not distributed with this file, You can obtain one at https://blueoakcouncil.org/license/1.0.0.
Modules§
- callback
- API for receiving callbacks from a media server.
- control
ControlApidefinitions.- endpoint
Endpointdefinitions.- grpc
- gRPC-based Control API implementation.
- member
Memberdefinitions.- room
Roomdefinitions.
Structs§
- Endpoint
- Media
Elementflowing one or more media data streams through itself. - Member
- Media
Elementrepresenting a client authorized to participate in some bigger media pipeline (Room, for example). - Ping
Pingmessage received by a media server periodically for probing its healthiness.- Pong
Pongmessage sent by a media server in response to a receivedPingmessage.- Room
- Media
Elementrepresenting a single space where multipleMembers can interact with each other.
Enums§
- Element
- All possible media elements of
ControlApi. - Fid
- FID (Full ID) is a composition of media
ElementIDs referring to someElementon a whole media server uniquely. - Root
Element - Possible
Elements allowed to act as a root ofControlApistatic spec.
Traits§
- Callback
Api - API for receiving callbacks from a media server.
- Control
Api - API allowing to control a media server dynamically, by creating, updating
and destroying pipelines of media
Elements on it.