Member Junction
    Preparing search index...

    Realtime Bridge driver for the MJ-native LiveKit room.

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

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

    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

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

    • Sends a message on the LiveKit data channel — the room-native "chat". Exposed for the channel plane / turn-taking hybrid mode (the social-cost-free "raise hand"). Best-effort — a failure is logged, never fatal.

      Parameters

      • text: string

        The data/chat message to send.

      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.