Represents a SynthesizeSpeechRequest.
Package
@google-cloud/text-to-speechConstructors
(constructor)(properties)
constructor(properties?: google.cloud.texttospeech.v1beta1.ISynthesizeSpeechRequest);Constructs a new SynthesizeSpeechRequest.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISynthesizeSpeechRequest
Properties to set |
Properties
_advancedVoiceOptions
public _advancedVoiceOptions?: "advancedVoiceOptions";SynthesizeSpeechRequest _advancedVoiceOptions.
advancedVoiceOptions
public advancedVoiceOptions?: (google.cloud.texttospeech.v1beta1.IAdvancedVoiceOptions|null);SynthesizeSpeechRequest advancedVoiceOptions.
audioConfig
public audioConfig?: (google.cloud.texttospeech.v1beta1.IAudioConfig|null);SynthesizeSpeechRequest audioConfig.
enableTimePointing
public enableTimePointing: google.cloud.texttospeech.v1beta1.SynthesizeSpeechRequest.TimepointType[];SynthesizeSpeechRequest enableTimePointing.
input
public input?: (google.cloud.texttospeech.v1beta1.ISynthesisInput|null);SynthesizeSpeechRequest input.
voice
public voice?: (google.cloud.texttospeech.v1beta1.IVoiceSelectionParams|null);SynthesizeSpeechRequest voice.
Methods
create(properties)
public static create(properties?: google.cloud.texttospeech.v1beta1.ISynthesizeSpeechRequest): google.cloud.texttospeech.v1beta1.SynthesizeSpeechRequest;Creates a new SynthesizeSpeechRequest instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISynthesizeSpeechRequest
Properties to set |
| Returns | |
|---|---|
| Type | Description |
SynthesizeSpeechRequest |
SynthesizeSpeechRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.texttospeech.v1beta1.SynthesizeSpeechRequest;Decodes a SynthesizeSpeechRequest message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
SynthesizeSpeechRequest |
SynthesizeSpeechRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.texttospeech.v1beta1.SynthesizeSpeechRequest;Decodes a SynthesizeSpeechRequest message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
SynthesizeSpeechRequest |
SynthesizeSpeechRequest |
encode(message, writer)
public static encode(message: google.cloud.texttospeech.v1beta1.ISynthesizeSpeechRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified SynthesizeSpeechRequest message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISynthesizeSpeechRequest
SynthesizeSpeechRequest message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.texttospeech.v1beta1.ISynthesizeSpeechRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified SynthesizeSpeechRequest message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISynthesizeSpeechRequest
SynthesizeSpeechRequest message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.texttospeech.v1beta1.SynthesizeSpeechRequest;Creates a SynthesizeSpeechRequest message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
SynthesizeSpeechRequest |
SynthesizeSpeechRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for SynthesizeSpeechRequest
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this SynthesizeSpeechRequest to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.texttospeech.v1beta1.SynthesizeSpeechRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a SynthesizeSpeechRequest message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
SynthesizeSpeechRequest
SynthesizeSpeechRequest |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a SynthesizeSpeechRequest message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|