Class LiveSessionBeta

constructor

• new LiveSession(
      _setupMessage: _LiveClientSetup,
      _apiSettings: ApiSettings,
      _sessionResumption?: SessionResumptionConfig,
      _webSocketHandler?: WebSocketHandler,
  ): LiveSession
  Internal

  Parameters

  • _setupMessage: _LiveClientSetup
  • _apiSettings: ApiSettings
  • Optional_sessionResumption: SessionResumptionConfig
  • Optional_webSocketHandler: WebSocketHandler

  Returns LiveSession

_connectSession

• _connectSession(sessionResumption?: SessionResumptionConfig): Promise<void>
  Internal

  Initializes connection to the WebSocket. Should be called immediately after instantiation.

  Parameters

  • OptionalsessionResumption: SessionResumptionConfig

  Returns Promise<void>

close

• close(): Promise<void>
  Beta

  Closes this session. All methods on this session will throw an error once this resolves.

  Returns Promise<void>

receive

• receive(): AsyncGenerator<
      | LiveServerContent
      | LiveServerToolCall
      | LiveServerToolCallCancellation
      | LiveServerGoingAwayNotice
      | LiveSessionResumptionUpdate,
  >
  Beta

  Yields messages received from the server. This can only be used by one consumer at a time.

  Returns AsyncGenerator<
      | LiveServerContent
      | LiveServerToolCall
      | LiveServerToolCallCancellation
      | LiveServerGoingAwayNotice
      | LiveSessionResumptionUpdate,
  >

  An AsyncGenerator that yields server messages as they arrive.

  Throws

  If the session is already closed, or if we receive a response that we don't support.

resumeSession

• resumeSession(sessionResumption?: SessionResumptionConfig): Promise<void>
  Beta

  Resumes an existing live session with the server.

  This closes the current WebSocket connection and establishes a new one using the same configuration (URI, headers, model, system instruction, tools, etc.) as the original session.

  Parameters

  • OptionalsessionResumption: SessionResumptionConfig

    The configuration for session resumption, such as the handle to the previous session state to restore.

  Returns Promise<void>

  Throws

  If the session resumption configuration is unsupported.

send

• send(request: string | (string | Part)[], turnComplete?: boolean): Promise<void>
  Beta

  Sends content to the server.

  Parameters

  • request: string | (string | Part)[]

    The message to send to the model.

  • turnComplete: boolean = true

    Indicates if the turn is complete. Defaults to false.

  Returns Promise<void>

  Throws

  If this session has been closed.

sendAudioRealtime

• sendAudioRealtime(blob: GenerativeContentBlob): Promise<void>
  Beta

  Sends audio data to the server in realtime.

  Parameters

  • blob: GenerativeContentBlob

    The base64-encoded PCM data to send to the server in realtime.

  Returns Promise<void>

  Remarks

  The server requires that the audio data is base64-encoded 16-bit PCM at 16kHz little-endian.

  Example

  // const pcmData = ... base64-encoded 16-bit PCM at 16kHz little-endian.
  const blob = { mimeType: "audio/pcm", data: pcmData };
  liveSession.sendAudioRealtime(blob);
  Copy

  Throws

  If this session has been closed.

sendFunctionResponses

• sendFunctionResponses(functionResponses: FunctionResponse[]): Promise<void>
  Beta

  Sends function responses to the server.

  Parameters

  • functionResponses: FunctionResponse[]

    The function responses to send.

  Returns Promise<void>

  Throws

  If this session has been closed.

sendMediaChunks

• sendMediaChunks(mediaChunks: GenerativeContentBlob[]): Promise<void>
  Beta

  Sends realtime input to the server.

  Parameters

  • mediaChunks: GenerativeContentBlob[]

    The media chunks to send.

  Returns Promise<void>

  Deprecated

  Use sendTextRealtime(), sendAudioRealtime(), and sendVideoRealtime() instead.

  Throws

  If this session has been closed.

sendMediaStream

• sendMediaStream(
      mediaChunkStream: ReadableStream<GenerativeContentBlob>,
  ): Promise<void>
  Beta

  Parameters

  • mediaChunkStream: ReadableStream<GenerativeContentBlob>

    The stream of GenerativeContentBlob to send.

  Returns Promise<void>

  Deprecated

  Use sendTextRealtime(), sendAudioRealtime(), and sendVideoRealtime() instead.

  Sends a stream of GenerativeContentBlob.

  Throws

  If this session has been closed.

sendTextRealtime

• sendTextRealtime(text: string): Promise<void>
  Beta

  Sends text to the server in realtime.

  Parameters

  • text: string

    The text data to send.

  Returns Promise<void>

  Example

  liveSession.sendTextRealtime("Hello, how are you?");
  Copy

  Throws

  If this session has been closed.

sendVideoRealtime

• sendVideoRealtime(blob: GenerativeContentBlob): Promise<void>
  Beta

  Sends video data to the server in realtime.

  Parameters

  • blob: GenerativeContentBlob

    The base64-encoded video data to send to the server in realtime.

  Returns Promise<void>

  Remarks

  The server requires that the video is sent as individual video frames at 1 FPS. It is recommended to set mimeType to image/jpeg.

  Example

  // const videoFrame = ... base64-encoded JPEG data
  const blob = { mimeType: "image/jpeg", data: videoFrame };
  liveSession.sendVideoRealtime(blob);
  Copy

  Throws

  If this session has been closed.

BetaconnectionPromise

BetainConversation

BetaisClosed