Class protos.google.cloud.texttospeech.v1beta1.SynthesisInput (3.3.1)

Version 3.3.1

• 5.5.0 (latest)
• 5.4.0
• 5.0.2
• 4.2.2
• 4.0.4
• 3.4.0
• 3.3.1
• 3.2.7

Represents a SynthesisInput.

Package

@google-cloud/text-to-speech

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.texttospeech.v1beta1.ISynthesisInput);

Constructs a new SynthesisInput.

Parameter

Name	Description
properties	ISynthesisInput Properties to set

Properties

inputSource

public inputSource?: ("text"|"ssml");

SynthesisInput inputSource.

ssml

public ssml?: (string|null);

SynthesisInput ssml.

text

public text?: (string|null);

SynthesisInput text.

Methods

create(properties)

public static create(properties?: google.cloud.texttospeech.v1beta1.ISynthesisInput): google.cloud.texttospeech.v1beta1.SynthesisInput;

Creates a new SynthesisInput instance using the specified properties.

Parameter

Name	Description
properties	ISynthesisInput Properties to set

Returns

Type	Description
google.cloud.texttospeech.v1beta1.SynthesisInput	SynthesisInput instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.texttospeech.v1beta1.SynthesisInput;

Decodes a SynthesisInput message from the specified reader or buffer.

Parameters

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from
length	number Message length if known beforehand

Returns

Type	Description
google.cloud.texttospeech.v1beta1.SynthesisInput	SynthesisInput

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.texttospeech.v1beta1.SynthesisInput;

Decodes a SynthesisInput message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from

Returns

Type	Description
google.cloud.texttospeech.v1beta1.SynthesisInput	SynthesisInput

encode(message, writer)

public static encode(message: google.cloud.texttospeech.v1beta1.ISynthesisInput, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SynthesisInput message. Does not implicitly messages.

Parameters

Name	Description
message	ISynthesisInput SynthesisInput 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.ISynthesisInput, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SynthesisInput message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	ISynthesisInput SynthesisInput 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.SynthesisInput;

Creates a SynthesisInput 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
google.cloud.texttospeech.v1beta1.SynthesisInput	SynthesisInput

toJSON()

public toJSON(): { [k: string]: any };

Converts this SynthesisInput to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.texttospeech.v1beta1.SynthesisInput, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a SynthesisInput message. Also converts values to other types if specified.

Parameters

Name	Description
message	google.cloud.texttospeech.v1beta1.SynthesisInput SynthesisInput
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 SynthesisInput message.

Parameter

Name	Description
message	{ [k: string]: any } Plain object to verify

Returns

Type	Description
(string|null)	null if valid, otherwise the reason why it is not