Member Junction
    Preparing search index...

    Interface GeminiClientConnectArgs

    Arguments handed to GeminiRealtimeClient.connectLiveSession. Bundles the resolved model + connect config (from the server-minted SessionConfig), the ephemeral token (or a relay session's transport and relay URL), and the lifecycle callbacks so the seam owns the entire live.connect call and tests can substitute it wholesale.

    interface GeminiClientConnectArgs {
        Config: LiveConnectConfig;
        EphemeralToken: string;
        Model: string;
        OnClose: (event: CloseEvent) => void;
        OnError: (event: ErrorEvent) => void;
        OnMessage: (message: LiveServerMessage) => void;
        RelayUrl?: string;
        Transport?: RealtimeClientTransport;
    }
    Index

    Properties

    Config EphemeralToken Model OnClose OnError OnMessage RelayUrl? Transport?

    Properties

    Config: LiveConnectConfig

    The server-built connect config (system instruction, tools, modalities, transcription).

    EphemeralToken: string

    The server-minted ephemeral auth token (used as the API key on a v1alpha client). Empty on a relay session.

    Model: string

    The Gemini Live model id to open the session against.

    OnClose: (event: CloseEvent) => void

    Invoked when the websocket closes.

    OnError: (event: ErrorEvent) => void

    Invoked on a websocket-level error (fatal).

    OnMessage: (message: LiveServerMessage) => void

    Invoked for every LiveServerMessage the server emits over the session.

    RelayUrl?: string

    A relay session's relay URL, as minted (ClientRealtimeSessionConfig.RelayUrl). It carries the relay's ticket: never log it or put it in an error message.

    Transport?: RealtimeClientTransport

    How the browser reaches the provider, as minted (ClientRealtimeSessionConfig.Transport); absent means direct.

    Settings

    Member Visibility

    On This Page

    Properties