AudioProcessingOptions.Create Method

Definition

Namespace:

Microsoft.CognitiveServices.Speech.Audio

Assembly:

Microsoft.CognitiveServices.Speech.csharp.dll

Package:

Microsoft.CognitiveServices.Speech v1.34.0

Overloads

Create(Int32)	Creates an AudioProcessingOptions object with audio processing flags.
Create(Int32, MicrophoneArrayGeometry, SpeakerReferenceChannel)	Creates an AudioProcessingOptions object with audio processing flags, custom microphone array geometry and speaker reference channel position.
Create(Int32, PresetMicrophoneArrayGeometry, SpeakerReferenceChannel)	Creates an AudioProcessingOptions object with audio processing flags, preset microphone array geometry and speaker reference channel position.

Create(Int32)

Creates an AudioProcessingOptions object with audio processing flags.

public static Microsoft.CognitiveServices.Speech.Audio.AudioProcessingOptions Create (int audioProcessingFlags);

static member Create : int -> Microsoft.CognitiveServices.Speech.Audio.AudioProcessingOptions

Public Shared Function Create (audioProcessingFlags As Integer) As AudioProcessingOptions

Parameters

audioProcessingFlags

Int32

Specifies flags to control the audio processing performed by Speech SDK. It is bitwise OR of constants from AudioProcessingConstants class.

Returns

AudioProcessingOptions

The audio processing options object being created.

Remarks

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.

Create(Int32, MicrophoneArrayGeometry, SpeakerReferenceChannel)

Creates an AudioProcessingOptions object with audio processing flags, custom microphone array geometry and speaker reference channel position.

public static Microsoft.CognitiveServices.Speech.Audio.AudioProcessingOptions Create (int audioProcessingFlags, Microsoft.CognitiveServices.Speech.Audio.MicrophoneArrayGeometry microphoneArrayGeometry, Microsoft.CognitiveServices.Speech.Audio.SpeakerReferenceChannel speakerReferenceChannel = Microsoft.CognitiveServices.Speech.Audio.SpeakerReferenceChannel.None);

static member Create : int * Microsoft.CognitiveServices.Speech.Audio.MicrophoneArrayGeometry * Microsoft.CognitiveServices.Speech.Audio.SpeakerReferenceChannel -> Microsoft.CognitiveServices.Speech.Audio.AudioProcessingOptions

Public Shared Function Create (audioProcessingFlags As Integer, microphoneArrayGeometry As MicrophoneArrayGeometry, Optional speakerReferenceChannel As SpeakerReferenceChannel = Microsoft.CognitiveServices.Speech.Audio.SpeakerReferenceChannel.None) As AudioProcessingOptions

Parameters

audioProcessingFlags

Int32

Specifies flags to control the audio processing performed by Speech SDK. It is bitwise OR of constants from AudioProcessingConstants class.

microphoneArrayGeometry

MicrophoneArrayGeometry

Specifies the microphone array geometry.

speakerReferenceChannel

SpeakerReferenceChannel

Specifies the speaker reference channel position in the input audio.

Returns

AudioProcessingOptions

The audio processing options object being created.

Create(Int32, PresetMicrophoneArrayGeometry, SpeakerReferenceChannel)

Creates an AudioProcessingOptions object with audio processing flags, preset microphone array geometry and speaker reference channel position.

public static Microsoft.CognitiveServices.Speech.Audio.AudioProcessingOptions Create (int audioProcessingFlags, Microsoft.CognitiveServices.Speech.Audio.PresetMicrophoneArrayGeometry microphoneArrayGeometry, Microsoft.CognitiveServices.Speech.Audio.SpeakerReferenceChannel speakerReferenceChannel = Microsoft.CognitiveServices.Speech.Audio.SpeakerReferenceChannel.None);

static member Create : int * Microsoft.CognitiveServices.Speech.Audio.PresetMicrophoneArrayGeometry * Microsoft.CognitiveServices.Speech.Audio.SpeakerReferenceChannel -> Microsoft.CognitiveServices.Speech.Audio.AudioProcessingOptions

Public Shared Function Create (audioProcessingFlags As Integer, microphoneArrayGeometry As PresetMicrophoneArrayGeometry, Optional speakerReferenceChannel As SpeakerReferenceChannel = Microsoft.CognitiveServices.Speech.Audio.SpeakerReferenceChannel.None) As AudioProcessingOptions

Parameters

audioProcessingFlags

Int32

Specifies flags to control the audio processing performed by Speech SDK. It is bitwise OR of constants from AudioProcessingConstants class.

microphoneArrayGeometry

PresetMicrophoneArrayGeometry

Specifies the type of microphone array geometry.

speakerReferenceChannel

SpeakerReferenceChannel

Specifies the speaker reference channel position in the input audio.

Returns

AudioProcessingOptions

The audio processing options object being created.