Class protos.google.cloud.dialogflow.v2.TextToSpeechSettings (4.1.4)

Represents a TextToSpeechSettings.

Package

@google-cloud/dialogflow!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dialogflow.v2.ITextToSpeechSettings);

Constructs a new TextToSpeechSettings.

Parameter

Name	Description
properties	`ITextToSpeechSettings` Properties to set

Properties

enableTextToSpeech

public enableTextToSpeech: boolean;

TextToSpeechSettings enableTextToSpeech.

Property Value

Type	Description
boolean

outputAudioEncoding

public outputAudioEncoding: (google.cloud.dialogflow.v2.OutputAudioEncoding|keyof typeof google.cloud.dialogflow.v2.OutputAudioEncoding);

TextToSpeechSettings outputAudioEncoding.

Property Value

Type	Description
(google.cloud.dialogflow.v2.OutputAudioEncoding\|keyof typeof google.cloud.dialogflow.v2.OutputAudioEncoding)

sampleRateHertz

public sampleRateHertz: number;

TextToSpeechSettings sampleRateHertz.

Property Value

Type	Description
number

synthesizeSpeechConfigs

public synthesizeSpeechConfigs: { [k: string]: google.cloud.dialogflow.v2.ISynthesizeSpeechConfig };

TextToSpeechSettings synthesizeSpeechConfigs.

Property Value

Type	Description
{ [k: string]: google.cloud.dialogflow.v2.ISynthesizeSpeechConfig }

Methods

create(properties)

public static create(properties?: google.cloud.dialogflow.v2.ITextToSpeechSettings): google.cloud.dialogflow.v2.TextToSpeechSettings;

Creates a new TextToSpeechSettings instance using the specified properties.

Parameter

Name	Description
properties	`ITextToSpeechSettings` Properties to set

Returns

Type	Description
google.cloud.dialogflow.v2.TextToSpeechSettings	TextToSpeechSettings instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dialogflow.v2.TextToSpeechSettings;

Decodes a TextToSpeechSettings 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.dialogflow.v2.TextToSpeechSettings	TextToSpeechSettings

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dialogflow.v2.TextToSpeechSettings;

Decodes a TextToSpeechSettings 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.dialogflow.v2.TextToSpeechSettings	TextToSpeechSettings

encode(message, writer)

public static encode(message: google.cloud.dialogflow.v2.ITextToSpeechSettings, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified TextToSpeechSettings message. Does not implicitly messages.

Parameters

Name	Description
message	`ITextToSpeechSettings` TextToSpeechSettings 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.dialogflow.v2.ITextToSpeechSettings, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`ITextToSpeechSettings` TextToSpeechSettings 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.dialogflow.v2.TextToSpeechSettings;

Creates a TextToSpeechSettings 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.dialogflow.v2.TextToSpeechSettings	TextToSpeechSettings

toJSON()

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

Converts this TextToSpeechSettings to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.dialogflow.v2.TextToSpeechSettings` TextToSpeechSettings
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 TextToSpeechSettings 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