Crate medea_control_api_proto

Medea Control API protocol

API docs | Changelog

API Docs | Changelog

Control API protocol implementation for Medea media server.

Only gRPC is supported at the moment.

License

Copyright © 2021-2023 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
  ControlApi definitions.
• endpoint
  Endpoint definitions.
• member
  Member definitions.
• room
  Room definitions.

Structs

• Endpoint
  Media Element flowing one or more media data streams through itself.
• Member
  Media Element representing a client authorized to participate in some bigger media pipeline (Room, for example).
• Ping
  Ping message received by a media server periodically for probing its healthiness.
• Pong
  Pong message sent by a media server in response to a received Ping message.
• Room
  Media Element representing a single space where multiple Members can interact with each other.

Enums

• Element
  All possible media elements of ControlApi.
• Fid
  FID (Full ID) is a composition of media Element IDs referring to some Element on a whole media server uniquely.
• RootElement
  Possible Elements allowed to act as a root of ControlApi static spec.

Traits

• CallbackApi
  API for receiving callbacks from a media server.
• ControlApi
  API allowing to control a media server dynamically, by creating, updating and destroying pipelines of media Elements on it.

Type Definitions

• Elements
  Collection of uniquely identified Elements.