Javascript API Reference
    Preparing search index...

    Type Alias ParticipantEvent

    type ParticipantEvent = {
        "e2ee-state-change": (data: { kind: string; state: string }) => void;
        "media-status-changed": (
            data: {
                kind:
                    | "audio"
                    | "video"
                    | "share"
                    | "shareAudio"
                    | "rawAudio"
                    | "rawVideo";
                name?: string;
                newStatus: boolean;
                peerId: string;
            },
        ) => void;
        "stream-disabled": (stream: Stream) => void;
        "stream-enabled": (stream: Stream) => void;
        "stream-paused": (
            data: { kind: string; name?: string; reason: string },
        ) => void;
        "stream-resumed": (
            data: { kind: string; name?: string; reason: string },
        ) => void;
        "video-quality-changed": (
            data: {
                currentQuality: string;
                kind?: string;
                name?: string;
                prevQuality: string;
            },
        ) => void;
    }
    Index
    "e2ee-state-change": (data: { kind: string; state: string }) => void

    Triggered when the E2EE (End-to-End Encryption) state of a participant’s media stream changes.

    Type Declaration

      • (data: { kind: string; state: string }): void
      • Parameters

        • data: { kind: string; state: string }
          • kind: string

            Type of stream whose E2EE state changed.

          • state: string

            Current E2EE state of the stream.

        Returns void

    participant.on("e2ee-state-change", (data) => {
    console.log("Media kind:", data.kind);
    console.log("E2EE state:", data.state);
    });
    "media-status-changed": (
        data: {
            kind:
                | "audio"
                | "video"
                | "share"
                | "shareAudio"
                | "rawAudio"
                | "rawVideo";
            name?: string;
            newStatus: boolean;
            peerId: string;
        },
    ) => void

    Triggered when the media status of a participant changes (for example, when audio or video is enabled or disabled).

    Type Declaration

      • (
            data: {
                kind:
                    | "audio"
                    | "video"
                    | "share"
                    | "shareAudio"
                    | "rawAudio"
                    | "rawVideo";
                name?: string;
                newStatus: boolean;
                peerId: string;
            },
        ): void
      • Parameters

        • data: {
              kind:
                  | "audio"
                  | "video"
                  | "share"
                  | "shareAudio"
                  | "rawAudio"
                  | "rawVideo";
              name?: string;
              newStatus: boolean;
              peerId: string;
          }
          • kind: "audio" | "video" | "share" | "shareAudio" | "rawAudio" | "rawVideo"

            Type of stream whose status changed.

          • Optionalname?: string

            Name of the raw track. Only set when kind is "rawAudio" or "rawVideo".

          • newStatus: boolean

            The updated status of the stream.

          • peerId: string

        Returns void

    participant.on("media-status-changed", (data) => {
    const { kind, newStatus, name } = data;
    });
    "stream-disabled": (stream: Stream) => void

    Triggered when a participant’s audio, video, screen-share or raw track Stream is disabled.

    Type Declaration

      • (stream: Stream): void
      • Parameters

        • stream: Stream

          The stream that was disabled.

        Returns void

    participant.on("stream-disabled", (stream) => {
    //
    });
    "stream-enabled": (stream: Stream) => void

    Triggered when a participant’s audio, video, screen-share or raw track Stream is enabled.

    Type Declaration

      • (stream: Stream): void
      • Parameters

        • stream: Stream

          The stream that was enabled.

        Returns void

    participant.on("stream-enabled", (stream) => {
    //
    });
    "stream-paused": (data: { kind: string; name?: string; reason: string }) => void
    • Triggered when a participant’s video, audio, or screen-share stream is paused.

    • Triggered by the Subscription Manager, which is enabled by calling the enableAdaptiveSubscription() method.

    • Also triggered, for every other participant, when this participant’s camera track goes muted (iOS: app in the background, phone locked, camera taken by another app). kind is "video" and reason is "trackMuted".

    • Not triggered when the local participant pauses the stream itself.

    Type Declaration

      • (data: { kind: string; name?: string; reason: string }): void
      • Parameters

        • data: { kind: string; name?: string; reason: string }
          • kind: string

            Type of stream that was paused.

          • Optionalname?: string

            Name of the raw track. Only set when the paused stream is a raw track.

          • reason: string

            Reason why the stream was paused.

            Possible values:

            • "muted" – Stream was paused because it was muted.
            • "leastDominance" – Stream was paused due to bandwidth or dominance rules.
            • "trackMuted" – The participant’s camera track went muted, so it sends no video.

        Returns void

    participant.on("stream-paused", ({ kind, reason, name }) => {
    console.log(kind, reason, name);
    });
    "stream-resumed": (
        data: { kind: string; name?: string; reason: string },
    ) => void
    • Triggered when a participant’s video, audio, or screen-share stream is resumed.

    • Triggered by the Subscription Manager, which is enabled by calling the enableAdaptiveSubscription() method.

    • Also triggered, for every other participant, when this participant’s muted camera track unmutes. kind is "video" and reason is "trackMuted".

    • Not triggered when the local participant resumes the stream itself.

    Type Declaration

      • (data: { kind: string; name?: string; reason: string }): void
      • Parameters

        • data: { kind: string; name?: string; reason: string }
          • kind: string

            Type of stream that was resumed.

          • Optionalname?: string

            Name of the raw track. Only set when the resumed stream is a raw track.

          • reason: string

            Reason why the stream was resumed.

            Possible values:

            • "adaptiveSubscriptionsDisabled" – Stream resumed after adaptive subscriptions were disabled.
            • "networkStable" – Stream resumed due to stable network conditions.
            • "trackMuted" – The participant’s camera track unmuted after a "trackMuted" pause.

        Returns void

    participant.on("stream-resumed", ({ kind, reason, name }) => {
    console.log(kind, reason, name);
    });
    "video-quality-changed": (
        data: {
            currentQuality: string;
            kind?: string;
            name?: string;
            prevQuality: string;
        },
    ) => void
    • Triggered when the video quality of a participant changes.

    • The currentQuality and prevQuality values can be HIGH, MEDIUM, or LOW.

    Type Declaration

      • (
            data: {
                currentQuality: string;
                kind?: string;
                name?: string;
                prevQuality: string;
            },
        ): void
      • Parameters

        • data: { currentQuality: string; kind?: string; name?: string; prevQuality: string }
          • currentQuality: string

            The updated video quality level.

          • Optionalkind?: string

            Kind of the video stream whose quality changed, when provided (for example "rawVideo").

          • Optionalname?: string

            Name of the raw track. Only set for raw video streams.

          • prevQuality: string

            The previous video quality level.

        Returns void

    participant.on("video-quality-changed", (data) => {
    const { currentQuality, prevQuality, kind, name } = data;
    });