LiveSession

@PublicPreviewAPI
class LiveSession

Represents a live WebSocket session capable of streaming content to and from the server.

Summary

Public functions
suspend Unit

Closes the client session.
Flow<LiveContentResponse>

Receives responses from the model for both streaming and standard requests.
suspend Unit
send(content: Content)

Sends data to the model.
suspend Unit
send(text: String)

Sends text to the model.
suspend Unit

Sends function calling responses to the model.
suspend Unit

Streams client data to the model.
suspend Unit
@RequiresPermission(value = "android.permission.RECORD_AUDIO")
startAudioConversation(
    functionCallHandler: ((FunctionCallPart) -> FunctionResponsePart)?
)

Starts an audio conversation with the model, which can only be stopped using stopAudioConversation or close.
Unit

Stops the audio conversation with the model.
Unit

Stops receiving from the model.

Public functions

close

suspend fun close(): Unit

Closes the client session.

Once a LiveSession is closed, it can not be reopened; you'll need to start a new LiveSession.

See also
stopReceiving

receive

fun receive(): Flow<LiveContentResponse>

Receives responses from the model for both streaming and standard requests.

Call close to stop receiving responses from the model.

Returns
Flow<LiveContentResponse>

A Flow which will emit LiveContentResponse from the model.
Throws
com.google.firebase.vertexai.type.SessionAlreadyReceivingException: com.google.firebase.vertexai.type.SessionAlreadyReceivingException

when the session is already receiving.
See also
stopReceiving

send

suspend fun send(content: Content): Unit

Sends data to the model.

Calling this after startAudioConversation will play the response audio immediately.

Parameters
content: Content

Client Content to be sent to the model.

send

suspend fun send(text: String): Unit

Sends text to the model.

Calling this after startAudioConversation will play the response audio immediately.

Parameters
text: String

Text to be sent to the model.

sendFunctionResponse

suspend fun sendFunctionResponse(functionList: List<FunctionResponsePart>): Unit

Sends function calling responses to the model.

NOTE: If you're using startAudioConversation, the method will handle sending function responses to the model for you. You do not need to call this method in that case.

Parameters
functionList: List<FunctionResponsePart>

The list of FunctionResponsePart instances indicating the function response from the client.

sendMediaStream

suspend fun sendMediaStream(mediaChunks: List<MediaData>): Unit

Streams client data to the model.

Calling this after startAudioConversation will play the response audio immediately.

Parameters
mediaChunks: List<MediaData>

The list of MediaData instances representing the media data to be sent.

startAudioConversation

@RequiresPermission(value = "android.permission.RECORD_AUDIO")
suspend fun startAudioConversation(
    functionCallHandler: ((FunctionCallPart) -> FunctionResponsePart)? = null
): Unit

Starts an audio conversation with the model, which can only be stopped using stopAudioConversation or close.

Parameters
functionCallHandler: ((FunctionCallPart) -> FunctionResponsePart)? = null

A callback function that is invoked whenever the model receives a function call. The FunctionResponsePart that the callback function returns will be automatically sent to the model.

stopAudioConversation

fun stopAudioConversation(): Unit

Stops the audio conversation with the model.

This only needs to be called after a previous call to startAudioConversation.

If there is no audio conversation currently active, this function does nothing.

stopReceiving

fun stopReceiving(): Unit

Stops receiving from the model.

If this function is called during an ongoing audio conversation, the model's response will not be received, and no audio will be played; the live session object will no longer receive data from the server.

To resume receiving data, you must either handle it directly using receive, or indirectly by using startAudioConversation.

See also
close