Namespace Microsoft::CognitiveServices::Speech::Audio

Summary

Members Descriptions
enum PresetMicrophoneArrayGeometry Types of preset microphone array geometries. See Microphone Array Recommendations for more details.
enum MicrophoneArrayType Types of microphone arrays.
enum SpeakerReferenceChannel Defines speaker reference channel position in input audio.
enum AudioStreamContainerFormat Defines supported audio stream container format. Changed in version 1.4.0.
enum AudioStreamWaveFormat Represents the format specified inside WAV container.
class Audio::AudioConfig Represents audio input or output configuration. Audio input can be from a microphone, file, or input stream. Audio output can be to a speaker, audio file output in WAV format, or output stream.
class Audio::AudioInputStream Represents audio input stream used for custom audio input configurations.
class Audio::AudioOutputStream Represents audio output stream used for custom audio output configurations. Updated in version 1.7.0.
class Audio::AudioProcessingOptions Represents audio processing options used with audio config class.
class Audio::AudioStreamFormat Class to represent the audio stream format used for custom audio input configurations. Updated in version 1.5.0.
class Audio::PullAudioInputStream Pull audio input stream class.
class Audio::PullAudioInputStreamCallback An interface that defines callback methods for an audio input stream.
class Audio::PullAudioOutputStream Represents memory backed pull audio output stream used for custom audio output. Updated in version 1.7.0.
class Audio::PushAudioInputStream Represents memory backed push audio input stream used for custom audio input configurations.
class Audio::PushAudioOutputStream Push audio output stream class. Added in version 1.4.0.
class Audio::PushAudioOutputStreamCallback An interface that defines callback methods for an audio output stream. Updated in version 1.7.0.
struct Audio::MicrophoneArrayGeometry Represents the geometry of a microphone array.

Members

enum PresetMicrophoneArrayGeometry

Values Descriptions
Uninitialized Indicates that no geometry specified. Speech SDK will determine the microphone array geometry.
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 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 Indicates a microphone array with four linearly placed microphones with 40 mm spacing between them.
Linear2 Indicates a microphone array with two linearly placed microphones with 40 mm spacing between them.
Mono Indicates a microphone array with a single microphone.
Custom Indicates a microphone array with custom geometry.

Types of preset microphone array geometries. See Microphone Array Recommendations for more details.

enum MicrophoneArrayType

Values Descriptions
Linear Indicates that the microphone array has microphones in a straight line.
Planar Indicates that the microphone array has microphones in a plane.

Types of microphone arrays.

enum SpeakerReferenceChannel

Values Descriptions
None Indicates that the input audio does not have a speaker reference channel.
LastChannel Indicates that the last channel in the input audio corresponds to the speaker reference for echo cancellation.

Defines speaker reference channel position in input audio.

enum AudioStreamContainerFormat

Values Descriptions
OGG_OPUS Stream ContainerFormat definition for OGG OPUS.
MP3 Stream ContainerFormat definition for MP3.
FLAC Stream ContainerFormat definition for FLAC. Added in version 1.7.0.
ALAW Stream ContainerFormat definition for ALAW. Added in version 1.7.0.
MULAW Stream ContainerFormat definition for MULAW. Added in version 1.7.0.
AMRNB Stream ContainerFormat definition for AMRNB. Currently not supported.
AMRWB Stream ContainerFormat definition for AMRWB. Currently not supported.
ANY Stream ContainerFormat definition for any other or unknown format.

Defines supported audio stream container format. Changed in version 1.4.0.

enum AudioStreamWaveFormat

Values Descriptions
PCM AudioStreamWaveFormat definition for PCM (pulse-code modulated) data in integer format.
ALAW AudioStreamWaveFormat definition A-law-encoded format.
MULAW AudioStreamWaveFormat definition for Mu-law-encoded format.

Represents the format specified inside WAV container.