Member Junction
    Preparing search index...

    Class BaseDetachedMediaBridgeAbstract

    Abstract base class for a detached-media Realtime Bridge driver (e.g. OpenAISipBridge).

    In a detached media plane, the platform/carrier terminates the live media leg directly with the AI provider (e.g. OpenAI SIP endpoints), while MemberJunction attaches a sideband connection for signaling, events, transcripts, tool calls, and telemetry.

    MemberJunction is not in the live media path and does not relay audio between the carrier and the model. Therefore, SendMedia and FlushOutboundMedia are safe no-ops, and OnMedia registers an observer handler without pumping media frames into an audio sink.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    agentNumber: string = ''
    botParticipantId: string = 'bot'
    callEndedHandlers: (() => void)[] = []
    callerNumber: string = ''
    dtmfHandlers: ((digit: string) => void)[] = []
    externalCallId: string = ''

    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.

    mediaHandlers: ((frame: BridgeMediaFrame) => void)[] = []
    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

    • 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 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

    • 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.

    • 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.