Package com.microsoft.cognitiveservices.speech.audio

Enum PresetMicrophoneArrayGeometry

java.lang.Object

java.lang.Enum<PresetMicrophoneArrayGeometry>

com.microsoft.cognitiveservices.speech.audio.PresetMicrophoneArrayGeometry

All Implemented Interfaces:

Serializable, Comparable<PresetMicrophoneArrayGeometry>

public enum PresetMicrophoneArrayGeometry
extends Enum<PresetMicrophoneArrayGeometry>

Types of preset microphone array geometries. Check https://docs.microsoft.com/azure/cognitive-services/speech-service/speech-devices-sdk-microphone for details.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Circular4	Indicates a microphone array with one microphone in the center and three microphones evenly spaced in a circle with radius approximately equal to 42.5 mm.
Circular7	Indicates a microphone array with one microphone in the center and six microphones evenly spaced in a circle with radius approximately equal to 42.5 mm.
Custom	Indicates a microphone array with custom geometry.
Linear2	Indicates a microphone array with two linearly placed microphones with 40 mm spacing between them.
Linear4	Indicates a microphone array with four linearly placed microphones with 40 mm spacing between them.
Mono	Indicates a microphone array with a single microphone.
Uninitialized	Indicates that no geometry specified.

Method Summary

Modifier and Type	Method	Description
static PresetMicrophoneArrayGeometry	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PresetMicrophoneArrayGeometry[]	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

Uninitialized

public static final PresetMicrophoneArrayGeometry Uninitialized

Indicates that no geometry specified. Speech SDK will determine the microphone array geometry.

Circular7

public static final PresetMicrophoneArrayGeometry Circular7

Indicates a microphone array with one microphone in the center and six microphones evenly spaced in a circle with radius approximately equal to 42.5 mm.

Circular4

public static final PresetMicrophoneArrayGeometry Circular4

Indicates a microphone array with one microphone in the center and three microphones evenly spaced in a circle with radius approximately equal to 42.5 mm.

Linear4

public static final PresetMicrophoneArrayGeometry Linear4

Indicates a microphone array with four linearly placed microphones with 40 mm spacing between them.

Linear2

public static final PresetMicrophoneArrayGeometry Linear2

Indicates a microphone array with two linearly placed microphones with 40 mm spacing between them.

Mono

public static final PresetMicrophoneArrayGeometry Mono

Indicates a microphone array with a single microphone.

Custom

public static final PresetMicrophoneArrayGeometry Custom

Indicates a microphone array with custom geometry.

Method Detail

values

public static PresetMicrophoneArrayGeometry[] 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 (PresetMicrophoneArrayGeometry c : PresetMicrophoneArrayGeometry.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PresetMicrophoneArrayGeometry valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null