Skip to content

Commit 1c2a669

Browse files
committed
Better kdoc
1 parent 6b6ff20 commit 1c2a669

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

firebase-ai/src/main/kotlin/com/google/firebase/ai/type/LiveSession.kt

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -257,10 +257,14 @@ internal constructor(
257257
}
258258

259259
/**
260-
* Sends audio data to the server in realtime. Check
261-
* https://ai.google.dev/api/live#bidigeneratecontentrealtimeinput for details about the realtime
262-
* input usage.
263-
* @param audio The audio data to send.
260+
* Sends an audio input stream to the model, using the realtime API.
261+
*
262+
* To learn more about audio formats, and the required state they should be provided in, see the
263+
* docs on
264+
* [Supported audio formats](https://cloud.google.com/vertex-ai/generative-ai/docs/live-api#supported-audio-formats).
265+
*
266+
* @param audio Raw audio data used to update the model on the client's conversation. For best
267+
* results, send 16-bit PCM audio at 24kHz.
264268
*/
265269
public suspend fun sendAudioRealtime(audio: InlineData) {
266270
FirebaseAIException.catchAsync {
@@ -271,10 +275,11 @@ internal constructor(
271275
}
272276

273277
/**
274-
* Sends video data to the server in realtime. Check
275-
* https://ai.google.dev/api/live#bidigeneratecontentrealtimeinput for details about the realtime
276-
* input usage.
277-
* @param video The video data to send. Video MIME type could be either video or image.
278+
* Sends a video input stream to the model, using the realtime API.
279+
*
280+
* @param video Encoded video data, used to update the model on the client's conversation. The
281+
* MIME type can be a video format (e.g., `video/webm`) or an image format (e.g.,
282+
* `image/jpeg`).
278283
*/
279284
public suspend fun sendVideoRealtime(video: InlineData) {
280285
FirebaseAIException.catchAsync {
@@ -285,10 +290,9 @@ internal constructor(
285290
}
286291

287292
/**
288-
* Sends text data to the server in realtime. Check
289-
* https://ai.google.dev/api/live#bidigeneratecontentrealtimeinput for details about the realtime
290-
* input usage.
291-
* @param text The text data to send.
293+
* Sends a text input stream to the model, using the realtime API.
294+
*
295+
* @param text Text content to append to the current client's conversation.
292296
*/
293297
public suspend fun sendTextRealtime(text: String) {
294298
FirebaseAIException.catchAsync {

0 commit comments

Comments
 (0)