Package com.google.genai.types

Class AudioResponseFormat

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.AudioResponseFormat

public abstract class AudioResponseFormat
extends JsonSerializable

Configuration for audio-specific output formatting.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AudioResponseFormat.Builder	Builder for AudioResponseFormat.

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
AudioResponseFormat()

Method Summary

Modifier and Type	Method	Description
abstract Optional<Integer>	bitRate()	Optional.
static AudioResponseFormat.Builder	builder()	Instantiates a builder for AudioResponseFormat.
abstract Optional<Delivery>	delivery()	Optional.
static AudioResponseFormat	fromJson(String jsonString)	Deserializes a JSON string to a AudioResponseFormat object.
abstract Optional<String>	mimeType()	Optional.
abstract Optional<Integer>	sampleRate()	Optional.
abstract AudioResponseFormat.Builder	toBuilder()	Creates a builder with the same values as this instance.

Methods inherited from class com.google.genai.JsonSerializable

fromJsonNode, fromJsonString, objectMapper, setMaxReadLength, stringToJsonNode, toJson, toJsonNode, toJsonString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AudioResponseFormat

public AudioResponseFormat()

Method Details

bitRate

public abstract Optional<Integer> bitRate()

Optional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).

delivery

public abstract Optional<Delivery> delivery()

Optional. Delivery mode for the generated content.

mimeType

public abstract Optional<String> mimeType()

Optional. The MIME type of the audio output.

sampleRate

public abstract Optional<Integer> sampleRate()

Optional. Sample rate for the generated audio in Hertz.

builder

public static AudioResponseFormat.Builder builder()

Instantiates a builder for AudioResponseFormat.

toBuilder

public abstract AudioResponseFormat.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static AudioResponseFormat fromJson(String jsonString)

Deserializes a JSON string to a AudioResponseFormat object.