Package com.google.cloud.texttospeech.v1

Class AudioConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<AudioConfig.Builder>
com.google.cloud.texttospeech.v1.AudioConfig.Builder
All Implemented Interfaces:
AudioConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
AudioConfig
public static final class AudioConfig.Builder extends com.google.protobuf.GeneratedMessage.Builder<AudioConfig.Builder> implements AudioConfigOrBuilder
 Description of audio data to be synthesized.
Protobuf type google.cloud.texttospeech.v1.AudioConfig

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<AudioConfig.Builder>

    • clear

      public AudioConfig.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<AudioConfig.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<AudioConfig.Builder>

    • getDefaultInstanceForType

      public AudioConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public AudioConfig build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public AudioConfig buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public AudioConfig.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AudioConfig.Builder>

    • mergeFrom

      public AudioConfig.Builder mergeFrom(AudioConfig other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<AudioConfig.Builder>

    • mergeFrom

      public AudioConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AudioConfig.Builder>
      Throws:
      IOException

    • getAudioEncodingValue

      public int getAudioEncodingValue()
       Required. The format of the audio byte stream.
      .google.cloud.texttospeech.v1.AudioEncoding audio_encoding = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAudioEncodingValue in interface AudioConfigOrBuilder
      Returns:
      The enum numeric value on the wire for audioEncoding.

    • setAudioEncodingValue

      public AudioConfig.Builder setAudioEncodingValue(int value)
       Required. The format of the audio byte stream.
      .google.cloud.texttospeech.v1.AudioEncoding audio_encoding = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The enum numeric value on the wire for audioEncoding to set.
      Returns:
      This builder for chaining.

    • getAudioEncoding

      public AudioEncoding getAudioEncoding()
       Required. The format of the audio byte stream.
      .google.cloud.texttospeech.v1.AudioEncoding audio_encoding = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAudioEncoding in interface AudioConfigOrBuilder
      Returns:
      The audioEncoding.

    • setAudioEncoding

      public AudioConfig.Builder setAudioEncoding(AudioEncoding value)
       Required. The format of the audio byte stream.
      .google.cloud.texttospeech.v1.AudioEncoding audio_encoding = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The audioEncoding to set.
      Returns:
      This builder for chaining.

    • clearAudioEncoding

      public AudioConfig.Builder clearAudioEncoding()
       Required. The format of the audio byte stream.
      .google.cloud.texttospeech.v1.AudioEncoding audio_encoding = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • getSpeakingRate

      public double getSpeakingRate()
       Optional. Input only. Speaking rate/speed, in the range [0.25, 2.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 > 2.0 will return an error.
      double speaking_rate = 2 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSpeakingRate in interface AudioConfigOrBuilder
      Returns:
      The speakingRate.

    • setSpeakingRate

      public AudioConfig.Builder setSpeakingRate(double value)
       Optional. Input only. Speaking rate/speed, in the range [0.25, 2.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 > 2.0 will return an error.
      double speaking_rate = 2 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The speakingRate to set.
      Returns:
      This builder for chaining.

    • clearSpeakingRate

      public AudioConfig.Builder clearSpeakingRate()
       Optional. Input only. Speaking rate/speed, in the range [0.25, 2.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 > 2.0 will return an error.
      double speaking_rate = 2 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • getPitch

      public 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.
      double pitch = 3 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPitch in interface AudioConfigOrBuilder
      Returns:
      The pitch.

    • setPitch

      public AudioConfig.Builder setPitch(double value)
       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.
      double pitch = 3 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The pitch to set.
      Returns:
      This builder for chaining.

    • clearPitch

      public AudioConfig.Builder clearPitch()
       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.
      double pitch = 3 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • getVolumeGainDb

      public 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.
      double volume_gain_db = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getVolumeGainDb in interface AudioConfigOrBuilder
      Returns:
      The volumeGainDb.

    • setVolumeGainDb

      public AudioConfig.Builder setVolumeGainDb(double value)
       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.
      double volume_gain_db = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The volumeGainDb to set.
      Returns:
      This builder for chaining.

    • clearVolumeGainDb

      public AudioConfig.Builder clearVolumeGainDb()
       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.
      double volume_gain_db = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • getSampleRateHertz

      public int 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][google.rpc.Code.INVALID_ARGUMENT].
      int32 sample_rate_hertz = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSampleRateHertz in interface AudioConfigOrBuilder
      Returns:
      The sampleRateHertz.

    • setSampleRateHertz

      public AudioConfig.Builder setSampleRateHertz(int value)
       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][google.rpc.Code.INVALID_ARGUMENT].
      int32 sample_rate_hertz = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The sampleRateHertz to set.
      Returns:
      This builder for chaining.

    • clearSampleRateHertz

      public AudioConfig.Builder clearSampleRateHertz()
       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][google.rpc.Code.INVALID_ARGUMENT].
      int32 sample_rate_hertz = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • getEffectsProfileIdList

      public com.google.protobuf.ProtocolStringList getEffectsProfileIdList()
       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.
      repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEffectsProfileIdList in interface AudioConfigOrBuilder
      Returns:
      A list containing the effectsProfileId.

    • getEffectsProfileIdCount

      public int getEffectsProfileIdCount()
       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.
      repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEffectsProfileIdCount in interface AudioConfigOrBuilder
      Returns:
      The count of effectsProfileId.

    • getEffectsProfileId

      public String getEffectsProfileId(int index)
       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.
      repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEffectsProfileId in interface AudioConfigOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The effectsProfileId at the given index.

    • getEffectsProfileIdBytes

      public com.google.protobuf.ByteString getEffectsProfileIdBytes(int index)
       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.
      repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEffectsProfileIdBytes in interface AudioConfigOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the effectsProfileId at the given index.

    • setEffectsProfileId

      public AudioConfig.Builder setEffectsProfileId(int index, String value)
       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.
      repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index to set the value at.
      value - The effectsProfileId to set.
      Returns:
      This builder for chaining.

    • addEffectsProfileId

      public AudioConfig.Builder addEffectsProfileId(String value)
       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.
      repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The effectsProfileId to add.
      Returns:
      This builder for chaining.

    • addAllEffectsProfileId

      public AudioConfig.Builder addAllEffectsProfileId(Iterable<String> values)
       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.
      repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Parameters:
      values - The effectsProfileId to add.
      Returns:
      This builder for chaining.

    • clearEffectsProfileId

      public AudioConfig.Builder clearEffectsProfileId()
       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.
      repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • addEffectsProfileIdBytes

      public AudioConfig.Builder addEffectsProfileIdBytes(com.google.protobuf.ByteString value)
       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.
      repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes of the effectsProfileId to add.
      Returns:
      This builder for chaining.