Send feedback
  
   
 
  
    
      Class StreamingSynthesisInput (2.77.0) 
  
  
  
   
  
    
  
  
    
    
    
    
    
  Version latestkeyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  StreamingSynthesisInput   extends   GeneratedMessageV3   implements   StreamingSynthesisInputOrBuilder  
   Input to be synthesized.
 Protobuf type google.cloud.texttospeech.v1.StreamingSynthesisInput
    Inherited Members 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT) 
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int) 
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
   
  Static Fields
   
  MARKUP_FIELD_NUMBER 
  
    
public   static   final   int   MARKUP_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  MULTI_SPEAKER_MARKUP_FIELD_NUMBER 
  
    
public   static   final   int   MULTI_SPEAKER_MARKUP_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  PROMPT_FIELD_NUMBER 
  
    
public   static   final   int   PROMPT_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  TEXT_FIELD_NUMBER 
  
    
public   static   final   int   TEXT_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  Static Methods
   
  getDefaultInstance() 
  
    
public   static   StreamingSynthesisInput   getDefaultInstance ()  
  
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
  
  newBuilder() 
  
    
public   static   StreamingSynthesisInput . Builder   newBuilder ()  
  
  newBuilder(StreamingSynthesisInput prototype) 
  
    
public   static   StreamingSynthesisInput . Builder   newBuilder ( StreamingSynthesisInput   prototype )  
  
  
  parseDelimitedFrom(InputStream input) 
  
    
public   static   StreamingSynthesisInput   parseDelimitedFrom ( InputStream   input )  
  
  
  
  parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   StreamingSynthesisInput   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(byte[] data) 
  
    
public   static   StreamingSynthesisInput   parseFrom ( byte []   data )  
  
    
      
        Parameter  
      
        Name Description  
      
        databyte [] 
     
  
  
  
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   StreamingSynthesisInput   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(ByteString data) 
  
    
public   static   StreamingSynthesisInput   parseFrom ( ByteString   data )  
  
  
  
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   StreamingSynthesisInput   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(CodedInputStream input) 
  
    
public   static   StreamingSynthesisInput   parseFrom ( CodedInputStream   input )  
  
  
  
  parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   StreamingSynthesisInput   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(InputStream input) 
  
    
public   static   StreamingSynthesisInput   parseFrom ( InputStream   input )  
  
  
  
  parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   StreamingSynthesisInput   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(ByteBuffer data) 
  
    
public   static   StreamingSynthesisInput   parseFrom ( ByteBuffer   data )  
  
  
  
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   StreamingSynthesisInput   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parser() 
  
    
public   static   Parser<StreamingSynthesisInput>   parser ()  
  
  Methods
   
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
  
    
      
        Parameter  
      
        Name Description  
      
        objObject  
     
  
  
  Overrides 
  
  getDefaultInstanceForType() 
  
    
public   StreamingSynthesisInput   getDefaultInstanceForType ()  
  
  getInputSourceCase() 
  
    
public   StreamingSynthesisInput . InputSourceCase   getInputSourceCase ()  
  
  getMarkup() 
  
    
public   String   getMarkup ()  
   Markup for HD voices specifically. This field may not be used with any
 other voices.
 string markup = 5;
    
      
        Returns  
      
        Type Description  
      
        String The markup.
 
     
  
  getMarkupBytes() 
  
    
public   ByteString   getMarkupBytes ()  
   Markup for HD voices specifically. This field may not be used with any
 other voices.
 string markup = 5;
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes for markup.
 
     
  
  getMultiSpeakerMarkup() 
  
    
public   MultiSpeakerMarkup   getMultiSpeakerMarkup ()  
   Multi-speaker markup for Gemini TTS. This field may not
 be used with any other voices.
 .google.cloud.texttospeech.v1.MultiSpeakerMarkup multi_speaker_markup = 7;
getMultiSpeakerMarkupOrBuilder() 
  
    
public   MultiSpeakerMarkupOrBuilder   getMultiSpeakerMarkupOrBuilder ()  
   Multi-speaker markup for Gemini TTS. This field may not
 be used with any other voices.
 .google.cloud.texttospeech.v1.MultiSpeakerMarkup multi_speaker_markup = 7;
getParserForType() 
  
    
public   Parser<StreamingSynthesisInput>   getParserForType ()  
  
  Overrides 
  
  getPrompt() 
  
    
public   String   getPrompt ()  
   This is system instruction supported only for controllable voice models.
 optional string prompt = 6;
    
      
        Returns  
      
        Type Description  
      
        String The prompt.
 
     
  
  getPromptBytes() 
  
    
public   ByteString   getPromptBytes ()  
   This is system instruction supported only for controllable voice models.
 optional string prompt = 6;
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes for prompt.
 
     
  
  getSerializedSize() 
  
    
public   int   getSerializedSize ()  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  getText() 
  
   The raw text to be synthesized. It is recommended that each input
 contains complete, terminating sentences, which results in better prosody
 in the output audio.
 string text = 1;
    
      
        Returns  
      
        Type Description  
      
        String The text.
 
     
  
  getTextBytes() 
  
    
public   ByteString   getTextBytes ()  
   The raw text to be synthesized. It is recommended that each input
 contains complete, terminating sentences, which results in better prosody
 in the output audio.
 string text = 1;
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes for text.
 
     
  
  hasMarkup() 
  
    
public   boolean   hasMarkup ()  
   Markup for HD voices specifically. This field may not be used with any
 other voices.
 string markup = 5;
    
      
        Returns  
      
        Type Description  
      
        boolean Whether the markup field is set.
 
     
  
  hasMultiSpeakerMarkup() 
  
    
public   boolean   hasMultiSpeakerMarkup ()  
   Multi-speaker markup for Gemini TTS. This field may not
 be used with any other voices.
 .google.cloud.texttospeech.v1.MultiSpeakerMarkup multi_speaker_markup = 7;
    
      
        Returns  
      
        Type Description  
      
        boolean Whether the multiSpeakerMarkup field is set.
 
     
  
  hasPrompt() 
  
    
public   boolean   hasPrompt ()  
   This is system instruction supported only for controllable voice models.
 optional string prompt = 6;
    
      
        Returns  
      
        Type Description  
      
        boolean Whether the prompt field is set.
 
     
  
  hasText() 
  
   The raw text to be synthesized. It is recommended that each input
 contains complete, terminating sentences, which results in better prosody
 in the output audio.
 string text = 1;
    
      
        Returns  
      
        Type Description  
      
        boolean Whether the text field is set.
 
     
  
  hashCode() 
  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
  
  Overrides 
  
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
  
  Overrides 
  
  newBuilderForType() 
  
    
public   StreamingSynthesisInput . Builder   newBuilderForType ()  
  
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   StreamingSynthesisInput . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
  
  
  Overrides 
  
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Object  
     
  
  Overrides 
  
  toBuilder() 
  
    
public   StreamingSynthesisInput . Builder   toBuilder ()  
  
  writeTo(CodedOutputStream output) 
  
    
public   void   writeTo ( CodedOutputStream   output )  
  
  Overrides 
  
  
 
     
    
  
  
  
     
  
    
    
      
       
         
  
  
    
    Send feedback
  
   
 
       
    
    
  
  
 
  Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
  Last updated 2025-10-11 UTC.
 
 
  
  
    
    
    
      
  
  
    Need to tell us more?
  
   
 
     
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-11 UTC."],[],[]]