Member Junction
    Preparing search index...

    Interface RtmsClient

    The @zoom/rtms Client surface this adapter drives. VERIFY against @zoom/rtms.

    interface RtmsClient {
        join(payload: Record<string, unknown>): void;
        leave(): void;
        onActiveSpeakerEvent?(
            cb: (
                timestamp: number,
                userId: string | number,
                userName?: string,
            ) => void,
        ): void;
        onAudioData(cb: RtmsAudioCallback): void;
        onJoinConfirm?(cb: (reason?: number) => void): void;
        onLeave?(cb: (reason?: number) => void): void;
        onSessionUpdate?(cb: (op: number, ...rest: unknown[]) => void): void;
    }
    Index

    Methods

    join leave onActiveSpeakerEvent? onAudioData onJoinConfirm? onLeave? onSessionUpdate?

    Methods

    • Joins the RTMS stream with the webhook-derived payload. VERIFY against @zoom/rtms (sync call).

      Parameters

      • payload: Record<string, unknown>

      Returns void

    • Diarized active-speaker signal (timestamp, userId, userName). VERIFY against @zoom/rtms.

      Parameters

      • cb: (timestamp: number, userId: string | number, userName?: string) => void

      Returns void

    • Fired when the RTMS stream is confirmed joined. VERIFY against @zoom/rtms (optional).

      Parameters

      • cb: (reason?: number) => void

      Returns void

    • Fired when the RTMS session ends / leaves. VERIFY against @zoom/rtms (optional).

      Parameters

      • cb: (reason?: number) => void

      Returns void

    • Fired when the session state updates (used to detect meeting end). VERIFY against @zoom/rtms (optional).

      Parameters

      • cb: (op: number, ...rest: unknown[]) => void

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods