Interface MeetMediaApiClient
Interface for the MeetMediaApiClient. Takes a required configuration and
provides a set of subscribables to the client. Takes a
MeetMediaClientRequiredConfiguration
as a constructor parameter.
Signature
interface MeetMediaApiClient
Method signatures
| Name |
Description |
applyLayout(requests) |
Applies the given media layout requests. This is required to be able to request a video stream. Only accepts media layouts that have been created with the createMediaLayout function. |
createMediaLayout(canvasDimensions) |
Creates a new media layout. Only media layouts that are created with this function can be applied. Otherwise, the applyLayout function will throw an error. Once the media layout has been created, you can construct a request and apply it with the applyLayout function. These media layout objects are meant to be reused (can be reassigned to a different request) but are distinct per stream (need to be created for each stream). |
joinMeeting(communicationProtocol) |
Joins the meeting. |
leaveMeeting() |
Leaves the meeting. |
Property signatures
| Name |
Description |
mediaEntries |
The media entries in the meeting. Subscribable to changes in the media entry collection. |
meetStreamTracks |
The meet stream tracks in the meeting. Subscribable to changes in the meet stream track collection. |
participants |
The participants in the meeting. Subscribable to changes in the participant collection. |
presenter |
The presenter in the meeting. Subscribable to changes in the presenter. |
screenshare |
The screenshare in the meeting. Subscribable to changes in the screenshare. |
sessionStatus |
The status of the session. Subscribable to changes in the session status. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-05 UTC.
[null,null,["Last updated 2025-02-05 UTC."],[[["The `MeetMediaApiClient` interface allows developers to interact with the Google Meet media API, requiring a specific configuration upon initialization."],["It provides methods like `applyLayout` and `createMediaLayout` to manage media layouts, with layouts created using `createMediaLayout` being the only ones compatible with `applyLayout`."],["The interface offers `joinMeeting` and `leaveMeeting` methods to control meeting participation."],["The `MeetMediaApiClient` also exposes properties like `mediaEntries`, `meetStreamTracks`, `participants`, `presenter`, `screenshare`, and `sessionStatus`, which are subscribable to changes in their respective collections or statuses."],["This API is available through the Google Workspace Developer Preview Program, allowing early access to its features."]]],[]]
