Member Junction
    Preparing search index...

    Realtime Bridge driver for Cisco Webex meetings.

    Construct the driver with the default constructor (the engine's ClassFactory path) — it lazily builds the Webex SDK from the sdkFactory at Connect time. Tests inject a FakeWebexSdk by overriding the factory via SetSdkFactory (the creation seam) before connecting.

    Registered via @RegisterClass(BaseRealtimeBridge, 'WebexBridge').

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    The capability flags for the provider this bridge instance serves. Populated from the RealtimeBridgeContext at BaseRealtimeBridge.Connect time (and may be set by the engine immediately after construction). Drives BaseRealtimeBridge.RequireFeature.

    providerName: string

    The provider's display name for this bridge instance, used in capability-error messages. Populated from the RealtimeBridgeContext; falls back to the driver class name.

    Accessors

    Methods

    • Flushes any outbound media the driver has queued for the endpoint — the agent's not-yet-played voice. The engine calls this on a true barge-in (the user interrupts the agent) so the agent stops talking immediately instead of draining already-buffered audio after the model was cut off.

      No-op by default (NOT capability-gated): a driver with no client-side outbound buffer simply has nothing to flush, so calling this is always safe. Drivers that buffer outbound audio override it.

      Returns void

    • Registers a handler invoked when the driver can no longer show the agent's avatar (see BridgeAvatarFailure): it has taken the avatar's video down and told the room. The engine then replaces the model session with one that renders no avatar, so the model stops generating (and billing) video nobody sees.

      No-op by default (NOT capability-gated): a driver that publishes no avatar never loses one, so registering is always safe. Drivers that publish an agent's avatar override it.

      Parameters

      • _handler: (reason: BridgeAvatarFailure) => void

        Invoked once, with why the avatar can no longer be shown.

      Returns void

    • Registers a handler for inbound DTMF tones on a telephony bridge.

      Capability-gated by SupportedFeatures.DTMF. Throws unless overridden.

      Parameters

      • _handler: (digits: string) => void

        Invoked with each received DTMF digit string.

      Returns void

      when not overridden.

    • Registers a handler invoked when an inbound camera or screen source the driver was sending stops: the person stopped letting agents see them, left, stopped sharing or turned the camera off, or the driver moved the model's view to another source. The engine tells the model, so it stops describing what it can no longer see.

      No-op by default (NOT capability-gated): a driver that sends no inbound video has no source to end, so registering is always safe. Drivers that send camera or screen frames override it.

      Parameters

      Returns void

    • Posts a message to the Webex meeting space chat. Exposed for the channel plane / turn-taking hybrid mode (the social-cost-free "raise hand"). Best-effort — a chat failure is logged, never fatal.

      Parameters

      • text: string

        The chat message to post.

      Returns Promise<void>

    • Sends DTMF tones on a telephony bridge.

      Capability-gated by SupportedFeatures.DTMF. Throws unless overridden by a telephony driver.

      Parameters

      • _digits: string

        The DTMF digit string to send (e.g. '1234#').

      Returns Promise<void>

      A promise that resolves once the tones have been sent.

      when not overridden.

    • Requests that the platform begin recording the session.

      Capability-gated by SupportedFeatures.Recording (and subject to per-jurisdiction consent handling upstream). Throws unless overridden.

      Returns Promise<void>

      A promise that resolves once recording has started.

      when not overridden.

    • Transfers the call to another party on a telephony bridge.

      Capability-gated by SupportedFeatures.CallTransfer. Throws unless overridden.

      Parameters

      • _target: string

        The transfer target (a phone number or platform endpoint identifier).

      Returns Promise<void>

      A promise that resolves once the transfer has been initiated.

      when not overridden.