meet
This file contains MediaApiClientInterface
.
Summary
It is designed to utilize the PeerConnection interface.
It demonstrates "how-to", and establishes the required configurations and SCTP/SRTP connections with Meet servers. These connections enable the streaming of conference metadata, video, and audio streams from Google Meet conferences to the client.
All conference media streams are "receive-only". Currently, the Meet Media API does not support sending of media from MediaApiClientInterface
into a conference.
API requests from the client intended to affect application state of a conference or received media (e.g. change video resolution), are transmitted via SCTP data channels. This is in contrast to typical API requests over HTTP or RPC.
The following steps are needed to set up a typical Meet Media API session:
- Create an implementation of the
MediaApiClientObserverInterface. - Create a
MediaApiClientInterfaceusing an implementation of theMediaApiClientFactoryInterface. - Call
MediaApiClientInterface::ConnectActiveConferencewith the appropriate parameters. This initiates the connection with Meet servers. - Wait for the
MediaApiClientObserverInterface::OnJoinedcallback to be invoked. - If video was enabled, send a
meet::SetVideoAssignmentRequestviaMediaApiClientInterface::SendRequest. No video will be transmitted from Meet servers to the client until a successful request has been sent. Checkvideo_assignment_resource.hfor more information.
Typedefs
std::variant< SessionControlChannelFromClient
, VideoAssignmentChannelFromClient
, MediaStatsChannelFromClient
>
std::variant< SessionControlChannelToClient
, VideoAssignmentChannelToClient
, MediaEntriesChannelToClient
, ParticipantsChannelToClient
, MediaStatsChannelToClient
>
Classes
Interface for instantiating MediaApiClientInterface
.
Interface for the Meet Media API client.
Interface for observing client events.
Structs
Anonymous user.
Required dimensions of the canvas.
Tells the server that the client is about to disconnect.
The top-level transport container for messages sent from server to client in the media-entries
data channel.
The top-level transport container for messages sent from client to server in the media-stats
data channel.
The top-level transport container for messages sent from server to client in the media-stats
data channel.
The configuration for the media stats upload.
A resource snapshot managed by the server and replicated to the client.
This type represents an RTCStats
-derived dictionary which is returned by calling RTCPeerConnection::getStats
.
A resource snapshot managed by the server and replicated to the client.
The top-level transport container for messages converted from proto to C++ struct.
Phone user, always has a display name.
The top-level transport container for messages sent from client to server in the session-control
data channel.
The top-level transport container for messages sent from server to client in the session-control
data channel.
An optional response from Meet servers to an incoming request.
This is a singleton resource containing the status of the media session.
Signed in user type. Always has a unique ID and display name.
Uploads media stats from the client to the server.
The top-level transport container for messages sent from client to server in the video-assignment
data channel.
The top-level transport container for messages sent from server to client in the video-assignment
data channel.
A resource snapshot managed by the server and replicated to the client.
Typedefs
ResourceRequest
std :: variant < SessionControlChannelFromClient , VideoAssignmentChannelFromClient , MediaStatsChannelFromClient > ResourceRequest
Requests that can be sent to Meet servers.
Requests can expect a corresponding response via the MediaApiClientObserverInterface
.
ResourceUpdate
std :: variant < SessionControlChannelToClient , VideoAssignmentChannelToClient , MediaEntriesChannelToClient , ParticipantsChannelToClient , MediaStatsChannelToClient > ResourceUpdate
Updates that can be received from Meet servers.
Updates can be received in response to a request sent via MediaApiClientInterface::SendRequest
or from a push from Meet servers.
