Class Voice (2.77.0) 
  
  
  
   
  
    
  
  
    
    
    
    
  Version 2.77.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  Voice   extends   GeneratedMessageV3   implements   VoiceOrBuilder  
   Description of a voice supported by the TTS service.
 Protobuf type google.cloud.texttospeech.v1.Voice
    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
   
  LANGUAGE_CODES_FIELD_NUMBER 
  
    
public   static   final   int   LANGUAGE_CODES_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  NAME_FIELD_NUMBER 
  
    
public   static   final   int   NAME_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  NATURAL_SAMPLE_RATE_HERTZ_FIELD_NUMBER 
  
    
public   static   final   int   NATURAL_SAMPLE_RATE_HERTZ_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  SSML_GENDER_FIELD_NUMBER 
  
    
public   static   final   int   SSML_GENDER_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  Static Methods
   
  getDefaultInstance() 
  
    
public   static   Voice   getDefaultInstance ()  
  
    
      
        Returns  
      
        Type Description  
      
        Voice  
     
  
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
  
  newBuilder() 
  
    
public   static   Voice . Builder   newBuilder ()  
  
  newBuilder(Voice prototype) 
  
    
public   static   Voice . Builder   newBuilder ( Voice   prototype )  
  
    
      
        Parameter  
      
        Name Description  
      
        prototypeVoice  
     
  
  
  parseDelimitedFrom(InputStream input) 
  
    
public   static   Voice   parseDelimitedFrom ( InputStream   input )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Voice  
     
  
  
  parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   Voice   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Voice  
     
  
  
  parseFrom(byte[] data) 
  
    
public   static   Voice   parseFrom ( byte []   data )  
  
    
      
        Parameter  
      
        Name Description  
      
        databyte [] 
     
  
  
    
      
        Returns  
      
        Type Description  
      
        Voice  
     
  
  
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   Voice   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Voice  
     
  
  
  parseFrom(ByteString data) 
  
    
public   static   Voice   parseFrom ( ByteString   data )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Voice  
     
  
  
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   Voice   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Voice  
     
  
  
  parseFrom(CodedInputStream input) 
  
    
public   static   Voice   parseFrom ( CodedInputStream   input )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Voice  
     
  
  
  parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   Voice   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Voice  
     
  
  
  parseFrom(InputStream input) 
  
    
public   static   Voice   parseFrom ( InputStream   input )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Voice  
     
  
  
  parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   Voice   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Voice  
     
  
  
  parseFrom(ByteBuffer data) 
  
    
public   static   Voice   parseFrom ( ByteBuffer   data )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Voice  
     
  
  
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   Voice   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Voice  
     
  
  
  parser() 
  
    
public   static   Parser<Voice>   parser ()  
  
  Methods
   
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
  
    
      
        Parameter  
      
        Name Description  
      
        objObject  
     
  
  
  Overrides 
  
  getDefaultInstanceForType() 
  
    
public   Voice   getDefaultInstanceForType ()  
  
    
      
        Returns  
      
        Type Description  
      
        Voice  
     
  
  getLanguageCodes(int index) 
  
    
public   String   getLanguageCodes ( int   index )  
   The languages that this voice supports, expressed as
 BCP-47  language tags (e.g.
 "en-US", "es-419", "cmn-tw").
 repeated string language_codes = 1;
    
      
        Parameter  
      
        Name Description  
      
        indexint The index of the element to return.
 
     
  
  
    
      
        Returns  
      
        Type Description  
      
        String The languageCodes at the given index.
 
     
  
  getLanguageCodesBytes(int index) 
  
    
public   ByteString   getLanguageCodesBytes ( int   index )  
   The languages that this voice supports, expressed as
 BCP-47  language tags (e.g.
 "en-US", "es-419", "cmn-tw").
 repeated string language_codes = 1;
    
      
        Parameter  
      
        Name Description  
      
        indexint The index of the value to return.
 
     
  
  
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes of the languageCodes at the given index.
 
     
  
  getLanguageCodesCount() 
  
    
public   int   getLanguageCodesCount ()  
   The languages that this voice supports, expressed as
 BCP-47  language tags (e.g.
 "en-US", "es-419", "cmn-tw").
 repeated string language_codes = 1;
    
      
        Returns  
      
        Type Description  
      
        int The count of languageCodes.
 
     
  
  getLanguageCodesList() 
  
    
public   ProtocolStringList   getLanguageCodesList ()  
   The languages that this voice supports, expressed as
 BCP-47  language tags (e.g.
 "en-US", "es-419", "cmn-tw").
 repeated string language_codes = 1;
getName() 
  
   The name of this voice.  Each distinct voice has a unique name.
 string name = 2;
    
      
        Returns  
      
        Type Description  
      
        String The name.
 
     
  
  getNameBytes() 
  
    
public   ByteString   getNameBytes ()  
   The name of this voice.  Each distinct voice has a unique name.
 string name = 2;
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes for name.
 
     
  
  getNaturalSampleRateHertz() 
  
    
public   int   getNaturalSampleRateHertz ()  
   The natural sample rate (in hertz) for this voice.
 int32 natural_sample_rate_hertz = 4;
    
      
        Returns  
      
        Type Description  
      
        int The naturalSampleRateHertz.
 
     
  
  getParserForType() 
  
    
public   Parser<Voice>   getParserForType ()  
  
  Overrides 
  
  getSerializedSize() 
  
    
public   int   getSerializedSize ()  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  getSsmlGender() 
  
    
public   SsmlVoiceGender   getSsmlGender ()  
   The gender of this voice.
 .google.cloud.texttospeech.v1.SsmlVoiceGender ssml_gender = 3;
getSsmlGenderValue() 
  
    
public   int   getSsmlGenderValue ()  
   The gender of this voice.
 .google.cloud.texttospeech.v1.SsmlVoiceGender ssml_gender = 3;
    
      
        Returns  
      
        Type Description  
      
        int The enum numeric value on the wire for ssmlGender.
 
     
  
  hashCode() 
  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
  
  Overrides 
  
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
  
  Overrides 
  
  newBuilderForType() 
  
    
public   Voice . Builder   newBuilderForType ()  
  
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   Voice . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
  
  
  Overrides 
  
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Object  
     
  
  Overrides 
  
  toBuilder() 
  
    
public   Voice . Builder   toBuilder ()  
  
  writeTo(CodedOutputStream output) 
  
    
public   void   writeTo ( CodedOutputStream   output )  
  
  Overrides 
  
  
 
     
    
  
  
  
     
  
    
    
      
       
    
    
  
  
 
  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-29 UTC.
 
 
  
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]