LiveKit JS Client SDK - v2.16.0
    Preparing search index...

    Type Alias RoomEventCallbacks

    type RoomEventCallbacks = {
        activeDeviceChanged: (kind: MediaDeviceKind, deviceId: string) => void;
        activeSpeakersChanged: (speakers: Participant[]) => void;
        audioPlaybackChanged: (playing: boolean) => void;
        chatMessage: (
            message: ChatMessage,
            participant?: RemoteParticipant | LocalParticipant,
        ) => void;
        connected: () => void;
        connectionQualityChanged: (
            quality: ConnectionQuality,
            participant: Participant,
        ) => void;
        connectionStateChanged: (state: ConnectionState) => void;
        dataReceived: (
            payload: Uint8Array,
            participant?: RemoteParticipant,
            kind?: DataPacket_Kind,
            topic?: string,
            encryptionType?: Encryption_Type,
        ) => void;
        dcBufferStatusChanged: (isLow: boolean, kind: DataPacket_Kind) => void;
        disconnected: (reason?: DisconnectReason) => void;
        encryptionError: (error: Error, participant?: Participant) => void;
        localAudioSilenceDetected: (publication: LocalTrackPublication) => void;
        localTrackPublished: (
            publication: LocalTrackPublication,
            participant: LocalParticipant,
        ) => void;
        localTrackSubscribed: (
            publication: LocalTrackPublication,
            participant: LocalParticipant,
        ) => void;
        localTrackUnpublished: (
            publication: LocalTrackPublication,
            participant: LocalParticipant,
        ) => void;
        mediaDevicesChanged: () => void;
        mediaDevicesError: (error: Error, kind?: MediaDeviceKind) => void;
        metricsReceived: (metrics: MetricsBatch, participant?: Participant) => void;
        moved: (name: string) => void;
        participantActive: (participant: Participant) => void;
        participantAttributesChanged: (
            changedAttributes: Record<string, string>,
            participant: RemoteParticipant | LocalParticipant,
        ) => void;
        participantConnected: (participant: RemoteParticipant) => void;
        participantDisconnected: (participant: RemoteParticipant) => void;
        participantEncryptionStatusChanged: (
            encrypted: boolean,
            participant?: Participant,
        ) => void;
        participantMetadataChanged: (
            metadata: string | undefined,
            participant: RemoteParticipant | LocalParticipant,
        ) => void;
        participantNameChanged: (
            name: string,
            participant: RemoteParticipant | LocalParticipant,
        ) => void;
        participantPermissionsChanged: (
            prevPermissions: ParticipantPermission | undefined,
            participant: RemoteParticipant | LocalParticipant,
        ) => void;
        reconnected: () => void;
        reconnecting: () => void;
        recordingStatusChanged: (recording: boolean) => void;
        roomMetadataChanged: (metadata: string) => void;
        signalConnected: () => void;
        signalReconnecting: () => void;
        sipDTMFReceived: (dtmf: SipDTMF, participant?: RemoteParticipant) => void;
        trackMuted: (
            publication: TrackPublication,
            participant: Participant,
        ) => void;
        trackPublished: (
            publication: RemoteTrackPublication,
            participant: RemoteParticipant,
        ) => void;
        trackStreamStateChanged: (
            publication: RemoteTrackPublication,
            streamState: StreamState,
            participant: RemoteParticipant,
        ) => void;
        trackSubscribed: (
            track: RemoteTrack,
            publication: RemoteTrackPublication,
            participant: RemoteParticipant,
        ) => void;
        trackSubscriptionFailed: (
            trackSid: string,
            participant: RemoteParticipant,
            reason?: SubscriptionError,
        ) => void;
        trackSubscriptionPermissionChanged: (
            publication: RemoteTrackPublication,
            status: PermissionStatus,
            participant: RemoteParticipant,
        ) => void;
        trackSubscriptionStatusChanged: (
            publication: RemoteTrackPublication,
            status: SubscriptionStatus,
            participant: RemoteParticipant,
        ) => void;
        trackUnmuted: (
            publication: TrackPublication,
            participant: Participant,
        ) => void;
        trackUnpublished: (
            publication: RemoteTrackPublication,
            participant: RemoteParticipant,
        ) => void;
        trackUnsubscribed: (
            track: RemoteTrack,
            publication: RemoteTrackPublication,
            participant: RemoteParticipant,
        ) => void;
        transcriptionReceived: (
            transcription: TranscriptionSegment[],
            participant?: Participant,
            publication?: TrackPublication,
        ) => void;
        videoPlaybackChanged: (playing: boolean) => void;
    }
    Index

    Properties

    activeDeviceChanged: (kind: MediaDeviceKind, deviceId: string) => void
    activeSpeakersChanged: (speakers: Participant[]) => void
    audioPlaybackChanged: (playing: boolean) => void
    chatMessage: (
        message: ChatMessage,
        participant?: RemoteParticipant | LocalParticipant,
    ) => void
    connected: () => void
    connectionQualityChanged: (
        quality: ConnectionQuality,
        participant: Participant,
    ) => void
    connectionStateChanged: (state: ConnectionState) => void
    dataReceived: (
        payload: Uint8Array,
        participant?: RemoteParticipant,
        kind?: DataPacket_Kind,
        topic?: string,
        encryptionType?: Encryption_Type,
    ) => void
    dcBufferStatusChanged: (isLow: boolean, kind: DataPacket_Kind) => void
    disconnected: (reason?: DisconnectReason) => void
    encryptionError: (error: Error, participant?: Participant) => void
    localAudioSilenceDetected: (publication: LocalTrackPublication) => void
    localTrackPublished: (
        publication: LocalTrackPublication,
        participant: LocalParticipant,
    ) => void
    localTrackSubscribed: (
        publication: LocalTrackPublication,
        participant: LocalParticipant,
    ) => void
    localTrackUnpublished: (
        publication: LocalTrackPublication,
        participant: LocalParticipant,
    ) => void
    mediaDevicesChanged: () => void
    mediaDevicesError: (error: Error, kind?: MediaDeviceKind) => void
    metricsReceived: (metrics: MetricsBatch, participant?: Participant) => void
    moved: (name: string) => void
    participantActive: (participant: Participant) => void
    participantAttributesChanged: (
        changedAttributes: Record<string, string>,
        participant: RemoteParticipant | LocalParticipant,
    ) => void
    participantConnected: (participant: RemoteParticipant) => void
    participantDisconnected: (participant: RemoteParticipant) => void
    participantEncryptionStatusChanged: (
        encrypted: boolean,
        participant?: Participant,
    ) => void
    participantMetadataChanged: (
        metadata: string | undefined,
        participant: RemoteParticipant | LocalParticipant,
    ) => void
    participantNameChanged: (
        name: string,
        participant: RemoteParticipant | LocalParticipant,
    ) => void
    participantPermissionsChanged: (
        prevPermissions: ParticipantPermission | undefined,
        participant: RemoteParticipant | LocalParticipant,
    ) => void
    reconnected: () => void
    reconnecting: () => void
    recordingStatusChanged: (recording: boolean) => void
    roomMetadataChanged: (metadata: string) => void
    signalConnected: () => void
    signalReconnecting: () => void
    sipDTMFReceived: (dtmf: SipDTMF, participant?: RemoteParticipant) => void
    trackMuted: (publication: TrackPublication, participant: Participant) => void
    trackPublished: (
        publication: RemoteTrackPublication,
        participant: RemoteParticipant,
    ) => void
    trackStreamStateChanged: (
        publication: RemoteTrackPublication,
        streamState: StreamState,
        participant: RemoteParticipant,
    ) => void
    trackSubscribed: (
        track: RemoteTrack,
        publication: RemoteTrackPublication,
        participant: RemoteParticipant,
    ) => void
    trackSubscriptionFailed: (
        trackSid: string,
        participant: RemoteParticipant,
        reason?: SubscriptionError,
    ) => void
    trackSubscriptionPermissionChanged: (
        publication: RemoteTrackPublication,
        status: PermissionStatus,
        participant: RemoteParticipant,
    ) => void
    trackSubscriptionStatusChanged: (
        publication: RemoteTrackPublication,
        status: SubscriptionStatus,
        participant: RemoteParticipant,
    ) => void
    trackUnmuted: (publication: TrackPublication, participant: Participant) => void
    trackUnpublished: (
        publication: RemoteTrackPublication,
        participant: RemoteParticipant,
    ) => void
    trackUnsubscribed: (
        track: RemoteTrack,
        publication: RemoteTrackPublication,
        participant: RemoteParticipant,
    ) => void
    transcriptionReceived: (
        transcription: TranscriptionSegment[],
        participant?: Participant,
        publication?: TrackPublication,
    ) => void
    videoPlaybackChanged: (playing: boolean) => void