你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

AudioConfig class

包:

microsoft-cognitiveservices-speech-sdk

表示用于指定要使用哪种类型的输入 (麦克风、文件、流) 的音频输入配置。

方法

close()	显式释放附加到对象的任何外部资源
fromAudioFileOutput(PathLike)	创建表示指定输出音频文件的 AudioConfig 对象
fromDefaultMicrophoneInput()	创建一个 AudioConfig 对象，该对象表示系统上的默认麦克风。
fromDefaultSpeakerOutput()	创建一个代表默认扬声器的 AudioConfig 对象。
fromMicrophoneInput(string)	创建一个 AudioConfig 对象，该对象表示具有指定设备 ID 的麦克风。
fromSpeakerOutput(IPlayer)	创建表示自定义 IPlayer 对象的 AudioConfig 对象。 可以使用 IPlayer 对象来控制暂停、恢复等。
fromStreamInput(AudioInputStream | PullAudioInputStreamCallback | MediaStream)	创建表示指定流的 AudioConfig 对象。
fromStreamOutput(AudioOutputStream | PushAudioOutputStreamCallback)	创建表示指定音频输出流的 AudioConfig 对象
fromWavFileInput(File | Buffer, string)	创建表示指定文件的 AudioConfig 对象。
getProperty(string, string)	返回任意属性的当前值。
setProperty(string, string)	设置任意属性。

方法详细信息

close()

显式释放附加到对象的任何外部资源

function close()

fromAudioFileOutput(PathLike)

创建表示指定输出音频文件的 AudioConfig 对象

static function fromAudioFileOutput(filename: PathLike): AudioConfig

参数

filename

PathLike

输出音频文件的文件名

返回

AudioConfig

正在创建的音频输出配置。 在版本 1.11.0 中添加

fromDefaultMicrophoneInput()

创建一个 AudioConfig 对象，该对象表示系统上的默认麦克风。

static function fromDefaultMicrophoneInput(): AudioConfig

返回

AudioConfig

正在创建的音频输入配置。

fromDefaultSpeakerOutput()

创建一个代表默认扬声器的 AudioConfig 对象。

static function fromDefaultSpeakerOutput(): AudioConfig

返回

AudioConfig

正在创建的音频输出配置。 在版本 1.11.0 中添加

fromMicrophoneInput(string)

创建一个 AudioConfig 对象，该对象表示具有指定设备 ID 的麦克风。

static function fromMicrophoneInput(deviceId?: string): AudioConfig

参数

deviceId

string

指定要使用的麦克风的设备 ID。 使用默认麦克风 省略值。

返回

AudioConfig

正在创建的音频输入配置。

fromSpeakerOutput(IPlayer)

创建表示自定义 IPlayer 对象的 AudioConfig 对象。 可以使用 IPlayer 对象来控制暂停、恢复等。

static function fromSpeakerOutput(player?: IPlayer): AudioConfig

参数

player

IPlayer

用于播放的 IPlayer 对象。

返回

AudioConfig

正在创建的音频输出配置。 在版本 1.12.0 中添加

fromStreamInput(AudioInputStream | PullAudioInputStreamCallback | MediaStream)

创建表示指定流的 AudioConfig 对象。

static function fromStreamInput(audioStream: AudioInputStream | PullAudioInputStreamCallback | MediaStream): AudioConfig

参数

audioStream

AudioInputStream | PullAudioInputStreamCallback | MediaStream

指定自定义音频输入流。 目前仅支持 WAV/PCM。

返回

AudioConfig

正在创建的音频输入配置。

fromStreamOutput(AudioOutputStream | PushAudioOutputStreamCallback)

创建表示指定音频输出流的 AudioConfig 对象

static function fromStreamOutput(audioStream: AudioOutputStream | PushAudioOutputStreamCallback): AudioConfig

参数

audioStream

AudioOutputStream | PushAudioOutputStreamCallback

指定自定义音频输出流。

返回

AudioConfig

正在创建的音频输出配置。 在版本 1.11.0 中添加

fromWavFileInput(File | Buffer, string)

创建表示指定文件的 AudioConfig 对象。

static function fromWavFileInput(file: File | Buffer, name?: string): AudioConfig

参数

file

File | Buffer

name

string

返回

AudioConfig

正在创建的音频输入配置。

getProperty(string, string)

返回任意属性的当前值。

function getProperty(name: string, def?: string): string

参数

name

string

要查询的属性的名称。

def

string

属性未知时要返回的值。

返回

string

给定属性的当前值或提供的默认值。

setProperty(string, string)

设置任意属性。

function setProperty(name: string, value: string)

参数

name

string

要设置的属性的名称。

value

string

属性的新值。