Member Junction
    Preparing search index...

    Interface IZoomMeetingSdk

    The minimal Zoom Meeting SDK surface the import('./zoom-bridge').ZoomBridge depends on. Production binds this to the real SDK; tests inject a FakeZoomSdk.

    interface IZoomMeetingSdk {
        getParticipants(): Promise<ZoomParticipant[]>;
        join(args: ZoomJoinArgs): Promise<ZoomJoinResult>;
        leave(): Promise<void>;
        muteParticipant(participantId: string): Promise<void>;
        onAudioFrame(cb: (frame: ZoomAudioFrame) => void): void;
        onHandRaise(cb: (participantId: string, raised: boolean) => void): void;
        onMeetingEnded(cb: () => void): void;
        onParticipantJoin(cb: (participant: ZoomParticipant) => void): void;
        onParticipantLeave(cb: (participantId: string) => void): void;
        postChatMessage(text: string): Promise<void>;
        sendAudioFrame(pcm: ArrayBuffer): void;
    }

    Implemented by

    Index

    Methods

    getParticipants join leave muteParticipant onAudioFrame onHandRaise onMeetingEnded onParticipantJoin onParticipantLeave postChatMessage sendAudioFrame

    Methods

    • Mutes a participant (requires the bot to be host/co-host).

      Parameters

      • participantId: string

        The participant to mute.

      Returns Promise<void>

    • Registers a callback for inbound raw per-participant audio frames (what the agent hears, carrying the speaker label for diarization). "Latest handler wins."

      Parameters

      • cb: (frame: ZoomAudioFrame) => void

        Invoked with each inbound audio frame.

      Returns void

    • Registers a callback for native hand-raise/lower signals. "Latest handler wins."

      Parameters

      • cb: (participantId: string, raised: boolean) => void

        Invoked with the participant id and whether the hand is now raised.

      Returns void

    • Registers a callback fired when the meeting ends (host ended / timed out). "Latest handler wins."

      Parameters

      • cb: () => void

        Invoked when the meeting has ended.

      Returns void

    • Registers a callback fired when a participant leaves. "Latest handler wins."

      Parameters

      • cb: (participantId: string) => void

        Invoked with the participant id that left.

      Returns void

    • Posts a message to the in-meeting chat (everyone).

      Parameters

      • text: string

        The chat message text.

      Returns Promise<void>

    • Sends one raw PCM audio frame as the bot's outbound audio (the agent's voice into the meeting).

      Parameters

      • pcm: ArrayBuffer

        The PCM audio bytes to send.

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods