Member Junction
    Preparing search index...

    Class MJLiveKitRoomComponent

    mj-livekit-agent-room — the MemberJunction binding for the LiveKit room UI. It resolves a scoped access token (and, in 'agent' mode, starts the agent's presence in the room) via the RealtimeBridge GraphQL surface, then renders LiveKitRoomComponent with the resolved connection. All the rich feature gates of the generic component are forwarded; MJ user/provider context is threaded in.

    Public members are PascalCase (MJ convention); private members are camelCase.

    Hierarchy (View Summary)

    Implements

    • OnInit
    Index

    Constructors

    constructor

    Properties

    AddError AddingAgent AddModelId AddTargetId AddTurnAddressing AddTurnMode AddVoice AddVoiceOption AgentAvatarUrl AgentID AgentName AgentsInRoom AgentVisionNotice AutoStart AvailableAgents AvailableModels AvatarNoticeLabels CanPickModelVoice Connected ConnectTimeoutMs DataReceived DeviceNotice Disconnected DisplayName E2EEPassphrase E2EEWorker EnableAgentManagement EnableAgentVisionControl EnableBackgroundEffects EnableCameraControl EnableDeviceSettings EnableEndForAll EnableHandoff EnableInvite EnableLayoutSwitcher EnableLeaveControl EnableMicrophoneControl EnableNoiseFilter EnablePinning EnableRecording EnableScreenShareControl EnableTurnTaking EndingMeeting errorMessage ErrorOccurred InviteCopied InvitePeopleRequested IsRecording Layout Loading Mode ParticipantJoined ParticipantLeft PipRects Provider RealtimeModelID RealtimeVoice RecordingFileId ResolvedDisplayName ResolvedRoomName RoomName RoomOptions? RosterBadges SelfViewHidden ServerUrl SessionStarted ShowAgentsPanel ShowAgentState ShowChat ShowControlBar ShowHeader ShowParticipantsPanel ShowPreJoin ShowRecordingPanel ShowTurnPanel ShowWhiteboard StartWithCamera StartWithMicrophone TargetAgentID TileMoves Title Token TurnAddressing TurnAddressingOptions TurnError TurnMode TurnModeOptions TurnPillLabel TurnPollIntervalMs TurnState UUIDsEqual ɵdir ɵfac

    Accessors

    addError addingAgent addModelId addTargetId addVoice addVoices AddVoices agentsInRoom availableToAdd AvailableToAdd AvatarNotices endingMeeting inviteCopied inviteUrl InviteUrl isRecording loading ProviderToUse recordingFileId resolvedDisplayName resolvedRoomName RunQueryToUse RunViewToUse serverUrl showAgentsPanel showRecordingPanel token

    Methods

    AddAgent AvatarNoticeLine CopyInvite EndMeeting ngOnInit onAddModelChange OnAddModelChange onAddTargetChange OnAddTargetChange OnAddTurnAddressingChange OnAddTurnModeChange onAddVoiceChange OnAddVoiceChange OnAgentVisionChange OnAvatarNoticeDismissed OnDeviceChangeRequested OnPipRectsChange OnRoomDisconnected OnRoomError OnRoomStateChanged OnSelfViewHiddenChange OnTileMovesChange onToggleRecording OnToggleRecording RemoveAgent Start ToggleTurnPanel

    Constructors

    Properties

    AddError: string | null = null

    Last add error, shown under the picker.

    AddingAgent: boolean = false

    True while an Add request is in flight.

    AddModelId: string | null = null

    The MODEL override chosen in the "Add an agent" picker (dev-only; null = co-agent/target default).

    AddTargetId: string | null = null

    The target id chosen in the "Add an agent" picker.

    AddTurnAddressing: TurnAddressingChoice | null = null

    The addressing mode chosen in the "Add an agent" picker (null = Auto).

    AddTurnMode: TurnModeChoice | null = null

    The turn mode chosen in the "Add an agent" picker (null = the room's default).

    AddVoice: string | null = null

    The VOICE override chosen in the "Add an agent" picker (dev-only; null = co-agent/target default).

    AddVoiceOption: RealtimeVoiceOption | null = null

    The voice option picked in the "Add an agent" picker (one of AddVoices), or null. Kept beside AddVoice because two personas can share a voice id: the option, not the id, says which one shows picked.

    AgentAvatarUrl: string | null = null

    LiveKitRoomComponent.AgentAvatarUrl

    AgentID: string | null = null

    The agent to voice (agent mode) — the Realtime Co-Agent / voice front-end.

    AgentName: string | null = null

    The agent's display name (bot name + addressing).

    AgentsInRoom: AgentInRoom[] = []

    The agent bots currently bridged into the room (the first is the one started on join).

    AgentVisionNotice: string | null = null

    Why the server could not record the user's last choice of what the agent sees, shown over the room until they dismiss it or choose again; null when there is nothing to say.

    AutoStart: boolean = true

    Resolve the connection automatically on init.

    AvailableAgents: { ID: string; Name: string }[] = []

    Target agents the user can ADD in-room (id + name). The host (e.g. the Explorer resource) supplies these.

    AvailableModels: RealtimeModelVoices[] = []

    Active Realtime models + their voices, supplied by the host (for the add-agent dropdowns).

    AvatarNoticeLabels:
        | Partial<
            Readonly<Record<RealtimeAvatarUnavailableReason | "unknown", string>>,
        >
        | null = null

    The host's own words for why the room shows an agent without its avatar, per reason (for example its product's name for "this app"), shown as written; {Agent} stands for the agent's name. unknown words a reason the room doesn't know, such as a newer bot's. A reason it leaves out keeps the stock line, which names the agent.

    CanPickModelVoice: boolean = false

    Whether the dev model/voice pickers are shown in the in-room "Add an agent" control. The HOST computes this (the Realtime: Advanced Session Controls authorization) and passes it down — this generic component never evaluates authorizations itself.

    Connected: EventEmitter<LiveKitRoomState> = ...

    Emitted when the room connects.

    ConnectTimeoutMs: number = 25000

    Max time to wait for the connection to start before surfacing a retryable error, so a hung or very slow server (e.g. an agent bot that can't reach the LiveKit media path) doesn't spin forever. Set 0 to disable the client-side timeout.

    DataReceived: EventEmitter<LiveKitDataMessage> = ...

    Emitted for inbound data-channel messages.

    DeviceNotice: string | null = null

    What went wrong with the user's microphone, camera, speaker or share while the room was connected, such as a share the browser refused, shown over the room until they dismiss it, ask for another change to their devices, or leave; null when there is nothing to say. A share picker the user closed is no error, so it says nothing.

    Disconnected: EventEmitter<LiveKitDisconnectedEvent> = ...

    Emitted when the room disconnects.

    DisplayName: string | null = null

    The display name the local user joins as. Defaults to the authenticated user server-side.

    E2EEPassphrase: string | null = null

    LiveKitRoomComponent.E2EEPassphrase

    E2EEWorker: Worker | null = null

    LiveKitRoomComponent.E2EEWorker

    EnableAgentManagement: boolean = true

    Show the in-room "Agents" panel to add/remove agents (agent mode only).

    EnableAgentVisionControl: boolean = true

    LiveKitRoomComponent.EnableAgentVisionControl

    EnableBackgroundEffects: boolean = false

    LiveKitRoomComponent.EnableBackgroundEffects

    EnableCameraControl: boolean = true

    LiveKitRoomComponent.EnableCameraControl

    EnableDeviceSettings: boolean = true

    LiveKitRoomComponent.EnableDeviceSettings

    EnableEndForAll: boolean = true

    Offer "End meeting for everyone" in the control bar's Zoom-style leave menu. When on (default) and a room is resolved, ending tears down every agent in the room server-side (by name — so it works even when this client only joined). Set false for contexts where only the local user should ever leave.

    EnableHandoff: boolean = false

    Start the initial agent able to bring a person, a phone number or another agent into this same room (a "transfer to a human" that the visitor never leaves the room for). Honoured only when the server has handoff configured; otherwise ignored.

    EnableInvite: boolean = true

    Show the "Invite" pill that copies a join link to this room.

    EnableLayoutSwitcher: boolean = true

    LiveKitRoomComponent.EnableLayoutSwitcher

    EnableLeaveControl: boolean = true

    LiveKitRoomComponent.EnableLeaveControl

    EnableMicrophoneControl: boolean = true

    LiveKitRoomComponent.EnableMicrophoneControl

    EnableNoiseFilter: boolean = false

    LiveKitRoomComponent.EnableNoiseFilter

    EnablePinning: boolean = true

    LiveKitRoomComponent.EnablePinning

    EnableRecording: boolean = false

    Enable the server-authorized recording control (composite egress).

    EnableScreenShareControl: boolean = true

    LiveKitRoomComponent.EnableScreenShareControl

    EnableTurnTaking: boolean = true

    Show the turn-taking panel (floor holder, hand-offs, backchannels, loop cap) and per-agent mode pickers.

    EndingMeeting: boolean = false

    True while an "End meeting" (stop all agents + leave) is in flight.

    errorMessage: string | null = null

    The token/session-resolution error, if any.

    ErrorOccurred: EventEmitter<LiveKitRoomError> = ...

    Emitted on room errors (and on token/session-resolution failures).

    InviteCopied: boolean = false

    True briefly after the invite link is copied (drives the "Link copied" pill state).

    InvitePeopleRequested: EventEmitter<string> = ...

    Emitted (with the room name) when the user clicks "Invite people". The host (e.g. the Explorer resource) opens an MJ user-picker and calls the invite mutation — kept out of this generic component, which knows nothing about MJ users.

    IsRecording: boolean = false

    Whether a recording is currently in progress.

    Layout: LiveKitRoomLayout = 'grid'

    LiveKitRoomComponent.Layout

    Loading: boolean = false

    Whether the binding is resolving the token/session.

    Mode: MJLiveKitConnectionMode = 'agent'

    Whether to start an agent in the room ('agent'), just join an existing room ('join'), or open the preview room ('preview': no token, no agent session, no recording). Read when the room is created.

    ParticipantJoined: EventEmitter<LiveKitParticipantJoinedEvent> = ...

    Emitted when a participant joins.

    ParticipantLeft: EventEmitter<LiveKitParticipantLeftEvent> = ...

    Emitted when a participant leaves.

    PipRects: ReadonlyMap<string, MediaPipRect> = ...

    Where the user put picture-in-picture boxes, by participant identity, as saved for them.

    Provider: IMetadataProvider | null

    If specified, this provider will be used for communication and for all metadata purposes. By default, if not provided, the Metadata and RunView classes are used for this and the default GraphQLDataProvider is used which is connected to the same back-end MJAPI instance as the Metadata and RunView classes. If you want to have this component connect to a different MJAPI back-end, create an instance of a ProviderBase sub-class like GraphQLDataProvider/etc, and configure it as appropriate to connect to the MJAPI back-end you want to use, and then pass it in here.

    RealtimeModelID: string | null = null

    Per-session Realtime MODEL override for the INITIAL agent (from the host's pre-join picker).

    RealtimeVoice: string | null = null

    Per-session VOICE override for the INITIAL agent (from the host's pre-join picker).

    RecordingFileId: string | null = null

    The MJ: Files id of this room's meeting recording, when one exists — set when a recording is STOPPED (the server registers the egress MP4 and returns its file id) or resolved for an already-recorded room on join. Drives the MJStorageMediaPlayerComponent playback panel.

    ResolvedDisplayName: string | null = null

    The display name passed to the room.

    ResolvedRoomName: string | null = null

    The resolved room name (for recording and agent-vision calls).

    RoomName: string | null = null

    The room name. Required for 'join' mode; optional for 'agent' (server generates one).

    RoomOptions?: RoomOptions

    Advanced livekit-client room options merged into the constructed Room (overrides speech defaults).

    RosterBadges: Map<string, RosterTurnBadge> = ...

    Each seated agent's turn-taking badge, keyed by lowercase bridge-session id.

    SelfViewHidden: boolean = false

    Whether the user hid their self-view, as saved for them; given to the room, and saved again as they change it.

    ServerUrl: string | null = null

    The resolved LiveKit server URL.

    SessionStarted: EventEmitter<MJLiveKitSessionStartedEvent> = ...

    Emitted once the agent room session is started (agent mode).

    ShowAgentsPanel: boolean = false

    Whether the floating agents panel is open.

    ShowAgentState: boolean = false

    LiveKitRoomComponent.ShowAgentState

    ShowChat: boolean = true

    LiveKitRoomComponent.ShowChat

    ShowControlBar: boolean = true

    LiveKitRoomComponent.ShowControlBar

    ShowHeader: boolean = true

    LiveKitRoomComponent.ShowHeader

    ShowParticipantsPanel: boolean = true

    LiveKitRoomComponent.ShowParticipantsPanel

    ShowPreJoin: boolean = false

    LiveKitRoomComponent.ShowPreJoin

    ShowRecordingPanel: boolean = true

    Whether the recording playback panel is shown (dismissable).

    ShowTurnPanel: boolean = false

    Whether the turn-taking panel is open.

    ShowWhiteboard: boolean = false

    LiveKitRoomComponent.ShowWhiteboard

    StartWithCamera: boolean = false

    LiveKitRoomComponent.StartWithCamera

    StartWithMicrophone: boolean = true

    LiveKitRoomComponent.StartWithMicrophone

    TargetAgentID: string | null = null

    The TARGET agent the co-agent voices — the one being "called". The Realtime Co-Agent delegates to it via invoke-target-agent; without it the agent has nobody to speak for and stays idle.

    TileMoves: readonly MediaPlacementMove[] = []

    Where the user moved participants' tiles, as saved for them; given to the room, and saved again as they change.

    Title: string | null = null

    LiveKitRoomComponent.Title

    Token: string | null = null

    The resolved access token.

    TurnAddressing: TurnAddressingChoice | null = null

    How the agent decides it was addressed: Auto (the default: the model's own judgement when it can give it, name matching otherwise), ModelSide, or Regex. Applies to the INITIAL agent; agents added in-room pick their own.

    TurnAddressingOptions: readonly TurnTakingOption<TurnAddressingChoice>[] = TURN_ADDRESSING_OPTIONS

    The addressing choices for the add-agent picker.

    TurnError: string | null = null

    The latest turn-taking poll error, shown in the panel.

    TurnMode: TurnModeChoice | null = null

    Turn-taking mode for the agent.

    TurnModeOptions: readonly TurnTakingOption<TurnModeChoice>[] = TURN_MODE_OPTIONS

    The turn-mode choices for the add-agent picker.

    TurnPillLabel: string = 'Turns'

    The label on the turn-taking pill; names the floor holder when there is one.

    TurnPollIntervalMs: number = TURN_POLL_DEFAULT_INTERVAL_MS

    How often the turn-taking panel refreshes, in ms (clamped to a sensible minimum).

    TurnState: LiveKitRoomTurnState | null = null

    The room's latest turn-taking state (null until the first poll of a room with agents answers).

    UUIDsEqual: (
        uuid1: string | null | undefined,
        uuid2: string | null | undefined,
    ) => boolean = UUIDsEqual

    Exposed for template use — platform-safe UUID equality (SQL upper vs PG lower).

    Type Declaration

      • (uuid1: string | null | undefined, uuid2: string | null | undefined): boolean

      • Performs a case-insensitive comparison of two UUID strings. Handles null/undefined gracefully — two nullish values are considered equal, but a nullish value is never equal to a non-nullish value.

        Parameters

        • uuid1: string | null | undefined

          First UUID to compare

        • uuid2: string | null | undefined

          Second UUID to compare

        Returns boolean

        true if the UUIDs are equal (case-insensitive), false otherwise

        // Cross-platform comparison (SQL Server uppercase vs PostgreSQL lowercase)
        UUIDsEqual('A1B2C3D4-E5F6-7890-ABCD-EF1234567890',
                   'a1b2c3d4-e5f6-7890-abcd-ef1234567890') // true

        UUIDsEqual(null, null) // true
        UUIDsEqual(null, 'some-id') // false
        UUIDsEqual('abc', 'ABC') // true
    "ɵdir": unknown
    "ɵfac": ɵɵFactoryDeclaration<BaseAngularComponent, never>

    Accessors

    • get AvatarNotices(): readonly AgentAvatarNotice[]

      The notices over the room that an agent's avatar can't be shown, oldest first: one per agent per join, for everyone in the room, from the agent's bot. Each hides itself after a while or when dismissed.

      Returns readonly AgentAvatarNotice[]

    • get InviteUrl(): string

      Builds the shareable invite URL for THIS room: the current page URL with a room=<roomName> query param. Opening it lands the invitee on the Live Room in join mode for the same room.

      Returns string

    • get ProviderToUse(): IMetadataProvider

      Returns either the default Metadata provider or the one specified in the Provider property, if it was specified

      Returns IMetadataProvider

    • get RunQueryToUse(): IRunQueryProvider

      Returns either the default RunQuery provider or the one specified in the Provider property, if it was specified

      Returns IRunQueryProvider

    • get RunViewToUse(): IRunViewProvider

      Returns either the default RunView provider or the one specified in the Provider property, if it was specified

      Returns IRunViewProvider

    Methods

    • Adds another agent to the SAME room — starts a new bridge (the co-agent voicing the chosen target) and appends it to the roster. The new bot joins the live room alongside the existing participants.

      Returns Promise<void>

    • End meeting (the Zoom/Teams "End for all", reached from the control-bar leave menu): tears down EVERY agent in the room server-side — by room name, so it works even when this client only joined the room and never tracked the bridge ids locally — then disconnects the local user. Contrast with Leave (the other menu item → LiveKitRoomComponent.Leave), which only disconnects YOU and lets the meeting continue; the server then auto-leaves the agents once the last human is gone, so neither path strands billable agent sessions in an empty room.

      Returns Promise<void>

    • A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated.

      Returns void

    • Records the add-agent VOICE choice: the picked option, found by its position (two personas can share a voice id, so the value can't tell them apart; option 0 is "Default voice"), and its voice id.

      Parameters

      • event: Event

      Returns void

    • The user chose whether agents may see their camera and screen. The preview room records it at once. In a meeting, MJAPI records it, since a participant's token can't change its own attributes, and the room shows the change when LiveKit reports it; when MJAPI can't, a notice says why.

      Parameters

      • on: boolean

      Returns void

    • The user asked for a change to their devices (turned the microphone, camera or share on or off, or switched a device): the device notice goes, since it was about an earlier request. Should this one fail too, its own shows.

      Returns void

    • The user hid their self-view, showed it again, or reset the layout: keep it and save it. When saving fails, it still holds for this session.

      Parameters

      • hidden: boolean

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    AddErrorAddingAgentAddModelIdAddTargetIdAddTurnAddressingAddTurnModeAddVoiceAddVoiceOptionAgentAvatarUrlAgentIDAgentNameAgentsInRoomAgentVisionNoticeAutoStartAvailableAgentsAvailableModelsAvatarNoticeLabelsCanPickModelVoiceConnectedConnectTimeoutMsDataReceivedDeviceNoticeDisconnectedDisplayNameE2EEPassphraseE2EEWorkerEnableAgentManagementEnableAgentVisionControlEnableBackgroundEffectsEnableCameraControlEnableDeviceSettingsEnableEndForAllEnableHandoffEnableInviteEnableLayoutSwitcherEnableLeaveControlEnableMicrophoneControlEnableNoiseFilterEnablePinningEnableRecordingEnableScreenShareControlEnableTurnTakingEndingMeetingerrorMessageErrorOccurredInviteCopiedInvitePeopleRequestedIsRecordingLayoutLoadingModeParticipantJoinedParticipantLeftPipRectsProviderRealtimeModelIDRealtimeVoiceRecordingFileIdResolvedDisplayNameResolvedRoomNameRoomNameRoomOptionsRosterBadgesSelfViewHiddenServerUrlSessionStartedShowAgentsPanelShowAgentStateShowChatShowControlBarShowHeaderShowParticipantsPanelShowPreJoinShowRecordingPanelShowTurnPanelShowWhiteboardStartWithCameraStartWithMicrophoneTargetAgentIDTileMovesTitleTokenTurnAddressingTurnAddressingOptionsTurnErrorTurnModeTurnModeOptionsTurnPillLabelTurnPollIntervalMsTurnStateUUIDsEqualɵdirɵfac
    Accessors
    Methods