Module api

Source

Modules§

apply_request
Nested message and enum types in ApplyRequest.
control_api_client
Generated client implementations.
control_api_server
Generated server implementations.
create_request
Nested message and enum types in CreateRequest.
element
Nested message and enum types in Element.
member
Nested message and enum types in Member.
room
Nested message and enum types in Room.
web_rtc_publish_endpoint
Nested message and enum types in WebRtcPublishEndpoint.

Structs§

ApplyRequest
Request for applying a spec to an exiting Element on a media server.
CreateRequest
Request for creating a new Element on a media server.
CreateResponse
Response of ControlApi.Create RPC method.
Element
Possible media elements forming a media pipeline.
Error
Error of a failed request.
GetResponse
Response of ControlApi.Get RPC method.
IdRequest
Request with many FIDs (Full IDs) of Elements.
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.
Response
Response which doesn’t return anything on success, but is fallible with an Error.
Room
Media element representing a single space where multiple Members can interact with each other.
WebRtcPlayEndpoint
Media element playing media data for a client via WebRTC.
WebRtcPublishEndpoint
Media element receiving media data from a client via WebRTC (allows to publish media data).