LiveSessionFutures
@PublicPreviewAPI
public abstract classLiveSessionFutures
Wrapper class providing Java compatible methods forLiveSession.
| See also | |
|---|---|
LiveSession |
Summary
Nested types |
|---|
public static classLiveSessionFutures.Companion |
Public methods | |
|---|---|
abstract @NonNullListenableFuture<Unit> | close()Closes the client session. |
static final @NonNullLiveSessionFutures | from(@NonNullLiveSession session) |
abstract @NonNullPublisher<@NonNullLiveServerMessage> | receive()Receives responses from the model for both streaming and standard requests. |
abstract @NonNullListenableFuture<Unit> | Sends |
abstract @NonNullListenableFuture<Unit> | Sends text to the model. |
abstract @NonNullListenableFuture<Unit> | sendAudioRealtime(@NonNullInlineData audio)Sends an audio input stream to the model, using the realtime API. |
abstract @NonNullListenableFuture<Unit> | sendFunctionResponse(Sends function calling responses to the model. |
abstract @NonNullListenableFuture<Unit> | This method is deprecated. Use `sendAudioRealtime`, `sendVideoRealtime`, or `sendTextRealtime` instead |
abstract @NonNullListenableFuture<Unit> | sendTextRealtime(@NonNullString text)For details about the realtime input usage, see the |
abstract @NonNullListenableFuture<Unit> | sendVideoRealtime(@NonNullInlineData video)Sends a video input stream to the model, using the realtime API. |
abstract @NonNullListenableFuture<Unit> | @RequiresPermission(value = "android.permission.RECORD_AUDIO")Starts an audio conversation with the model, which can only be stopped using |
abstract @NonNullListenableFuture<Unit> | @RequiresPermission(value = "android.permission.RECORD_AUDIO")Starts an audio conversation with the model, which can only be stopped using |
abstract @NonNullListenableFuture<Unit> | @RequiresPermission(value = "android.permission.RECORD_AUDIO")Starts an audio conversation with the model, which can only be stopped using |
abstract @NonNullListenableFuture<Unit> | @RequiresPermission(value = "android.permission.RECORD_AUDIO")Starts an audio conversation with the model, which can only be stopped using |
abstract @NonNullListenableFuture<Unit> | @RequiresPermission(value = "android.permission.RECORD_AUDIO")Starts an audio conversation with the model, which can only be stopped using |
abstract @NonNullListenableFuture<Unit> | @RequiresPermission(value = "android.permission.RECORD_AUDIO")Starts an audio conversation with the model, which can only be stopped using |
abstract @NonNullListenableFuture<Unit> | @RequiresPermission(value = "android.permission.RECORD_AUDIO")Starts an audio conversation with the model, which can only be stopped using |
abstract @NonNullListenableFuture<Unit> | @RequiresPermission(value = "android.permission.RECORD_AUDIO")Starts an audio conversation with the model, which can only be stopped using |
abstract @NonNullListenableFuture<Unit> | @RequiresPermission(value = "android.permission.RECORD_AUDIO")Stops the audio conversation with the Gemini Server. |
abstract void | Stops receiving from the model. |
Public methods
close
public abstract @NonNullListenableFuture<Unit> close()
Closes the client session.
Once aLiveSession is closed, it can not be reopened; you'll need to start a newLiveSession.
| See also | |
|---|---|
stopReceiving |
from
public static final @NonNullLiveSessionFutures from(@NonNullLiveSession session)
| Returns | |
|---|---|
@NonNullLiveSessionFutures | a |
receive
public abstract @NonNullPublisher<@NonNullLiveServerMessage> receive()
Receives responses from the model for both streaming and standard requests.
Callclose to stop receiving responses from the model.
| Returns | |
|---|---|
@NonNullPublisher<@NonNullLiveServerMessage> | A |
| Throws | |
|---|---|
com.google.firebase.ai.type.SessionAlreadyReceivingException com.google.firebase.ai.type.SessionAlreadyReceivingException | when the session is already receiving. |
| See also | |
|---|---|
stopReceiving |
send
public abstract @NonNullListenableFuture<Unit> send(@NonNullContent content)
Sendsdata to the model.
Calling this afterstartAudioConversation will play the response audio immediately.
send
public abstract @NonNullListenableFuture<Unit> send(@NonNullString text)
Sends text to the model.
Calling this afterstartAudioConversation will play the response audio immediately.
sendAudioRealtime
public abstract @NonNullListenableFuture<Unit> sendAudioRealtime(@NonNullInlineData audio)
Sends an audio input stream to the model, using the realtime API.
| Parameters | |
|---|---|
@NonNullInlineData audio | The audio data to send. |
sendFunctionResponse
public abstract @NonNullListenableFuture<Unit> sendFunctionResponse(
@NonNullList<@NonNullFunctionResponsePart> functionList
)
Sends function calling responses to the model.
| Parameters | |
|---|---|
@NonNullList<@NonNullFunctionResponsePart> functionList | The list of |
sendMediaStream
public abstract @NonNullListenableFuture<Unit>sendMediaStream(@NonNullList<@NonNullMediaData> mediaChunks)
Use `sendAudioRealtime`, `sendVideoRealtime`, or `sendTextRealtime` instead
Streams client data to the model.
Calling this afterstartAudioConversation will play the response audio immediately.
sendTextRealtime
public abstract @NonNullListenableFuture<Unit> sendTextRealtime(@NonNullString text)
For details about the realtime input usage, see theBidiGenerateContentRealtimeInput documentation (Gemini Developer API orVertex AI Gemini API ).
sendVideoRealtime
public abstract @NonNullListenableFuture<Unit> sendVideoRealtime(@NonNullInlineData video)
Sends a video input stream to the model, using the realtime API.
| Parameters | |
|---|---|
@NonNullInlineData video | The video data to send. Video MIME type could be either video or image. |
startAudioConversation
@RequiresPermission(value = "android.permission.RECORD_AUDIO")
public abstract @NonNullListenableFuture<Unit> startAudioConversation()
Starts an audio conversation with the model, which can only be stopped usingstopAudioConversation.
startAudioConversation
@RequiresPermission(value = "android.permission.RECORD_AUDIO")
public abstract @NonNullListenableFuture<Unit> startAudioConversation(boolean enableInterruptions)
Starts an audio conversation with the model, which can only be stopped usingstopAudioConversation orclose.
| Parameters | |
|---|---|
boolean enableInterruptions | If enabled, allows the user to speak over or interrupt the model's ongoing reply. WARNING: The user interruption feature relies on device-specific support, and may not be consistently available. |
startAudioConversation
@RequiresPermission(value = "android.permission.RECORD_AUDIO")
public abstract @NonNullListenableFuture<Unit> startAudioConversation(
Function1<@NonNullFunctionCallPart, @NonNullFunctionResponsePart> functionCallHandler
)
Starts an audio conversation with the model, which can only be stopped usingstopAudioConversation orclose.
| Parameters | |
|---|---|
Function1<@NonNullFunctionCallPart, @NonNullFunctionResponsePart> functionCallHandler | A callback function that is invoked whenever the model receives a function call. |
startAudioConversation
@RequiresPermission(value = "android.permission.RECORD_AUDIO")
public abstract @NonNullListenableFuture<Unit> startAudioConversation(
@NonNullLiveAudioConversationConfig liveAudioConversationConfig
)
Starts an audio conversation with the model, which can only be stopped usingstopAudioConversation.
| Parameters | |
|---|---|
@NonNullLiveAudioConversationConfig liveAudioConversationConfig | A |
startAudioConversation
@RequiresPermission(value = "android.permission.RECORD_AUDIO")
public abstract @NonNullListenableFuture<Unit> startAudioConversation(
Function2<Transcription, Transcription, Unit> transcriptHandler
)
Starts an audio conversation with the model, which can only be stopped usingstopAudioConversation.
| Parameters | |
|---|---|
Function2<Transcription, Transcription, Unit> transcriptHandler | A callback function that is invoked whenever the model receives a transcript. The first |
startAudioConversation
@RequiresPermission(value = "android.permission.RECORD_AUDIO")
public abstract @NonNullListenableFuture<Unit> startAudioConversation(
Function1<@NonNullFunctionCallPart, @NonNullFunctionResponsePart> functionCallHandler,
boolean enableInterruptions
)
Starts an audio conversation with the model, which can only be stopped usingstopAudioConversation orclose.
| Parameters | |
|---|---|
Function1<@NonNullFunctionCallPart, @NonNullFunctionResponsePart> functionCallHandler | A callback function that is invoked whenever the model receives a function call. |
boolean enableInterruptions | If enabled, allows the user to speak over or interrupt the model's ongoing reply. WARNING: The user interruption feature relies on device-specific support, and may not be consistently available. |
startAudioConversation
@RequiresPermission(value = "android.permission.RECORD_AUDIO")
public abstract @NonNullListenableFuture<Unit> startAudioConversation(
Function2<Transcription, Transcription, Unit> transcriptHandler,
boolean enableInterruptions
)
Starts an audio conversation with the model, which can only be stopped usingstopAudioConversation orclose.
| Parameters | |
|---|---|
Function2<Transcription, Transcription, Unit> transcriptHandler | A callback function that is invoked whenever the model receives a transcript. The first |
boolean enableInterruptions | If enabled, allows the user to speak over or interrupt the model's ongoing reply. WARNING: The user interruption feature relies on device-specific support, and may not be consistently available. |
startAudioConversation
@RequiresPermission(value = "android.permission.RECORD_AUDIO")
public abstract @NonNullListenableFuture<Unit> startAudioConversation(
Function1<@NonNullFunctionCallPart, @NonNullFunctionResponsePart> functionCallHandler,
Function2<Transcription, Transcription, Unit> transcriptHandler,
boolean enableInterruptions
)
Starts an audio conversation with the model, which can only be stopped usingstopAudioConversation orclose.
| Parameters | |
|---|---|
Function1<@NonNullFunctionCallPart, @NonNullFunctionResponsePart> functionCallHandler | A callback function that is invoked whenever the model receives a function call. |
Function2<Transcription, Transcription, Unit> transcriptHandler | A callback function that is invoked whenever the model receives a transcript. The first |
boolean enableInterruptions | If enabled, allows the user to speak over or interrupt the model's ongoing reply. WARNING: The user interruption feature relies on device-specific support, and may not be consistently available. |
stopAudioConversation
@RequiresPermission(value = "android.permission.RECORD_AUDIO")
public abstract @NonNullListenableFuture<Unit> stopAudioConversation()
Stops the audio conversation with the Gemini Server.
This only needs to be called after a previous call tostartAudioConversation.
If there is no audio conversation currently active, this function does nothing.
stopReceiving
public abstract void stopReceiving()
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 usingreceive, or indirectly by usingstartAudioConversation.
| See also | |
|---|---|
close |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-11 UTC.