RecognitionConfig

google.cloud.speech.v1. RecognitionConfig

Represents a RecognitionConfig.

Constructor

new RecognitionConfig(propertiesopt)

Constructs a new RecognitionConfig.

Parameters:
Name Type Attributes Description
properties google.cloud.speech.v1.IRecognitionConfig <optional>

Properties to set

Implements:
  • IRecognitionConfig

Members

AudioEncoding

AudioEncoding enum.

Properties:
Name Type Description
ENCODING_UNSPECIFIED number

ENCODING_UNSPECIFIED value

LINEAR16 number

LINEAR16 value

FLAC number

FLAC value

MULAW number

MULAW value

AMR number

AMR value

AMR_WB number

AMR_WB value

OGG_OPUS number

OGG_OPUS value

SPEEX_WITH_HEADER_BYTE number

SPEEX_WITH_HEADER_BYTE value

audioChannelCount

RecognitionConfig audioChannelCount.

diarizationConfig

RecognitionConfig diarizationConfig.

enableAutomaticPunctuation

RecognitionConfig enableAutomaticPunctuation.

enableSeparateRecognitionPerChannel

RecognitionConfig enableSeparateRecognitionPerChannel.

enableWordTimeOffsets

RecognitionConfig enableWordTimeOffsets.

encoding

RecognitionConfig encoding.

languageCode

RecognitionConfig languageCode.

maxAlternatives

RecognitionConfig maxAlternatives.

metadata

RecognitionConfig metadata.

model

RecognitionConfig model.

profanityFilter

RecognitionConfig profanityFilter.

sampleRateHertz

RecognitionConfig sampleRateHertz.

speechContexts

RecognitionConfig speechContexts.

useEnhanced

RecognitionConfig useEnhanced.

Methods

(static) create(propertiesopt) → {google.cloud.speech.v1.RecognitionConfig}

Creates a new RecognitionConfig instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.speech.v1.IRecognitionConfig <optional>

Properties to set

Returns:
Type Description
google.cloud.speech.v1.RecognitionConfig

RecognitionConfig instance

(static) decode(reader, lengthopt) → {google.cloud.speech.v1.RecognitionConfig}

Decodes a RecognitionConfig message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.speech.v1.RecognitionConfig

RecognitionConfig

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.speech.v1.RecognitionConfig}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.speech.v1.RecognitionConfig

RecognitionConfig

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.speech.v1.IRecognitionConfig

RecognitionConfig message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.speech.v1.IRecognitionConfig

RecognitionConfig message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.speech.v1.RecognitionConfig}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.speech.v1.RecognitionConfig

RecognitionConfig

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.speech.v1.RecognitionConfig

RecognitionConfig

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a RecognitionConfig message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this RecognitionConfig to JSON.

Returns:
Type Description
Object.<string, *>

JSON object