Member Junction
    Preparing search index...

    Interface IWebexMeetingSdk

    The minimal Cisco Webex Meetings SDK surface the import('./webex-bridge').WebexBridge depends on. Production binds this to the real Webex Meetings SDK / Webex bot framework; tests inject a FakeWebexSdk.

    interface IWebexMeetingSdk {
        getParticipants(): Promise<WebexParticipant[]>;
        join(args: WebexJoinArgs): Promise<WebexJoinResult>;
        leave(): Promise<void>;
        muteParticipant(participantId: string): Promise<void>;
        onAudioFrame(cb: (frame: WebexAudioFrame) => void): void;
        onHandRaise(cb: (participantId: string, raised: boolean) => void): void;
        onMeetingEnded(cb: () => void): void;
        onParticipantJoin(cb: (participant: WebexParticipant) => 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 member (requires the bot be a host/cohost with the relevant privilege).

      Parameters

      • participantId: string

        The member 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: WebexAudioFrame) => void

        Invoked with each inbound audio frame.

      Returns void

    • Registers a callback for native raised-hand signals. "Latest handler wins."

      ⚠️ Webex raised-hand is partial over the Meetings SDK: a clean per-participant event is not guaranteed on every client/build. The adapter wires this where the platform exposes it and the driver tolerates the signal never firing.

      Parameters

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

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

      Returns void

    • Registers a callback fired when the meeting ends (host ended / meeting state → ENDED). "Latest handler wins."

      Parameters

      • cb: () => void

        Invoked when the meeting has ended.

      Returns void

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

      Parameters

      • cb: (participantId: string) => void

        Invoked with the member id that left.

      Returns void

    • Posts a message to the Webex meeting space 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), over the Webex Meetings SDK outbound audio media track.

      Parameters

      • pcm: ArrayBuffer

        The PCM audio bytes to send.

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods