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

    Type Alias ParticipantEventCallbacks

    type ParticipantEventCallbacks = {
        active: () => void;
        attributesChanged: (changedAttributes: Record<string, string>) => void;
        audioStreamAcquired: () => void;
        chatMessage: (msg: ChatMessage) => void;
        connectionQualityChanged: (connectionQuality: ConnectionQuality) => void;
        dataReceived: (
            payload: Uint8Array,
            kind: DataPacket_Kind,
            encryptionType?: Encryption_Type,
        ) => void;
        isSpeakingChanged: (speaking: boolean) => void;
        localSenderCreated: (sender: RTCRtpSender, track: Track) => void;
        localTrackCpuConstrained: (
            track: LocalVideoTrack,
            publication: LocalTrackPublication,
        ) => void;
        localTrackPublished: (publication: LocalTrackPublication) => void;
        localTrackSubscribed: (trackPublication: LocalTrackPublication) => void;
        localTrackUnpublished: (publication: LocalTrackPublication) => void;
        mediaDevicesError: (error: Error, kind?: MediaDeviceKind) => void;
        participantMetadataChanged: (
            prevMetadata: string | undefined,
            participant?: any,
        ) => void;
        participantNameChanged: (name: string) => void;
        participantPermissionsChanged: (
            prevPermissions?: ParticipantPermission,
        ) => void;
        sipDTMFReceived: (dtmf: SipDTMF) => void;
        trackMuted: (publication: TrackPublication) => void;
        trackPublished: (publication: RemoteTrackPublication) => void;
        trackStreamStateChanged: (
            publication: RemoteTrackPublication,
            streamState: StreamState,
        ) => void;
        trackSubscribed: (
            track: RemoteTrack,
            publication: RemoteTrackPublication,
        ) => void;
        trackSubscriptionFailed: (
            trackSid: string,
            reason?: SubscriptionError,
        ) => void;
        trackSubscriptionPermissionChanged: (
            publication: RemoteTrackPublication,
            status: PermissionStatus,
        ) => void;
        trackSubscriptionStatusChanged: (
            publication: RemoteTrackPublication,
            status: SubscriptionStatus,
        ) => void;
        trackUnmuted: (publication: TrackPublication) => void;
        trackUnpublished: (publication: RemoteTrackPublication) => void;
        trackUnsubscribed: (
            track: RemoteTrack,
            publication: RemoteTrackPublication,
        ) => void;
        transcriptionReceived: (
            transcription: TranscriptionSegment[],
            publication?: TrackPublication,
        ) => void;
    }
    Index

    Properties

    active: () => void
    attributesChanged: (changedAttributes: Record<string, string>) => void
    audioStreamAcquired: () => void
    chatMessage: (msg: ChatMessage) => void
    connectionQualityChanged: (connectionQuality: ConnectionQuality) => void
    dataReceived: (
        payload: Uint8Array,
        kind: DataPacket_Kind,
        encryptionType?: Encryption_Type,
    ) => void
    isSpeakingChanged: (speaking: boolean) => void
    localSenderCreated: (sender: RTCRtpSender, track: Track) => void
    localTrackCpuConstrained: (
        track: LocalVideoTrack,
        publication: LocalTrackPublication,
    ) => void
    localTrackPublished: (publication: LocalTrackPublication) => void
    localTrackSubscribed: (trackPublication: LocalTrackPublication) => void
    localTrackUnpublished: (publication: LocalTrackPublication) => void
    mediaDevicesError: (error: Error, kind?: MediaDeviceKind) => void
    participantMetadataChanged: (
        prevMetadata: string | undefined,
        participant?: any,
    ) => void
    participantNameChanged: (name: string) => void
    participantPermissionsChanged: (prevPermissions?: ParticipantPermission) => void
    sipDTMFReceived: (dtmf: SipDTMF) => void
    trackMuted: (publication: TrackPublication) => void
    trackPublished: (publication: RemoteTrackPublication) => void
    trackStreamStateChanged: (
        publication: RemoteTrackPublication,
        streamState: StreamState,
    ) => void
    trackSubscribed: (
        track: RemoteTrack,
        publication: RemoteTrackPublication,
    ) => void
    trackSubscriptionFailed: (trackSid: string, reason?: SubscriptionError) => void
    trackSubscriptionPermissionChanged: (
        publication: RemoteTrackPublication,
        status: PermissionStatus,
    ) => void
    trackSubscriptionStatusChanged: (
        publication: RemoteTrackPublication,
        status: SubscriptionStatus,
    ) => void
    trackUnmuted: (publication: TrackPublication) => void
    trackUnpublished: (publication: RemoteTrackPublication) => void
    trackUnsubscribed: (
        track: RemoteTrack,
        publication: RemoteTrackPublication,
    ) => void
    transcriptionReceived: (
        transcription: TranscriptionSegment[],
        publication?: TrackPublication,
    ) => void