Interface AudioVideoObserver

interface AudioVideoObserver {
    audioVideoDidStart(): void;
    audioVideoDidStartConnecting(reconnecting: boolean): void;
    audioVideoDidStop(sessionStatus: MeetingSessionStatus): void;
    audioVideoWasDemotedFromPrimaryMeeting(status: MeetingSessionStatus): void;
    connectionDidBecomeGood(): void;
    connectionDidBecomePoor(): void;
    connectionDidSuggestStopVideo(): void;
    connectionHealthDidChange(connectionHealthData: ConnectionHealthData): void;
    encodingSimulcastLayersDidChange(simulcastLayers: SimulcastLayers): void;
    metricsDidReceive(clientMetricReport: ClientMetricReport): void;
    remoteVideoSourcesDidChange(videoSources: VideoSource[]): void;
    videoAvailabilityDidChange(
        availability: MeetingSessionVideoAvailability,
    ): void;
    videoSendDidBecomeUnavailable(): void;
    videoTileDidUpdate(tileState: VideoTileState): void;
    videoTileWasRemoved(tileId: number): void;
}

Implemented by

Methods

  • This observer callback will only be called for attendees in Replica meetings.

    Indicates that the client is no longer authenticated to the Primary meeting and can no longer share media. status will contain a MeetingSessionStatusCode of the following:

    • MeetingSessionStatusCode.OK: demoteFromPrimaryMeeting was used to remove the attendee.
    • MeetingSessionStatusCode.AudioAuthenticationRejected: chime::DeleteAttendee was called on the Primary meeting attendee used in promoteToPrimaryMeeting.
    • MeetingSessionStatusCode.AudioVideoDisconnectedWhilePromoted: The client disconnected (and may be reconnecting). Any disconnection will trigger an automatic demotion to avoid unexpected or unwanted promotion state on reconnection.

    Parameters

    Returns void

  • Called when connection has changed to good from poor. This will be fired regardless whether the meeting is audio-only or uses audio video.

    Returns void

  • Called when the connection has been poor if meeting uses video so that the observer can prompt the user about turning off video.

    Returns void

  • Called when a user tries to start a video but by the time the backend processes the request, video capacity has been reached and starting local video is not possible. This can be used to trigger a message to the user about the situation.

    Returns void