Back to godoc.org

Package texttospeech

v0.0.0-...-c2d885f
Latest Go to latest

The latest major version is .

Published: 1 hour ago | License: Apache-2.0 | Module: google.golang.org/genproto

Index

Variables

var (
	SsmlVoiceGender_name = map[int32]string{
		0: "SSML_VOICE_GENDER_UNSPECIFIED",
		1: "MALE",
		2: "FEMALE",
		3: "NEUTRAL",
	}
	SsmlVoiceGender_value = map[string]int32{
		"SSML_VOICE_GENDER_UNSPECIFIED": 0,
		"MALE":                          1,
		"FEMALE":                        2,
		"NEUTRAL":                       3,
	}
)

Enum value maps for SsmlVoiceGender.

var (
	AudioEncoding_name = map[int32]string{
		0: "AUDIO_ENCODING_UNSPECIFIED",
		1: "LINEAR16",
		2: "MP3",
		3: "OGG_OPUS",
	}
	AudioEncoding_value = map[string]int32{
		"AUDIO_ENCODING_UNSPECIFIED": 0,
		"LINEAR16":                   1,
		"MP3":                        2,
		"OGG_OPUS":                   3,
	}
)

Enum value maps for AudioEncoding.

var File_google_cloud_texttospeech_v1_cloud_tts_proto protoreflect.FileDescriptor

func RegisterTextToSpeechServer

func RegisterTextToSpeechServer(s *grpc.Server, srv TextToSpeechServer)

type AudioConfig

type AudioConfig struct {
	AudioEncoding AudioEncoding "" /* 149 byte string literal not displayed */

	SpeakingRate float64 `protobuf:"fixed64,2,opt,name=speaking_rate,json=speakingRate,proto3" json:"speaking_rate,omitempty"`

	Pitch float64 `protobuf:"fixed64,3,opt,name=pitch,proto3" json:"pitch,omitempty"`

	VolumeGainDb float64 `protobuf:"fixed64,4,opt,name=volume_gain_db,json=volumeGainDb,proto3" json:"volume_gain_db,omitempty"`

	SampleRateHertz int32 `protobuf:"varint,5,opt,name=sample_rate_hertz,json=sampleRateHertz,proto3" json:"sample_rate_hertz,omitempty"`

	EffectsProfileId []string `protobuf:"bytes,6,rep,name=effects_profile_id,json=effectsProfileId,proto3" json:"effects_profile_id,omitempty"`

}

Description of audio data to be synthesized.

func (*AudioConfig) Descriptor

func (*AudioConfig) Descriptor() ([]byte, []int)

Deprecated: Use AudioConfig.ProtoReflect.Descriptor instead.

func (*AudioConfig) GetAudioEncoding

func (x *AudioConfig) GetAudioEncoding() AudioEncoding

func (*AudioConfig) GetEffectsProfileId

func (x *AudioConfig) GetEffectsProfileId() []string

func (*AudioConfig) GetPitch

func (x *AudioConfig) GetPitch() float64

func (*AudioConfig) GetSampleRateHertz

func (x *AudioConfig) GetSampleRateHertz() int32

func (*AudioConfig) GetSpeakingRate

func (x *AudioConfig) GetSpeakingRate() float64

func (*AudioConfig) GetVolumeGainDb

func (x *AudioConfig) GetVolumeGainDb() float64

func (*AudioConfig) ProtoMessage

func (*AudioConfig) ProtoMessage()

func (*AudioConfig) ProtoReflect

func (x *AudioConfig) ProtoReflect() protoreflect.Message

func (*AudioConfig) Reset

func (x *AudioConfig) Reset()

func (*AudioConfig) String

func (x *AudioConfig) String() string

type AudioEncoding

type AudioEncoding int32

Configuration to set up audio encoder. The encoding determines the output audio format that we'd like.

const (
	// Not specified. Will return result [google.rpc.Code.INVALID_ARGUMENT][].
	AudioEncoding_AUDIO_ENCODING_UNSPECIFIED AudioEncoding = 0
	// Uncompressed 16-bit signed little-endian samples (Linear PCM).
	// Audio content returned as LINEAR16 also contains a WAV header.
	AudioEncoding_LINEAR16 AudioEncoding = 1
	// MP3 audio at 32kbps.
	AudioEncoding_MP3 AudioEncoding = 2
	// Opus encoded audio wrapped in an ogg container. The result will be a
	// file which can be played natively on Android, and in browsers (at least
	// Chrome and Firefox). The quality of the encoding is considerably higher
	// than MP3 while using approximately the same bitrate.
	AudioEncoding_OGG_OPUS AudioEncoding = 3
)

func (AudioEncoding) Descriptor

func (AudioEncoding) Descriptor() protoreflect.EnumDescriptor

func (AudioEncoding) Enum

func (x AudioEncoding) Enum() *AudioEncoding

func (AudioEncoding) EnumDescriptor

func (AudioEncoding) EnumDescriptor() ([]byte, []int)

Deprecated: Use AudioEncoding.Descriptor instead.

func (AudioEncoding) Number

func (x AudioEncoding) Number() protoreflect.EnumNumber

func (AudioEncoding) String

func (x AudioEncoding) String() string

func (AudioEncoding) Type

func (AudioEncoding) Type() protoreflect.EnumType

type ListVoicesRequest

type ListVoicesRequest struct {

	// Optional. Recommended.
	// [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
	// specified, the ListVoices call will only return voices that can be used to
	// synthesize this language_code. E.g. when specifying "en-NZ", you will get
	// supported "en-\*" voices; when specifying "no", you will get supported
	// "no-\*" (Norwegian) and "nb-\*" (Norwegian Bokmal) voices; specifying "zh"
	// will also get supported "cmn-\*" voices; specifying "zh-hk" will also get
	// supported "yue-\*" voices.
	LanguageCode string `protobuf:"bytes,1,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
	// contains filtered or unexported fields
}

The top-level message sent by the client for the `ListVoices` method.

func (*ListVoicesRequest) Descriptor

func (*ListVoicesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListVoicesRequest.ProtoReflect.Descriptor instead.

func (*ListVoicesRequest) GetLanguageCode

func (x *ListVoicesRequest) GetLanguageCode() string

func (*ListVoicesRequest) ProtoMessage

func (*ListVoicesRequest) ProtoMessage()

func (*ListVoicesRequest) ProtoReflect

func (x *ListVoicesRequest) ProtoReflect() protoreflect.Message

func (*ListVoicesRequest) Reset

func (x *ListVoicesRequest) Reset()

func (*ListVoicesRequest) String

func (x *ListVoicesRequest) String() string

type ListVoicesResponse

type ListVoicesResponse struct {

	// The list of voices.
	Voices []*Voice `protobuf:"bytes,1,rep,name=voices,proto3" json:"voices,omitempty"`
	// contains filtered or unexported fields
}

The message returned to the client by the `ListVoices` method.

func (*ListVoicesResponse) Descriptor

func (*ListVoicesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListVoicesResponse.ProtoReflect.Descriptor instead.

func (*ListVoicesResponse) GetVoices

func (x *ListVoicesResponse) GetVoices() []*Voice

func (*ListVoicesResponse) ProtoMessage

func (*ListVoicesResponse) ProtoMessage()

func (*ListVoicesResponse) ProtoReflect

func (x *ListVoicesResponse) ProtoReflect() protoreflect.Message

func (*ListVoicesResponse) Reset

func (x *ListVoicesResponse) Reset()

func (*ListVoicesResponse) String

func (x *ListVoicesResponse) String() string

type SsmlVoiceGender

type SsmlVoiceGender int32

Gender of the voice as described in [SSML voice element](https://www.w3.org/TR/speech-synthesis11/#edef_voice).

const (
	// An unspecified gender.
	// In VoiceSelectionParams, this means that the client doesn't care which
	// gender the selected voice will have. In the Voice field of
	// ListVoicesResponse, this may mean that the voice doesn't fit any of the
	// other categories in this enum, or that the gender of the voice isn't known.
	SsmlVoiceGender_SSML_VOICE_GENDER_UNSPECIFIED SsmlVoiceGender = 0
	// A male voice.
	SsmlVoiceGender_MALE SsmlVoiceGender = 1
	// A female voice.
	SsmlVoiceGender_FEMALE SsmlVoiceGender = 2
	// A gender-neutral voice.
	SsmlVoiceGender_NEUTRAL SsmlVoiceGender = 3
)

func (SsmlVoiceGender) Descriptor

func (SsmlVoiceGender) Descriptor() protoreflect.EnumDescriptor

func (SsmlVoiceGender) Enum

func (x SsmlVoiceGender) Enum() *SsmlVoiceGender

func (SsmlVoiceGender) EnumDescriptor

func (SsmlVoiceGender) EnumDescriptor() ([]byte, []int)

Deprecated: Use SsmlVoiceGender.Descriptor instead.

func (SsmlVoiceGender) Number

func (x SsmlVoiceGender) Number() protoreflect.EnumNumber

func (SsmlVoiceGender) String

func (x SsmlVoiceGender) String() string

func (SsmlVoiceGender) Type

func (SsmlVoiceGender) Type() protoreflect.EnumType

type SynthesisInput

type SynthesisInput struct {

	// The input source, which is either plain text or SSML.
	//
	// Types that are assignable to InputSource:
	//	*SynthesisInput_Text
	//	*SynthesisInput_Ssml
	InputSource isSynthesisInput_InputSource `protobuf_oneof:"input_source"`
	// contains filtered or unexported fields
}

Contains text input to be synthesized. Either `text` or `ssml` must be supplied. Supplying both or neither returns [google.rpc.Code.INVALID_ARGUMENT][]. The input size is limited to 5000 characters.

func (*SynthesisInput) Descriptor

func (*SynthesisInput) Descriptor() ([]byte, []int)

Deprecated: Use SynthesisInput.ProtoReflect.Descriptor instead.

func (*SynthesisInput) GetInputSource

func (m *SynthesisInput) GetInputSource() isSynthesisInput_InputSource

func (*SynthesisInput) GetSsml

func (x *SynthesisInput) GetSsml() string

func (*SynthesisInput) GetText

func (x *SynthesisInput) GetText() string

func (*SynthesisInput) ProtoMessage

func (*SynthesisInput) ProtoMessage()

func (*SynthesisInput) ProtoReflect

func (x *SynthesisInput) ProtoReflect() protoreflect.Message

func (*SynthesisInput) Reset

func (x *SynthesisInput) Reset()

func (*SynthesisInput) String

func (x *SynthesisInput) String() string

type SynthesisInput_Ssml

type SynthesisInput_Ssml struct {
	// 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][]. For more information, see
	// [SSML](https://cloud.google.com/text-to-speech/docs/ssml).
	Ssml string `protobuf:"bytes,2,opt,name=ssml,proto3,oneof"`
}

type SynthesisInput_Text

type SynthesisInput_Text struct {
	// The raw text to be synthesized.
	Text string `protobuf:"bytes,1,opt,name=text,proto3,oneof"`
}

type SynthesizeSpeechRequest

type SynthesizeSpeechRequest struct {

	// Required. The Synthesizer requires either plain text or SSML as input.
	Input *SynthesisInput `protobuf:"bytes,1,opt,name=input,proto3" json:"input,omitempty"`
	// Required. The desired voice of the synthesized audio.
	Voice *VoiceSelectionParams `protobuf:"bytes,2,opt,name=voice,proto3" json:"voice,omitempty"`
	// Required. The configuration of the synthesized audio.
	AudioConfig *AudioConfig `protobuf:"bytes,3,opt,name=audio_config,json=audioConfig,proto3" json:"audio_config,omitempty"`
	// contains filtered or unexported fields
}

The top-level message sent by the client for the `SynthesizeSpeech` method.

func (*SynthesizeSpeechRequest) Descriptor

func (*SynthesizeSpeechRequest) Descriptor() ([]byte, []int)

Deprecated: Use SynthesizeSpeechRequest.ProtoReflect.Descriptor instead.

func (*SynthesizeSpeechRequest) GetAudioConfig

func (x *SynthesizeSpeechRequest) GetAudioConfig() *AudioConfig

func (*SynthesizeSpeechRequest) GetInput

func (x *SynthesizeSpeechRequest) GetInput() *SynthesisInput

func (*SynthesizeSpeechRequest) GetVoice

func (x *SynthesizeSpeechRequest) GetVoice() *VoiceSelectionParams

func (*SynthesizeSpeechRequest) ProtoMessage

func (*SynthesizeSpeechRequest) ProtoMessage()

func (*SynthesizeSpeechRequest) ProtoReflect

func (x *SynthesizeSpeechRequest) ProtoReflect() protoreflect.Message

func (*SynthesizeSpeechRequest) Reset

func (x *SynthesizeSpeechRequest) Reset()

func (*SynthesizeSpeechRequest) String

func (x *SynthesizeSpeechRequest) String() string

type SynthesizeSpeechResponse

type SynthesizeSpeechResponse struct {

	// The audio data bytes encoded as specified in the request, including the
	// header for encodings that are wrapped in containers (e.g. MP3, OGG_OPUS).
	// For LINEAR16 audio, we include the WAV header. Note: as
	// with all bytes fields, protobuffers use a pure binary representation,
	// whereas JSON representations use base64.
	AudioContent []byte `protobuf:"bytes,1,opt,name=audio_content,json=audioContent,proto3" json:"audio_content,omitempty"`
	// contains filtered or unexported fields
}

The message returned to the client by the `SynthesizeSpeech` method.

func (*SynthesizeSpeechResponse) Descriptor

func (*SynthesizeSpeechResponse) Descriptor() ([]byte, []int)

Deprecated: Use SynthesizeSpeechResponse.ProtoReflect.Descriptor instead.

func (*SynthesizeSpeechResponse) GetAudioContent

func (x *SynthesizeSpeechResponse) GetAudioContent() []byte

func (*SynthesizeSpeechResponse) ProtoMessage

func (*SynthesizeSpeechResponse) ProtoMessage()

func (*SynthesizeSpeechResponse) ProtoReflect

func (x *SynthesizeSpeechResponse) ProtoReflect() protoreflect.Message

func (*SynthesizeSpeechResponse) Reset

func (x *SynthesizeSpeechResponse) Reset()

func (*SynthesizeSpeechResponse) String

func (x *SynthesizeSpeechResponse) String() string

type TextToSpeechClient

type TextToSpeechClient interface {
	// Returns a list of Voice supported for synthesis.
	ListVoices(ctx context.Context, in *ListVoicesRequest, opts ...grpc.CallOption) (*ListVoicesResponse, error)
	// Synthesizes speech synchronously: receive results after all text input
	// has been processed.
	SynthesizeSpeech(ctx context.Context, in *SynthesizeSpeechRequest, opts ...grpc.CallOption) (*SynthesizeSpeechResponse, error)
}

TextToSpeechClient is the client API for TextToSpeech service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type TextToSpeechServer

type TextToSpeechServer interface {
	// Returns a list of Voice supported for synthesis.
	ListVoices(context.Context, *ListVoicesRequest) (*ListVoicesResponse, error)
	// Synthesizes speech synchronously: receive results after all text input
	// has been processed.
	SynthesizeSpeech(context.Context, *SynthesizeSpeechRequest) (*SynthesizeSpeechResponse, error)
}

TextToSpeechServer is the server API for TextToSpeech service.

type UnimplementedTextToSpeechServer

type UnimplementedTextToSpeechServer struct {
}

UnimplementedTextToSpeechServer can be embedded to have forward compatible implementations.

func (*UnimplementedTextToSpeechServer) ListVoices

func (*UnimplementedTextToSpeechServer) ListVoices(context.Context, *ListVoicesRequest) (*ListVoicesResponse, error)

func (*UnimplementedTextToSpeechServer) SynthesizeSpeech

func (*UnimplementedTextToSpeechServer) SynthesizeSpeech(context.Context, *SynthesizeSpeechRequest) (*SynthesizeSpeechResponse, error)

type Voice

type Voice struct {
	LanguageCodes []string `protobuf:"bytes,1,rep,name=language_codes,json=languageCodes,proto3" json:"language_codes,omitempty"`

	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`

	SsmlGender SsmlVoiceGender "" /* 142 byte string literal not displayed */

	NaturalSampleRateHertz int32 "" /* 132 byte string literal not displayed */

}

Description of a voice supported by the TTS service.

func (*Voice) Descriptor

func (*Voice) Descriptor() ([]byte, []int)

Deprecated: Use Voice.ProtoReflect.Descriptor instead.

func (*Voice) GetLanguageCodes

func (x *Voice) GetLanguageCodes() []string

func (*Voice) GetName

func (x *Voice) GetName() string

func (*Voice) GetNaturalSampleRateHertz

func (x *Voice) GetNaturalSampleRateHertz() int32

func (*Voice) GetSsmlGender

func (x *Voice) GetSsmlGender() SsmlVoiceGender

func (*Voice) ProtoMessage

func (*Voice) ProtoMessage()

func (*Voice) ProtoReflect

func (x *Voice) ProtoReflect() protoreflect.Message

func (*Voice) Reset

func (x *Voice) Reset()

func (*Voice) String

func (x *Voice) String() string

type VoiceSelectionParams

type VoiceSelectionParams struct {
	LanguageCode string `protobuf:"bytes,1,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`

	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`

	SsmlGender SsmlVoiceGender "" /* 142 byte string literal not displayed */

}

Description of which voice to use for a synthesis request.

func (*VoiceSelectionParams) Descriptor

func (*VoiceSelectionParams) Descriptor() ([]byte, []int)

Deprecated: Use VoiceSelectionParams.ProtoReflect.Descriptor instead.

func (*VoiceSelectionParams) GetLanguageCode

func (x *VoiceSelectionParams) GetLanguageCode() string

func (*VoiceSelectionParams) GetName

func (x *VoiceSelectionParams) GetName() string

func (*VoiceSelectionParams) GetSsmlGender

func (x *VoiceSelectionParams) GetSsmlGender() SsmlVoiceGender

func (*VoiceSelectionParams) ProtoMessage

func (*VoiceSelectionParams) ProtoMessage()

func (*VoiceSelectionParams) ProtoReflect

func (x *VoiceSelectionParams) ProtoReflect() protoreflect.Message

func (*VoiceSelectionParams) Reset

func (x *VoiceSelectionParams) Reset()

func (*VoiceSelectionParams) String

func (x *VoiceSelectionParams) String() string

Package Files

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier