Member Junction
    Preparing search index...

    Interface StartAgentRoomSessionParams

    Parameters for LiveKitAgentRoomCoordinator.StartAgentRoomSession.

    interface StartAgentRoomSessionParams {
        AgentAliases?: string[];
        AgentID?: string;
        AgentName?: string;
        AgentSessionID: string;
        ContextUser?: UserInfo;
        FullDuplex?: boolean;
        Host?: AgentRoomHostOptions;
        MetadataProvider?: IMetadataProvider;
        RealtimeModelID?: string;
        RealtimeVoice?: string;
        RoomName: string;
        TargetAgentID?: string;
        TurnAddressing?: TurnAddressingMode;
        TurnMode?: BridgeTurnMode;
    }
    Index

    Properties

    AgentAliases? AgentID? AgentName? AgentSessionID ContextUser? FullDuplex? Host? MetadataProvider? RealtimeModelID? RealtimeVoice? RoomName TargetAgentID? TurnAddressing? TurnMode?

    Properties

    AgentAliases?: string[]

    Extra aliases the agent answers to (for Passive turn-taking).

    AgentID?: string

    The agent to voice, when known.

    AgentName?: string

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

    AgentSessionID: string

    The MJ agent-session id this bridge belongs to.

    ContextUser?: UserInfo

    The user the session runs as.

    FullDuplex?: boolean

    Explicit override for whether the model is full-duplex. When omitted, resolved from model metadata or driver capabilities.

    Host?: AgentRoomHostOptions

    What a host that owns the call adds (tools, framing, transcript, recovery). A plain Meet room passes at most its end-of-session hook, to close the agent session it created.

    MetadataProvider?: IMetadataProvider

    The metadata provider for the session.

    RealtimeModelID?: string

    Optional per-session Realtime MODEL override (Name or ID) — wins over the co-agent config preference.

    RealtimeVoice?: string

    Optional per-session VOICE override (provider-native voice id) — gives this agent a distinct voice.

    RoomName: string

    The LiveKit room the agent should join.

    TargetAgentID?: string

    The TARGET agent the co-agent voices (the one being "called"). Passed through to the realtime session factory so the Realtime Co-Agent has someone to delegate to via invoke-target-agent.

    TurnAddressing?: TurnAddressingMode

    How the agent decides it was addressed. 'Auto' (the default) uses the MODEL's own judgement when its model is full-duplex and falls back to name matching otherwise; 'ModelSide' / 'Regex' force one. A room in moderator mode (gated meeting) always uses 'Regex'.

    TurnMode?: BridgeTurnMode

    Turn-taking mode. Default: 'Passive' (speak only when addressed).

    Settings

    Member Visibility

    On This Page

    Properties