AudioConfig (Cloud Text-to-Speech API v1 (Rev. 62) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.texttospeech.v1.model.AudioConfig

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class AudioConfig
extends com.google.api.client.json.GenericJson
```
Description of audio data to be synthesized.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Text-to-Speech API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

AudioConfig()

Constructors
Constructor and Description
`AudioConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AudioConfig`	`clone()`
`java.lang.String`	`getAudioEncoding()` Required.
`java.util.List<java.lang.String>`	`getEffectsProfileId()` Optional.
`java.lang.Double`	`getPitch()` Optional.
`java.lang.Integer`	`getSampleRateHertz()` Optional.
`java.lang.Double`	`getSpeakingRate()` Optional.
`java.lang.Double`	`getVolumeGainDb()` Optional.
`AudioConfig`	`set(java.lang.String fieldName, java.lang.Object value)`
`AudioConfig`	`setAudioEncoding(java.lang.String audioEncoding)` Required.
`AudioConfig`	`setEffectsProfileId(java.util.List<java.lang.String> effectsProfileId)` Optional.
`AudioConfig`	`setPitch(java.lang.Double pitch)` Optional.
`AudioConfig`	`setSampleRateHertz(java.lang.Integer sampleRateHertz)` Optional.
`AudioConfig`	`setSpeakingRate(java.lang.Double speakingRate)` Optional.
`AudioConfig`	`setVolumeGainDb(java.lang.Double volumeGainDb)` Optional.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - AudioConfig
```
public AudioConfig()
```
- Method Detail
  - getAudioEncoding
```
public java.lang.String getAudioEncoding()
```
    Required. The format of the audio byte stream.
    
    Returns:
    
    value or null for none
  - setAudioEncoding
```
public AudioConfig setAudioEncoding(java.lang.String audioEncoding)
```
    Required. The format of the audio byte stream.
    
    Parameters:
    
    audioEncoding - audioEncoding or null for none
  - getEffectsProfileId
```
public java.util.List<java.lang.String> getEffectsProfileId()
```
    Optional. Input only. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. See [audio profiles](https://cloud.google.com/text-to-speech/docs/audio-profiles) for current supported profile ids.
    
    Returns:
    
    value or null for none
  - setEffectsProfileId
```
public AudioConfig setEffectsProfileId(java.util.List<java.lang.String> effectsProfileId)
```
    Optional. Input only. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. See [audio profiles](https://cloud.google.com/text-to-speech/docs/audio-profiles) for current supported profile ids.
    
    Parameters:
    
    effectsProfileId - effectsProfileId or null for none
  - getPitch
```
public java.lang.Double getPitch()
```
    Optional. Input only. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
    
    Returns:
    
    value or null for none
  - setPitch
```
public AudioConfig setPitch(java.lang.Double pitch)
```
    Optional. Input only. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
    
    Parameters:
    
    pitch - pitch or null for none
  - getSampleRateHertz
```
public java.lang.Integer getSampleRateHertz()
```
    Optional. The synthesis sample rate (in hertz) for this audio. When this is specified in SynthesizeSpeechRequest, if this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality), unless the specified sample rate is not supported for the encoding chosen, in which case it will fail the request and return google.rpc.Code.INVALID_ARGUMENT.
    
    Returns:
    
    value or null for none
  - setSampleRateHertz
```
public AudioConfig setSampleRateHertz(java.lang.Integer sampleRateHertz)
```
    Optional. The synthesis sample rate (in hertz) for this audio. When this is specified in SynthesizeSpeechRequest, if this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality), unless the specified sample rate is not supported for the encoding chosen, in which case it will fail the request and return google.rpc.Code.INVALID_ARGUMENT.
    
    Parameters:
    
    sampleRateHertz - sampleRateHertz or null for none
  - getSpeakingRate
```
public java.lang.Double getSpeakingRate()
```
    Optional. Input only. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
    
    Returns:
    
    value or null for none
  - setSpeakingRate
```
public AudioConfig setSpeakingRate(java.lang.Double speakingRate)
```
    Optional. Input only. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
    
    Parameters:
    
    speakingRate - speakingRate or null for none
  - getVolumeGainDb
```
public java.lang.Double getVolumeGainDb()
```
    Optional. Input only. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. Strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
    
    Returns:
    
    value or null for none
  - setVolumeGainDb
```
public AudioConfig setVolumeGainDb(java.lang.Double volumeGainDb)
```
    Optional. Input only. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. Strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
    
    Parameters:
    
    volumeGainDb - volumeGainDb or null for none
  - set
```
public AudioConfig set(java.lang.String fieldName,
                       java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public AudioConfig clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Cloud Text-to-Speech API v1 (revision 62)

Class AudioConfig

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

AudioConfig

Method Detail

getAudioEncoding

setAudioEncoding

getEffectsProfileId

setEffectsProfileId

getPitch

setPitch

getSampleRateHertz

setSampleRateHertz

getSpeakingRate

setSpeakingRate

getVolumeGainDb

setVolumeGainDb

set

clone