Class protos.google.cloud.texttospeech.v1.AudioConfig (4.2.2)

Represents an AudioConfig.

Package

@google-cloud/text-to-speech

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.texttospeech.v1.IAudioConfig);

Constructs a new AudioConfig.

Parameter
NameDescription
properties IAudioConfig

Properties to set

Properties

audioEncoding

public audioEncoding: (google.cloud.texttospeech.v1.AudioEncoding|keyof typeof google.cloud.texttospeech.v1.AudioEncoding);

AudioConfig audioEncoding.

effectsProfileId

public effectsProfileId: string[];

AudioConfig effectsProfileId.

pitch

public pitch: number;

AudioConfig pitch.

sampleRateHertz

public sampleRateHertz: number;

AudioConfig sampleRateHertz.

speakingRate

public speakingRate: number;

AudioConfig speakingRate.

volumeGainDb

public volumeGainDb: number;

AudioConfig volumeGainDb.

Methods

create(properties)

public static create(properties?: google.cloud.texttospeech.v1.IAudioConfig): google.cloud.texttospeech.v1.AudioConfig;

Creates a new AudioConfig instance using the specified properties.

Parameter
NameDescription
properties IAudioConfig

Properties to set

Returns
TypeDescription
google.cloud.texttospeech.v1.AudioConfig

AudioConfig instance

decode(reader, length)

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

Decodes an AudioConfig 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.texttospeech.v1.AudioConfig

AudioConfig

decodeDelimited(reader)

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

Decodes an AudioConfig 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.texttospeech.v1.AudioConfig

AudioConfig

encode(message, writer)

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

Encodes the specified AudioConfig message. Does not implicitly messages.

Parameters
NameDescription
message IAudioConfig

AudioConfig 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.texttospeech.v1.IAudioConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IAudioConfig

AudioConfig 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.texttospeech.v1.AudioConfig;

Creates an AudioConfig 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.texttospeech.v1.AudioConfig

AudioConfig

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for AudioConfig

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this AudioConfig to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.texttospeech.v1.AudioConfig

AudioConfig

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an AudioConfig 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