Package com.google.cloud.texttospeech.v1

Interface SynthesisInputOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SynthesisInput, SynthesisInput.Builder
@Generated public interface SynthesisInputOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasText

      boolean hasText()
       The raw text to be synthesized.
      string text = 1;
      Returns:
      Whether the text field is set.

    • getText

      String getText()
       The raw text to be synthesized.
      string text = 1;
      Returns:
      The text.

    • getTextBytes

      com.google.protobuf.ByteString getTextBytes()
       The raw text to be synthesized.
      string text = 1;
      Returns:
      The bytes for text.

    • hasMarkup

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

    • getMarkup

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

    • getMarkupBytes

      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;
      Returns:
      The bytes for markup.

    • hasSsml

      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;
      Returns:
      Whether the ssml field is set.

    • getSsml

      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;
      Returns:
      The ssml.

    • getSsmlBytes

      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;
      Returns:
      The bytes for ssml.

    • hasMultiSpeakerMarkup

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

    • getMultiSpeakerMarkup

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

    • getMultiSpeakerMarkupOrBuilder

      MultiSpeakerMarkupOrBuilder getMultiSpeakerMarkupOrBuilder()
       The multi-speaker input to be synthesized. Only applicable for
 multi-speaker synthesis.
      .google.cloud.texttospeech.v1.MultiSpeakerMarkup multi_speaker_markup = 4;

    • hasPrompt

      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;
      Returns:
      Whether the prompt field is set.

    • getPrompt

      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;
      Returns:
      The prompt.

    • getPromptBytes

      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;
      Returns:
      The bytes for prompt.

    • hasCustomPronunciations

      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];
      Returns:
      Whether the customPronunciations field is set.

    • getCustomPronunciations

      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];
      Returns:
      The customPronunciations.

    • getCustomPronunciationsOrBuilder

      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];

    • getInputSourceCase

      SynthesisInput.InputSourceCase getInputSourceCase()