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.