AudioConfig class

Пакет:

microsoft-cognitiveservices-speech-sdk

Представляет конфигурацию аудиовхода, используемую для указания типа входных данных (микрофон, файл, поток).

Методы

close()	Явным образом освобождает любой внешний ресурс, присоединенный к объекту
fromAudioFileOutput(PathLike)	Создает объект AudioConfig, представляющий указанный выходной звуковой файл.
fromDefaultMicrophoneInput()	Создает объект AudioConfig, представляющий микрофон по умолчанию в системе.
fromDefaultSpeakerOutput()	Создает объект AudioConfig, представляющий динамик по умолчанию.
fromMicrophoneInput(string)	Создает объект AudioConfig, представляющий микрофон с указанным идентификатором устройства.
fromSpeakerOutput(IPlayer)	Создает объект AudioConfig, представляющий пользовательский объект IPlayer. Объект 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, представляющий микрофон с указанным идентификатором устройства.

static function fromMicrophoneInput(deviceId?: string): AudioConfig

Параметры

deviceId

string

Указывает идентификатор устройства используемого микрофона. Используется микрофон по умолчанию, значение опущено.

Возвращаемое значение

AudioConfig

Создаваемая конфигурация входных аудиоданных.

fromSpeakerOutput(IPlayer)

Создает объект AudioConfig, представляющий пользовательский объект IPlayer. Объект 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

Новое значение свойства.