com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.yml

### YamlMime:JavaType
uid: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions"
fullName: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions"
name: "AudioProcessingOptions"
nameWithType: "AudioProcessingOptions"
summary: "Represents audio processing options used with audio config class."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
  methodsRef:
  - "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **AudioProcessingOptions**</br> implements <xref href=\"java.lang.AutoCloseable?alt=java.lang.AutoCloseable&text=AutoCloseable\" data-throw-if-not-resolved=\"False\" />"
methods:
- uid: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.close()"
  fullName: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.close()"
  name: "close()"
  nameWithType: "AudioProcessingOptions.close()"
  summary: "Explicitly frees any external resource attached to the object."
  syntax: "public void close()"
  desc: "Explicitly frees any external resource attached to the object."
- uid: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.create(int)"
  fullName: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.create(int audioProcessingFlags)"
  name: "create(int audioProcessingFlags)"
  nameWithType: "AudioProcessingOptions.create(int audioProcessingFlags)"
  summary: "Creates an Audio<wbr>Processing<wbr>Options object with audio processing flags."
  modifiers:
  - "static"
  parameters:
  - description: "Specifies flags to control the audio processing performed by Speech SDK. It is bitwise OR of constants from AudioProcessingConstants class."
    name: "audioProcessingFlags"
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static AudioProcessingOptions create(int audioProcessingFlags)"
  desc: "Creates an AudioProcessingOptions object with audio processing flags. This method should only be used when the audio input is from a microphone array. On Windows, this method will try to query the microphone array geometry from the audio driver. Audio data is also read from speaker reference channel. On Linux, it assumes that the microphone is a single channel microphone."
  returns:
    description: "The audio processing options object being created."
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions?alt=com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions&text=AudioProcessingOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.create(int,com.microsoft.cognitiveservices.speech.audio.MicrophoneArrayGeometry)"
  fullName: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.create(int audioProcessingFlags, MicrophoneArrayGeometry microphoneArrayGeometry)"
  name: "create(int audioProcessingFlags, MicrophoneArrayGeometry microphoneArrayGeometry)"
  nameWithType: "AudioProcessingOptions.create(int audioProcessingFlags, MicrophoneArrayGeometry microphoneArrayGeometry)"
  summary: "Creates an Audio<wbr>Processing<wbr>Options object with audio processing flags and custom microphone array geometry."
  modifiers:
  - "static"
  parameters:
  - description: "Specifies flags to control the audio processing performed by Speech SDK. It is bitwise OR of constants from AudioProcessingConstants class."
    name: "audioProcessingFlags"
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
  - description: "Specifies the microphone array geometry."
    name: "microphoneArrayGeometry"
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.audio.MicrophoneArrayGeometry?alt=com.microsoft.cognitiveservices.speech.audio.MicrophoneArrayGeometry&text=MicrophoneArrayGeometry\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static AudioProcessingOptions create(int audioProcessingFlags, MicrophoneArrayGeometry microphoneArrayGeometry)"
  desc: "Creates an AudioProcessingOptions object with audio processing flags and custom microphone array geometry."
  returns:
    description: "The audio processing options object being created."
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions?alt=com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions&text=AudioProcessingOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.create(int,com.microsoft.cognitiveservices.speech.audio.MicrophoneArrayGeometry,com.microsoft.cognitiveservices.speech.audio.SpeakerReferenceChannel)"
  fullName: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.create(int audioProcessingFlags, MicrophoneArrayGeometry microphoneArrayGeometry, SpeakerReferenceChannel speakerReferenceChannel)"
  name: "create(int audioProcessingFlags, MicrophoneArrayGeometry microphoneArrayGeometry, SpeakerReferenceChannel speakerReferenceChannel)"
  nameWithType: "AudioProcessingOptions.create(int audioProcessingFlags, MicrophoneArrayGeometry microphoneArrayGeometry, SpeakerReferenceChannel speakerReferenceChannel)"
  summary: "Creates an Audio<wbr>Processing<wbr>Options object with audio processing flags, custom microphone array geometry and speaker reference channel position."
  modifiers:
  - "static"
  parameters:
  - description: "Specifies flags to control the audio processing performed by Speech SDK. It is bitwise OR of constants from AudioProcessingConstants class."
    name: "audioProcessingFlags"
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
  - description: "Specifies the microphone array geometry."
    name: "microphoneArrayGeometry"
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.audio.MicrophoneArrayGeometry?alt=com.microsoft.cognitiveservices.speech.audio.MicrophoneArrayGeometry&text=MicrophoneArrayGeometry\" data-throw-if-not-resolved=\"False\" />"
  - description: "Specifies the speaker reference channel position in the input audio."
    name: "speakerReferenceChannel"
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.audio.SpeakerReferenceChannel?alt=com.microsoft.cognitiveservices.speech.audio.SpeakerReferenceChannel&text=SpeakerReferenceChannel\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static AudioProcessingOptions create(int audioProcessingFlags, MicrophoneArrayGeometry microphoneArrayGeometry, SpeakerReferenceChannel speakerReferenceChannel)"
  desc: "Creates an AudioProcessingOptions object with audio processing flags, custom microphone array geometry and speaker reference channel position."
  returns:
    description: "The audio processing options object being created."
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions?alt=com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions&text=AudioProcessingOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.create(int,com.microsoft.cognitiveservices.speech.audio.PresetMicrophoneArrayGeometry)"
  fullName: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.create(int audioProcessingFlags, PresetMicrophoneArrayGeometry microphoneArrayGeometry)"
  name: "create(int audioProcessingFlags, PresetMicrophoneArrayGeometry microphoneArrayGeometry)"
  nameWithType: "AudioProcessingOptions.create(int audioProcessingFlags, PresetMicrophoneArrayGeometry microphoneArrayGeometry)"
  summary: "Creates an Audio<wbr>Processing<wbr>Options object with audio processing flags and preset microphone array geometry."
  modifiers:
  - "static"
  parameters:
  - description: "Specifies flags to control the audio processing performed by Speech SDK. It is bitwise OR of constants from AudioProcessingConstants class."
    name: "audioProcessingFlags"
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
  - description: "Specifies the type of microphone array geometry."
    name: "microphoneArrayGeometry"
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.audio.PresetMicrophoneArrayGeometry?alt=com.microsoft.cognitiveservices.speech.audio.PresetMicrophoneArrayGeometry&text=PresetMicrophoneArrayGeometry\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static AudioProcessingOptions create(int audioProcessingFlags, PresetMicrophoneArrayGeometry microphoneArrayGeometry)"
  desc: "Creates an AudioProcessingOptions object with audio processing flags and preset microphone array geometry."
  returns:
    description: "The audio processing options object being created."
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions?alt=com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions&text=AudioProcessingOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.create(int,com.microsoft.cognitiveservices.speech.audio.PresetMicrophoneArrayGeometry,com.microsoft.cognitiveservices.speech.audio.SpeakerReferenceChannel)"
  fullName: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.create(int audioProcessingFlags, PresetMicrophoneArrayGeometry microphoneArrayGeometry, SpeakerReferenceChannel speakerReferenceChannel)"
  name: "create(int audioProcessingFlags, PresetMicrophoneArrayGeometry microphoneArrayGeometry, SpeakerReferenceChannel speakerReferenceChannel)"
  nameWithType: "AudioProcessingOptions.create(int audioProcessingFlags, PresetMicrophoneArrayGeometry microphoneArrayGeometry, SpeakerReferenceChannel speakerReferenceChannel)"
  summary: "Creates an Audio<wbr>Processing<wbr>Options object with audio processing flags, preset microphone array geometry and speaker reference channel position."
  modifiers:
  - "static"
  parameters:
  - description: "Specifies flags to control the audio processing performed by Speech SDK. It is bitwise OR of constants from AudioProcessingConstants class."
    name: "audioProcessingFlags"
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
  - description: "Specifies the type of microphone array geometry."
    name: "microphoneArrayGeometry"
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.audio.PresetMicrophoneArrayGeometry?alt=com.microsoft.cognitiveservices.speech.audio.PresetMicrophoneArrayGeometry&text=PresetMicrophoneArrayGeometry\" data-throw-if-not-resolved=\"False\" />"
  - description: "Specifies the speaker reference channel position in the input audio."
    name: "speakerReferenceChannel"
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.audio.SpeakerReferenceChannel?alt=com.microsoft.cognitiveservices.speech.audio.SpeakerReferenceChannel&text=SpeakerReferenceChannel\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static AudioProcessingOptions create(int audioProcessingFlags, PresetMicrophoneArrayGeometry microphoneArrayGeometry, SpeakerReferenceChannel speakerReferenceChannel)"
  desc: "Creates an AudioProcessingOptions object with audio processing flags, preset microphone array geometry and speaker reference channel position."
  returns:
    description: "The audio processing options object being created."
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions?alt=com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions&text=AudioProcessingOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.getAudioProcessingFlags()"
  fullName: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.getAudioProcessingFlags()"
  name: "getAudioProcessingFlags()"
  nameWithType: "AudioProcessingOptions.getAudioProcessingFlags()"
  summary: "Returns the type of audio processing performed by Speech SDK."
  syntax: "public int getAudioProcessingFlags()"
  desc: "Returns the type of audio processing performed by Speech SDK."
  returns:
    description: "Bitwise OR of flags from AudioProcessingConstants class indicating the audio processing performed by Speech SDK."
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.getBeamformingEndAngle()"
  fullName: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.getBeamformingEndAngle()"
  name: "getBeamformingEndAngle()"
  nameWithType: "AudioProcessingOptions.getBeamformingEndAngle()"
  summary: "Returns the end angle used for beamforming."
  syntax: "public int getBeamformingEndAngle()"
  desc: "Returns the end angle used for beamforming."
  returns:
    description: "Beamforming end angle."
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.getBeamformingStartAngle()"
  fullName: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.getBeamformingStartAngle()"
  name: "getBeamformingStartAngle()"
  nameWithType: "AudioProcessingOptions.getBeamformingStartAngle()"
  summary: "Returns the start angle used for beamforming."
  syntax: "public int getBeamformingStartAngle()"
  desc: "Returns the start angle used for beamforming."
  returns:
    description: "Beamforming start angle."
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.getImpl()"
  fullName: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.getImpl()"
  name: "getImpl()"
  nameWithType: "AudioProcessingOptions.getImpl()"
  summary: "Returns the audio processing options implementation."
  syntax: "public SafeHandle getImpl()"
  desc: "Returns the audio processing options implementation."
  returns:
    description: "The implementation of the audio processing options."
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.util.SafeHandle?alt=com.microsoft.cognitiveservices.speech.util.SafeHandle&text=SafeHandle\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.getMicrophoneArrayType()"
  fullName: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.getMicrophoneArrayType()"
  name: "getMicrophoneArrayType()"
  nameWithType: "AudioProcessingOptions.getMicrophoneArrayType()"
  summary: "Returns the microphone array type of the microphone used for audio input."
  syntax: "public MicrophoneArrayType getMicrophoneArrayType()"
  desc: "Returns the microphone array type of the microphone used for audio input."
  returns:
    description: "Type of microphone array used for audio input."
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.audio.MicrophoneArrayType?alt=com.microsoft.cognitiveservices.speech.audio.MicrophoneArrayType&text=MicrophoneArrayType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.getMicrophoneCoordinates()"
  fullName: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.getMicrophoneCoordinates()"
  name: "getMicrophoneCoordinates()"
  nameWithType: "AudioProcessingOptions.getMicrophoneCoordinates()"
  summary: "Returns the coordinates of microphones in the microphone array used for audio input."
  syntax: "public MicrophoneCoordinates[] getMicrophoneCoordinates()"
  desc: "Returns the coordinates of microphones in the microphone array used for audio input."
  returns:
    description: "An array of MicrophoneCoordinates objects."
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.audio.MicrophoneCoordinates?alt=com.microsoft.cognitiveservices.speech.audio.MicrophoneCoordinates&text=MicrophoneCoordinates\" data-throw-if-not-resolved=\"False\" />[]"
- uid: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.getPresetMicrophoneArrayGeometry()"
  fullName: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.getPresetMicrophoneArrayGeometry()"
  name: "getPresetMicrophoneArrayGeometry()"
  nameWithType: "AudioProcessingOptions.getPresetMicrophoneArrayGeometry()"
  summary: "Returns the microphone array geometry of the microphone used for audio input."
  syntax: "public PresetMicrophoneArrayGeometry getPresetMicrophoneArrayGeometry()"
  desc: "Returns the microphone array geometry of the microphone used for audio input."
  returns:
    description: "Microphone array geometry of the microphone used for audio input."
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.audio.PresetMicrophoneArrayGeometry?alt=com.microsoft.cognitiveservices.speech.audio.PresetMicrophoneArrayGeometry&text=PresetMicrophoneArrayGeometry\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.getSpeakerReferenceChannel()"
  fullName: "com.microsoft.cognitiveservices.speech.audio.AudioProcessingOptions.getSpeakerReferenceChannel()"
  name: "getSpeakerReferenceChannel()"
  nameWithType: "AudioProcessingOptions.getSpeakerReferenceChannel()"
  summary: "Returns the speaker reference channel position in the audio input."
  syntax: "public SpeakerReferenceChannel getSpeakerReferenceChannel()"
  desc: "Returns the speaker reference channel position in the audio input."
  returns:
    description: "Speaker reference channel position in the audio input."
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.audio.SpeakerReferenceChannel?alt=com.microsoft.cognitiveservices.speech.audio.SpeakerReferenceChannel&text=SpeakerReferenceChannel\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Represents audio processing options used with audio config class. Note: close() must be called in order to release underlying resources held by the object."
implements:
- "<xref href=\"java.lang.AutoCloseable?alt=java.lang.AutoCloseable&text=AutoCloseable\" data-throw-if-not-resolved=\"False\" />"
metadata: {}
package: "com.microsoft.cognitiveservices.speech.audio"
artifact: com.microsoft.cognitiveservices.speech:client-sdk:1.38.0