Class protos.google.cloud.dialogflow.cx.v3beta1.SynthesizeSpeechConfig

Represents a SynthesizeSpeechConfig.

Package

@google-cloud/dialogflow-cx

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dialogflow.cx.v3beta1.ISynthesizeSpeechConfig);

Constructs a new SynthesizeSpeechConfig.

Parameter
NameDescription
properties ISynthesizeSpeechConfig

Properties to set

Properties

effectsProfileId

public effectsProfileId: string[];

SynthesizeSpeechConfig effectsProfileId.

pitch

public pitch: number;

SynthesizeSpeechConfig pitch.

speakingRate

public speakingRate: number;

SynthesizeSpeechConfig speakingRate.

voice

public voice?: (google.cloud.dialogflow.cx.v3beta1.IVoiceSelectionParams|null);

SynthesizeSpeechConfig voice.

volumeGainDb

public volumeGainDb: number;

SynthesizeSpeechConfig volumeGainDb.

Methods

create(properties)

public static create(properties?: google.cloud.dialogflow.cx.v3beta1.ISynthesizeSpeechConfig): google.cloud.dialogflow.cx.v3beta1.SynthesizeSpeechConfig;

Creates a new SynthesizeSpeechConfig instance using the specified properties.

Parameter
NameDescription
properties ISynthesizeSpeechConfig

Properties to set

Returns
TypeDescription
google.cloud.dialogflow.cx.v3beta1.SynthesizeSpeechConfig

SynthesizeSpeechConfig instance

decode(reader, length)

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

Decodes a SynthesizeSpeechConfig message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.dialogflow.cx.v3beta1.SynthesizeSpeechConfig

SynthesizeSpeechConfig

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dialogflow.cx.v3beta1.SynthesizeSpeechConfig;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.dialogflow.cx.v3beta1.SynthesizeSpeechConfig

SynthesizeSpeechConfig

encode(message, writer)

public static encode(message: google.cloud.dialogflow.cx.v3beta1.ISynthesizeSpeechConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SynthesizeSpeechConfig message. Does not implicitly messages.

Parameters
NameDescription
message ISynthesizeSpeechConfig

SynthesizeSpeechConfig message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.dialogflow.cx.v3beta1.ISynthesizeSpeechConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ISynthesizeSpeechConfig

SynthesizeSpeechConfig message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.dialogflow.cx.v3beta1.SynthesizeSpeechConfig;

Creates a SynthesizeSpeechConfig message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.dialogflow.cx.v3beta1.SynthesizeSpeechConfig

SynthesizeSpeechConfig

toJSON()

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

Converts this SynthesizeSpeechConfig to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.dialogflow.cx.v3beta1.SynthesizeSpeechConfig

SynthesizeSpeechConfig

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a SynthesizeSpeechConfig message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not