AudioConfig Class

Definition

Namespace:

Microsoft.CognitiveServices.Speech.Audio

Assembly:

Microsoft.CognitiveServices.Speech.csharp.dll

Package:

Microsoft.CognitiveServices.Speech v1.34.0

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.

public sealed class AudioConfig : IDisposable

type AudioConfig = class
    interface IDisposable

Public NotInheritable Class AudioConfig
Implements IDisposable

Inheritance

Object

AudioConfig

Implements

IDisposable

Remarks

See also: Get started with speech-to-text

Properties

AudioProcessingOptions

Audio processing options used by Speech SDK.

Methods

Dispose()	Dispose of associated resources held by the object.
FromDefaultMicrophoneInput()	Creates an AudioConfig object that receives speech from the default microphone on the computer.
FromDefaultMicrophoneInput(AudioProcessingOptions)	Creates an AudioConfig object that receives speech from the default microphone on the computer.
FromDefaultSpeakerOutput()	Creates an AudioConfig object that produces speech on the computer's default speaker. Added in 1.4.0
FromMicrophoneInput(String)	Creates an AudioConfig object that receives speech from a specific microphone on the computer. Added in 1.3.0
FromMicrophoneInput(String, AudioProcessingOptions)	Creates an AudioConfig object that receives speech from a specific microphone on the computer.
FromSpeakerOutput(String)	Creates an AudioConfig object that produces speech to to the specified speaker. Added in 1.14.0
FromStreamInput(AudioInputStream)	Creates an AudioConfig object that receives speech from a stream.
FromStreamInput(AudioInputStream, AudioProcessingOptions)	Creates an AudioConfig object that receives speech from a stream.
FromStreamInput(PullAudioInputStreamCallback)	Creates an AudioConfig object that receives speech from a stream using an audio input stream callback.
FromStreamInput(PullAudioInputStreamCallback, AudioProcessingOptions)	Creates an AudioConfig object that receives speech from a stream using an audio input stream callback.
FromStreamInput(PullAudioInputStreamCallback, AudioStreamFormat)	Creates an AudioConfig object that receives speech from a stream in a specified format using an audio input stream callback.
FromStreamInput(PullAudioInputStreamCallback, AudioStreamFormat, AudioProcessingOptions)	Creates an AudioConfig object that receives speech from a stream in a specified format using an audio input stream callback.
FromStreamOutput(AudioOutputStream)	Creates an AudioConfig object representing the specified stream. Added in 1.4.0
FromStreamOutput(PushAudioOutputStreamCallback)	Creates an AudioConfig object representing the specified stream. Added in 1.4.0
FromWavFileInput(String)	Creates an AudioConfig object that receives speech from an audio file in WAV format.
FromWavFileInput(String, AudioProcessingOptions)	Creates an AudioConfig object that receives speech from an audio file in WAV format.
FromWavFileOutput(String)	Creates an AudioConfig object that produces speech to the specified WAV file. Added in 1.4.0
GetProperty(PropertyId)	Searches for the property named with the given PropertyId value. Added in 1.10.0
GetProperty(String)	Searches for the property that has the given string name. Added in 1.10.0
SetProperty(PropertyId, String)	Sets a property using a PropertyId value. Added in 1.10.0
SetProperty(String, String)	Sets a property using a string name. Added in 1.10.0