Gemini

Gemini provides a VoxEngine client for connecting a call or media unit to the Google Gemini Live API over WebSocket.

Use Gemini.createLiveAPIClient(...) to create a LiveAPIClient for the current scenario.

Related guides

Contents

• Usage: required module import and basic flow.
• Factory functions: create the Gemini Live client.
• Methods: media, response, and connection control methods.
• Events: WebSocket media bridge events.
• LiveAPIEvents: Gemini Live API event names and payload fields.

Usage

Add the module before using the namespace:

1
require(Modules.Gemini);

Create the client, bridge media, and listen for Live API events.

Factory functions

createLiveAPIClient

Creates a Gemini.LiveAPIClient instance.

1
createLiveAPIClient(parameters: LiveAPIClientParameters): Promise<LiveAPIClient>

Parameters

Returns

LiveAPIClient

Methods

addEventListener

Adds a handler for the specified Gemini.LiveAPIEvents or Gemini.Events event. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler is called.

1
addEventListener(event: Events | LiveAPIEvents | string, callback: (event: object) => any): void

Parameters

Returns

clearMediaBuffer

Clears the LiveAPI WebSocket media buffer.

1
clearMediaBuffer(parameters?: ClearMediaBufferParameters): void

Parameters

Returns

close

Closes the LiveAPI connection (over WebSocket) or connection attempt.

1
close(): void

Parameters

This method does not accept parameters.

Returns

id

Returns the LiveAPIClient id.

1
id(): string

Parameters

This method does not accept parameters.

Returns

removeEventListener

Removes a handler for the specified Gemini.LiveAPIEvents or Gemini.Events event.

1
removeEventListener(event: Events | LiveAPIEvents | string, callback?: (event: object) => any): void

Parameters

Returns

sendClientContent

Transmits a LiveClientContent over the established connection. https://pkg.go.dev/google.golang.org/genai@v1.57.0#Session.SendClientContent

1
sendClientContent(input: Object): void

Parameters

Returns

sendMediaTo

Starts sending media from the LiveAPI (via WebSocket) to the media unit. LiveAPI works in real time.

1
sendMediaTo(mediaUnit: VoxMediaUnit, parameters?: SendMediaParameters): void

Parameters

Returns

sendRealtimeInput

Transmits a LiveClientRealtimeInput over the established connection. https://pkg.go.dev/google.golang.org/genai@v1.57.0#Session.SendRealtimeInput

1
sendRealtimeInput(input: Object): void

Parameters

Returns

sendToolResponse

Transmits a LiveClientToolResponse over the established connection. https://pkg.go.dev/google.golang.org/genai@v1.57.0#Session.SendToolResponse

1
sendToolResponse(input: Object): void

Parameters

Returns

stopMediaTo

Stops sending media from the LiveAPI (via WebSocket) to the media unit.

1
stopMediaTo(mediaUnit: VoxMediaUnit): void

Parameters

Returns

webSocketId

Returns the LiveAPI WebSocket id.

1
webSocketId(): string

Parameters

This method does not accept parameters.

Returns

Events

These events describe audio received through the Gemini WebSocket media bridge.

WebSocketMediaStarted

Triggered when the audio stream sent by a third party through a Gemini WebSocket is started playing.

Event constant: Events.WebSocketMediaStarted

Payload

WebSocketMediaEnded

Triggers after the end of the audio stream sent by a third party through a Gemini WebSocket (1 second of silence).

Event constant: Events.WebSocketMediaEnded

Payload

LiveAPIEvents

These events mirror server messages from the Gemini Live API. The data field contains the provider event payload.