Class SynthesizeSpeechConfig

  • All Implemented Interfaces:
    SynthesizeSpeechConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class SynthesizeSpeechConfig
    extends com.google.protobuf.GeneratedMessageV3
    implements SynthesizeSpeechConfigOrBuilder
     Configuration of how speech should be synthesized.
     
    Protobuf type google.cloud.dialogflow.cx.v3.SynthesizeSpeechConfig
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getSpeakingRate

        public double getSpeakingRate()
         Optional. 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.
         
        double speaking_rate = 1;
        Specified by:
        getSpeakingRate in interface SynthesizeSpeechConfigOrBuilder
        Returns:
        The speakingRate.
      • getPitch

        public double getPitch()
         Optional. 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 = 2;
        Specified by:
        getPitch in interface SynthesizeSpeechConfigOrBuilder
        Returns:
        The pitch.
      • getVolumeGainDb

        public double getVolumeGainDb()
         Optional. 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. We 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 = 3;
        Specified by:
        getVolumeGainDb in interface SynthesizeSpeechConfigOrBuilder
        Returns:
        The volumeGainDb.
      • getEffectsProfileIdList

        public com.google.protobuf.ProtocolStringList getEffectsProfileIdList()
         Optional. 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.
         
        repeated string effects_profile_id = 5;
        Specified by:
        getEffectsProfileIdList in interface SynthesizeSpeechConfigOrBuilder
        Returns:
        A list containing the effectsProfileId.
      • getEffectsProfileIdCount

        public int getEffectsProfileIdCount()
         Optional. 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.
         
        repeated string effects_profile_id = 5;
        Specified by:
        getEffectsProfileIdCount in interface SynthesizeSpeechConfigOrBuilder
        Returns:
        The count of effectsProfileId.
      • getEffectsProfileId

        public String getEffectsProfileId​(int index)
         Optional. 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.
         
        repeated string effects_profile_id = 5;
        Specified by:
        getEffectsProfileId in interface SynthesizeSpeechConfigOrBuilder
        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. 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.
         
        repeated string effects_profile_id = 5;
        Specified by:
        getEffectsProfileIdBytes in interface SynthesizeSpeechConfigOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the effectsProfileId at the given index.
      • hasVoice

        public boolean hasVoice()
         Optional. The desired voice of the synthesized audio.
         
        .google.cloud.dialogflow.cx.v3.VoiceSelectionParams voice = 4;
        Specified by:
        hasVoice in interface SynthesizeSpeechConfigOrBuilder
        Returns:
        Whether the voice field is set.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static SynthesizeSpeechConfig parseFrom​(ByteBuffer data)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SynthesizeSpeechConfig parseFrom​(ByteBuffer data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SynthesizeSpeechConfig parseFrom​(com.google.protobuf.ByteString data)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SynthesizeSpeechConfig parseFrom​(com.google.protobuf.ByteString data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SynthesizeSpeechConfig parseFrom​(byte[] data)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SynthesizeSpeechConfig parseFrom​(byte[] data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • newBuilderForType

        public SynthesizeSpeechConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public SynthesizeSpeechConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected SynthesizeSpeechConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<SynthesizeSpeechConfig> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

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