RecognitionConfig.AudioEncoding (java API)

java.lang.Object
- java.lang.Enum<RecognitionConfig.AudioEncoding>
- - com.google.cloud.speech.v1.RecognitionConfig.AudioEncoding

All Implemented Interfaces:: Internal.EnumLite, ProtocolMessageEnum, java.io.Serializable, java.lang.Comparable<RecognitionConfig.AudioEncoding>

Enclosing class:: RecognitionConfig

public static enum RecognitionConfig.AudioEncoding
extends java.lang.Enum<RecognitionConfig.AudioEncoding>
implements ProtocolMessageEnum

 Audio encoding of the data sent in the audio message. All encodings support
 only 1 channel (mono) audio. Only `FLAC` and `WAV` include a header that
 describes the bytes of audio that follow the header. The other encodings
 are raw audio bytes with no header.
 For best results, the audio source should be captured and transmitted using
 a lossless encoding (`FLAC` or `LINEAR16`). Recognition accuracy may be
 reduced if lossy codecs, which include the other codecs listed in
 this section, are used to capture or transmit the audio, particularly if
 background noise is present.

Protobuf enum google.cloud.speech.v1.RecognitionConfig.AudioEncoding

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AMR` Adaptive Multi-Rate Narrowband codec.
`AMR_WB` Adaptive Multi-Rate Wideband codec.
`ENCODING_UNSPECIFIED` Not specified.
`FLAC` [`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless--therefore recognition is not compromised--and requires only about half the bandwidth of `LINEAR16`.
`LINEAR16` Uncompressed 16-bit signed little-endian samples (Linear PCM).
`MULAW` 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.
`OGG_OPUS` Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)).
`SPEEX_WITH_HEADER_BYTE` Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding.
`UNRECOGNIZED`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AMR_VALUE` Adaptive Multi-Rate Narrowband codec.
`static int`	`AMR_WB_VALUE` Adaptive Multi-Rate Wideband codec.
`static int`	`ENCODING_UNSPECIFIED_VALUE` Not specified.
`static int`	`FLAC_VALUE` [`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless--therefore recognition is not compromised--and requires only about half the bandwidth of `LINEAR16`.
`static int`	`LINEAR16_VALUE` Uncompressed 16-bit signed little-endian samples (Linear PCM).
`static int`	`MULAW_VALUE` 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.
`static int`	`OGG_OPUS_VALUE` Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)).
`static int`	`SPEEX_WITH_HEADER_BYTE_VALUE` Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static RecognitionConfig.AudioEncoding`	`forNumber(int value)`
`static Descriptors.EnumDescriptor`	`getDescriptor()`
`Descriptors.EnumDescriptor`	`getDescriptorForType()`
`int`	`getNumber()`
`Descriptors.EnumValueDescriptor`	`getValueDescriptor()`
`static Internal.EnumLiteMap<RecognitionConfig.AudioEncoding>`	`internalGetValueMap()`
`static RecognitionConfig.AudioEncoding`	`valueOf(Descriptors.EnumValueDescriptor desc)`
`static RecognitionConfig.AudioEncoding`	`valueOf(int value)` Deprecated. Use `forNumber(int)` instead.
`static RecognitionConfig.AudioEncoding`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static RecognitionConfig.AudioEncoding[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ENCODING_UNSPECIFIED

public static final RecognitionConfig.AudioEncoding ENCODING_UNSPECIFIED

 Not specified. Will return result [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT].

ENCODING_UNSPECIFIED = 0;

LINEAR16

public static final RecognitionConfig.AudioEncoding LINEAR16

 Uncompressed 16-bit signed little-endian samples (Linear PCM).

LINEAR16 = 1;

FLAC

public static final RecognitionConfig.AudioEncoding FLAC

 [`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio
 Codec) is the recommended encoding because it is
 lossless--therefore recognition is not compromised--and
 requires only about half the bandwidth of `LINEAR16`. `FLAC` stream
 encoding supports 16-bit and 24-bit samples, however, not all fields in
 `STREAMINFO` are supported.

FLAC = 2;

MULAW

public static final RecognitionConfig.AudioEncoding MULAW

 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.

MULAW = 3;

AMR

public static final RecognitionConfig.AudioEncoding AMR

 Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.

AMR = 4;

AMR_WB

public static final RecognitionConfig.AudioEncoding AMR_WB

 Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.

AMR_WB = 5;

OGG_OPUS

public static final RecognitionConfig.AudioEncoding OGG_OPUS

 Opus encoded audio frames in Ogg container
 ([OggOpus](https://wiki.xiph.org/OggOpus)).
 `sample_rate_hertz` must be 16000.

OGG_OPUS = 6;

SPEEX_WITH_HEADER_BYTE

public static final RecognitionConfig.AudioEncoding SPEEX_WITH_HEADER_BYTE

 Although the use of lossy encodings is not recommended, if a very low
 bitrate encoding is required, `OGG_OPUS` is highly preferred over
 Speex encoding. The [Speex](https://speex.org/)  encoding supported by
 Cloud Speech API has a header byte in each block, as in MIME type
 `audio/x-speex-with-header-byte`.
 It is a variant of the RTP Speex encoding defined in
 [RFC 5574](https://tools.ietf.org/html/rfc5574).
 The stream is a sequence of blocks, one block per RTP packet. Each block
 starts with a byte containing the length of the block, in bytes, followed
 by one or more frames of Speex data, padded to an integral number of
 bytes (octets) as specified in RFC 5574. In other words, each RTP header
 is replaced with a single byte containing the block length. Only Speex
 wideband is supported. `sample_rate_hertz` must be 16000.

SPEEX_WITH_HEADER_BYTE = 7;

UNRECOGNIZED

public static final RecognitionConfig.AudioEncoding UNRECOGNIZED

Field Detail

ENCODING_UNSPECIFIED_VALUE

public static final int ENCODING_UNSPECIFIED_VALUE

 Not specified. Will return result [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT].

ENCODING_UNSPECIFIED = 0;

See Also:: Constant Field Values

LINEAR16_VALUE

public static final int LINEAR16_VALUE

 Uncompressed 16-bit signed little-endian samples (Linear PCM).

LINEAR16 = 1;

See Also:: Constant Field Values

FLAC_VALUE

public static final int FLAC_VALUE

 [`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio
 Codec) is the recommended encoding because it is
 lossless--therefore recognition is not compromised--and
 requires only about half the bandwidth of `LINEAR16`. `FLAC` stream
 encoding supports 16-bit and 24-bit samples, however, not all fields in
 `STREAMINFO` are supported.

FLAC = 2;

See Also:: Constant Field Values

MULAW_VALUE

public static final int MULAW_VALUE

 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.

MULAW = 3;

See Also:: Constant Field Values

AMR_VALUE

public static final int AMR_VALUE

 Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.

AMR = 4;

See Also:: Constant Field Values

AMR_WB_VALUE

public static final int AMR_WB_VALUE

 Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.

AMR_WB = 5;

See Also:: Constant Field Values

OGG_OPUS_VALUE

public static final int OGG_OPUS_VALUE

 Opus encoded audio frames in Ogg container
 ([OggOpus](https://wiki.xiph.org/OggOpus)).
 `sample_rate_hertz` must be 16000.

OGG_OPUS = 6;

See Also:: Constant Field Values

SPEEX_WITH_HEADER_BYTE_VALUE

public static final int SPEEX_WITH_HEADER_BYTE_VALUE

 Although the use of lossy encodings is not recommended, if a very low
 bitrate encoding is required, `OGG_OPUS` is highly preferred over
 Speex encoding. The [Speex](https://speex.org/)  encoding supported by
 Cloud Speech API has a header byte in each block, as in MIME type
 `audio/x-speex-with-header-byte`.
 It is a variant of the RTP Speex encoding defined in
 [RFC 5574](https://tools.ietf.org/html/rfc5574).
 The stream is a sequence of blocks, one block per RTP packet. Each block
 starts with a byte containing the length of the block, in bytes, followed
 by one or more frames of Speex data, padded to an integral number of
 bytes (octets) as specified in RFC 5574. In other words, each RTP header
 is replaced with a single byte containing the block length. Only Speex
 wideband is supported. `sample_rate_hertz` must be 16000.

SPEEX_WITH_HEADER_BYTE = 7;

See Also:: Constant Field Values

Method Detail
- values
```
public static RecognitionConfig.AudioEncoding[] values()
```
  Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (RecognitionConfig.AudioEncoding c : RecognitionConfig.AudioEncoding.values())
    System.out.println(c);
```
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
```
public static RecognitionConfig.AudioEncoding valueOf(java.lang.String name)
```
  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
  
  Parameters:
  
  name - the name of the enum constant to be returned.
  
  Returns:
  
  the enum constant with the specified name
  
  Throws:
  
  java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
  
  java.lang.NullPointerException - if the argument is null
- getNumber
```
public final int getNumber()
```
  Specified by:
  
  getNumber in interface Internal.EnumLite
  
  Specified by:
  
  getNumber in interface ProtocolMessageEnum
- valueOf
```
@Deprecated
public static RecognitionConfig.AudioEncoding valueOf(int value)
```
  Deprecated. Use forNumber(int) instead.
- forNumber
```
public static RecognitionConfig.AudioEncoding forNumber(int value)
```
- internalGetValueMap
```
public static Internal.EnumLiteMap<RecognitionConfig.AudioEncoding> internalGetValueMap()
```
- getValueDescriptor
```
public final Descriptors.EnumValueDescriptor getValueDescriptor()
```
  Specified by:
  
  getValueDescriptor in interface ProtocolMessageEnum
- getDescriptorForType
```
public final Descriptors.EnumDescriptor getDescriptorForType()
```
  Specified by:
  
  getDescriptorForType in interface ProtocolMessageEnum
- getDescriptor
```
public static final Descriptors.EnumDescriptor getDescriptor()
```
- valueOf
```
public static RecognitionConfig.AudioEncoding valueOf(Descriptors.EnumValueDescriptor desc)
```

Enum RecognitionConfig.AudioEncoding

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ENCODING_UNSPECIFIED

LINEAR16

FLAC

MULAW

AMR

AMR_WB

OGG_OPUS

SPEEX_WITH_HEADER_BYTE

UNRECOGNIZED

Field Detail

ENCODING_UNSPECIFIED_VALUE

LINEAR16_VALUE

FLAC_VALUE

MULAW_VALUE

AMR_VALUE

AMR_WB_VALUE

OGG_OPUS_VALUE

SPEEX_WITH_HEADER_BYTE_VALUE

Method Detail

values

valueOf

getNumber

valueOf

forNumber

internalGetValueMap

getValueDescriptor

getDescriptorForType

getDescriptor

valueOf