Class google.cloud.speech.v1.RecognizeRequest (4.1.3)

Represents a RecognizeRequest.

Package

@google-cloud/speech!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.speech.v1.IRecognizeRequest);

Constructs a new RecognizeRequest.

Parameter
NameDescription
properties IRecognizeRequest

Properties to set

Properties

audio

public audio?: (google.cloud.speech.v1.IRecognitionAudio|null);

RecognizeRequest audio.

Property Value
TypeDescription
(google.cloud.speech.v1.IRecognitionAudio|null)

config

public config?: (google.cloud.speech.v1.IRecognitionConfig|null);

RecognizeRequest config.

Property Value
TypeDescription
(google.cloud.speech.v1.IRecognitionConfig|null)

Methods

create(properties)

public static create(properties?: google.cloud.speech.v1.IRecognizeRequest): google.cloud.speech.v1.RecognizeRequest;

Creates a new RecognizeRequest instance using the specified properties.

Parameter
NameDescription
properties IRecognizeRequest

Properties to set

Returns
TypeDescription
RecognizeRequest

RecognizeRequest instance

decode(reader, length)

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

Decodes a RecognizeRequest 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
RecognizeRequest

RecognizeRequest

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
RecognizeRequest

RecognizeRequest

encode(message, writer)

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

Encodes the specified RecognizeRequest message. Does not implicitly verify messages.

Parameters
NameDescription
message IRecognizeRequest

RecognizeRequest 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.speech.v1.IRecognizeRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IRecognizeRequest

RecognizeRequest 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.speech.v1.RecognizeRequest;

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

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

Plain object

Returns
TypeDescription
RecognizeRequest

RecognizeRequest

toJSON()

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

Converts this RecognizeRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message RecognizeRequest

RecognizeRequest

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 RecognizeRequest 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