Package com.google.cloud.texttospeech.v1

Class SynthesisInput

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.texttospeech.v1.SynthesisInput
All Implemented Interfaces:
SynthesisInputOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SynthesisInput extends com.google.protobuf.GeneratedMessage implements SynthesisInputOrBuilder
 Contains text input to be synthesized. Either `text` or `ssml` must be
 supplied. Supplying both or neither returns
 [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. The
 input size is limited to 5000 bytes.
Protobuf type google.cloud.texttospeech.v1.SynthesisInput
See Also:

  • Field Details

    • TEXT_FIELD_NUMBER

      public static final int TEXT_FIELD_NUMBER
      See Also:

    • MARKUP_FIELD_NUMBER

      public static final int MARKUP_FIELD_NUMBER
      See Also:

    • SSML_FIELD_NUMBER

      public static final int SSML_FIELD_NUMBER
      See Also:

    • MULTI_SPEAKER_MARKUP_FIELD_NUMBER

      public static final int MULTI_SPEAKER_MARKUP_FIELD_NUMBER
      See Also:

    • PROMPT_FIELD_NUMBER

      public static final int PROMPT_FIELD_NUMBER
      See Also:

    • CUSTOM_PRONUNCIATIONS_FIELD_NUMBER

      public static final int CUSTOM_PRONUNCIATIONS_FIELD_NUMBER
      See Also:

  • 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

    • getInputSourceCase

      public SynthesisInput.InputSourceCase getInputSourceCase()
      Specified by:
      getInputSourceCase in interface SynthesisInputOrBuilder

    • hasText

      public boolean hasText()
       The raw text to be synthesized.
      string text = 1;
      Specified by:
      hasText in interface SynthesisInputOrBuilder
      Returns:
      Whether the text field is set.

    • getText

      public String getText()
       The raw text to be synthesized.
      string text = 1;
      Specified by:
      getText in interface SynthesisInputOrBuilder
      Returns:
      The text.

    • getTextBytes

      public com.google.protobuf.ByteString getTextBytes()
       The raw text to be synthesized.
      string text = 1;
      Specified by:
      getTextBytes in interface SynthesisInputOrBuilder
      Returns:
      The bytes for text.

    • hasMarkup

      public boolean hasMarkup()
       Markup for Chirp 3: HD voices specifically. This field may not be used
 with any other voices.
      string markup = 5;
      Specified by:
      hasMarkup in interface SynthesisInputOrBuilder
      Returns:
      Whether the markup field is set.

    • getMarkup

      public String getMarkup()
       Markup for Chirp 3: HD voices specifically. This field may not be used
 with any other voices.
      string markup = 5;
      Specified by:
      getMarkup in interface SynthesisInputOrBuilder
      Returns:
      The markup.

    • getMarkupBytes

      public com.google.protobuf.ByteString getMarkupBytes()
       Markup for Chirp 3: HD voices specifically. This field may not be used
 with any other voices.
      string markup = 5;
      Specified by:
      getMarkupBytes in interface SynthesisInputOrBuilder
      Returns:
      The bytes for markup.

    • hasSsml

      public boolean hasSsml()
       The SSML document to be synthesized. The SSML document must be valid
 and well-formed. Otherwise the RPC will fail and return
 [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. For
 more information, see
 [SSML](https://cloud.google.com/text-to-speech/docs/ssml).
      string ssml = 2;
      Specified by:
      hasSsml in interface SynthesisInputOrBuilder
      Returns:
      Whether the ssml field is set.

    • getSsml

      public String getSsml()
       The SSML document to be synthesized. The SSML document must be valid
 and well-formed. Otherwise the RPC will fail and return
 [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. For
 more information, see
 [SSML](https://cloud.google.com/text-to-speech/docs/ssml).
      string ssml = 2;
      Specified by:
      getSsml in interface SynthesisInputOrBuilder
      Returns:
      The ssml.

    • getSsmlBytes

      public com.google.protobuf.ByteString getSsmlBytes()
       The SSML document to be synthesized. The SSML document must be valid
 and well-formed. Otherwise the RPC will fail and return
 [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. For
 more information, see
 [SSML](https://cloud.google.com/text-to-speech/docs/ssml).
      string ssml = 2;
      Specified by:
      getSsmlBytes in interface SynthesisInputOrBuilder
      Returns:
      The bytes for ssml.

    • hasMultiSpeakerMarkup

      public boolean hasMultiSpeakerMarkup()
       The multi-speaker input to be synthesized. Only applicable for
 multi-speaker synthesis.
      .google.cloud.texttospeech.v1.MultiSpeakerMarkup multi_speaker_markup = 4;
      Specified by:
      hasMultiSpeakerMarkup in interface SynthesisInputOrBuilder
      Returns:
      Whether the multiSpeakerMarkup field is set.

    • getMultiSpeakerMarkup

      public MultiSpeakerMarkup getMultiSpeakerMarkup()
       The multi-speaker input to be synthesized. Only applicable for
 multi-speaker synthesis.
      .google.cloud.texttospeech.v1.MultiSpeakerMarkup multi_speaker_markup = 4;
      Specified by:
      getMultiSpeakerMarkup in interface SynthesisInputOrBuilder
      Returns:
      The multiSpeakerMarkup.

    • getMultiSpeakerMarkupOrBuilder

      public MultiSpeakerMarkupOrBuilder getMultiSpeakerMarkupOrBuilder()
       The multi-speaker input to be synthesized. Only applicable for
 multi-speaker synthesis.
      .google.cloud.texttospeech.v1.MultiSpeakerMarkup multi_speaker_markup = 4;
      Specified by:
      getMultiSpeakerMarkupOrBuilder in interface SynthesisInputOrBuilder

    • hasPrompt

      public boolean hasPrompt()
       This system instruction is supported only for controllable/promptable voice
 models. If this system instruction is used, we pass the unedited text to
 Gemini-TTS. Otherwise, a default system instruction is used. AI Studio
 calls this system instruction, Style Instructions.
      optional string prompt = 6;
      Specified by:
      hasPrompt in interface SynthesisInputOrBuilder
      Returns:
      Whether the prompt field is set.

    • getPrompt

      public String getPrompt()
       This system instruction is supported only for controllable/promptable voice
 models. If this system instruction is used, we pass the unedited text to
 Gemini-TTS. Otherwise, a default system instruction is used. AI Studio
 calls this system instruction, Style Instructions.
      optional string prompt = 6;
      Specified by:
      getPrompt in interface SynthesisInputOrBuilder
      Returns:
      The prompt.

    • getPromptBytes

      public com.google.protobuf.ByteString getPromptBytes()
       This system instruction is supported only for controllable/promptable voice
 models. If this system instruction is used, we pass the unedited text to
 Gemini-TTS. Otherwise, a default system instruction is used. AI Studio
 calls this system instruction, Style Instructions.
      optional string prompt = 6;
      Specified by:
      getPromptBytes in interface SynthesisInputOrBuilder
      Returns:
      The bytes for prompt.

    • hasCustomPronunciations

      public boolean hasCustomPronunciations()
       Optional. The pronunciation customizations are applied to the input. If
 this is set, the input is synthesized using the given pronunciation
 customizations.

 The initial support is for en-us, with plans to expand to other locales in
 the future. Instant Clone voices aren't supported.

 In order to customize the pronunciation of a phrase, there must be an exact
 match of the phrase in the input types. If using SSML, the phrase must not
 be inside a phoneme tag.
      .google.cloud.texttospeech.v1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasCustomPronunciations in interface SynthesisInputOrBuilder
      Returns:
      Whether the customPronunciations field is set.

    • getCustomPronunciations

      public CustomPronunciations getCustomPronunciations()
       Optional. The pronunciation customizations are applied to the input. If
 this is set, the input is synthesized using the given pronunciation
 customizations.

 The initial support is for en-us, with plans to expand to other locales in
 the future. Instant Clone voices aren't supported.

 In order to customize the pronunciation of a phrase, there must be an exact
 match of the phrase in the input types. If using SSML, the phrase must not
 be inside a phoneme tag.
      .google.cloud.texttospeech.v1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomPronunciations in interface SynthesisInputOrBuilder
      Returns:
      The customPronunciations.

    • getCustomPronunciationsOrBuilder

      public CustomPronunciationsOrBuilder getCustomPronunciationsOrBuilder()
       Optional. The pronunciation customizations are applied to the input. If
 this is set, the input is synthesized using the given pronunciation
 customizations.

 The initial support is for en-us, with plans to expand to other locales in
 the future. Instant Clone voices aren't supported.

 In order to customize the pronunciation of a phrase, there must be an exact
 match of the phrase in the input types. If using SSML, the phrase must not
 be inside a phoneme tag.
      .google.cloud.texttospeech.v1.CustomPronunciations custom_pronunciations = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomPronunciationsOrBuilder in interface SynthesisInputOrBuilder

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 SynthesisInput parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static SynthesisInput parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static SynthesisInput parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SynthesisInput parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SynthesisInput parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SynthesisInput parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SynthesisInput parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SynthesisInput parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static SynthesisInput.Builder newBuilder()

    • newBuilder

      public static SynthesisInput.Builder newBuilder(SynthesisInput prototype)

    • toBuilder

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

    • newBuilderForType

      protected SynthesisInput.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SynthesisInput getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SynthesisInput> parser()

    • getParserForType

      public com.google.protobuf.Parser<SynthesisInput> 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.GeneratedMessage

    • getDefaultInstanceForType

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