AudioConfig class
Представляет конфигурацию входного звука, используемую для указания типа входных данных (микрофон, файл, поток).
Методы
close() | Явным образом освобождает любой внешний ресурс, подключенный к объекту |
from |
Создает объект AudioConfig, представляющий указанный выходной звуковой файл |
from |
Создает объект AudioConfig, представляющий микрофон по умолчанию в системе. |
from |
Создает объект AudioConfig, представляющий динамик по умолчанию. |
from |
Создает объект AudioConfig, представляющий микрофон с указанным идентификатором устройства. |
from |
Создает объект AudioConfig, представляющий пользовательский объект IPlayer. Объект IPlayer можно использовать для управления приостановкой, возобновлением и т. д. |
from |
Создает объект AudioConfig, представляющий указанный поток. |
from |
Создает объект AudioConfig, представляющий указанный поток вывода звука |
from |
Создает объект AudioConfig, представляющий указанный файл. |
get |
Возвращает текущее значение произвольного свойства. |
set |
Задает произвольное свойство. |
Сведения о методе
close()
Явным образом освобождает любой внешний ресурс, подключенный к объекту
function close()
fromAudioFileOutput(PathLike)
Создает объект AudioConfig, представляющий указанный выходной звуковой файл
static function fromAudioFileOutput(filename: PathLike): AudioConfig
Параметры
- filename
-
PathLike
Имя файла выходного звукового файла
Возвращаемое значение
Созданная конфигурация вывода звука. Добавлено в версию 1.11.0
fromDefaultMicrophoneInput()
Создает объект AudioConfig, представляющий микрофон по умолчанию в системе.
static function fromDefaultMicrophoneInput(): AudioConfig
Возвращаемое значение
Созданная конфигурация ввода звука.
fromDefaultSpeakerOutput()
Создает объект AudioConfig, представляющий динамик по умолчанию.
static function fromDefaultSpeakerOutput(): AudioConfig
Возвращаемое значение
Созданная конфигурация вывода звука. Добавлено в версию 1.11.0
fromMicrophoneInput(string)
Создает объект AudioConfig, представляющий микрофон с указанным идентификатором устройства.
static function fromMicrophoneInput(deviceId?: string): AudioConfig
Параметры
- deviceId
-
string
Указывает идентификатор устройства используемого микрофона. Используется микрофон по умолчанию, значение не указано.
Возвращаемое значение
Созданная конфигурация ввода звука.
fromSpeakerOutput(IPlayer)
Создает объект AudioConfig, представляющий пользовательский объект IPlayer. Объект IPlayer можно использовать для управления приостановкой, возобновлением и т. д.
static function fromSpeakerOutput(player?: IPlayer): AudioConfig
Параметры
- player
- IPlayer
Объект IPlayer для воспроизведения.
Возвращаемое значение
Созданная конфигурация вывода звука. Добавлено в версию 1.12.0
fromStreamInput(AudioInputStream | PullAudioInputStreamCallback | MediaStream)
Создает объект AudioConfig, представляющий указанный поток.
static function fromStreamInput(audioStream: AudioInputStream | PullAudioInputStreamCallback | MediaStream): AudioConfig
Параметры
- audioStream
-
AudioInputStream | PullAudioInputStreamCallback | MediaStream
Указывает пользовательский поток ввода звука. В настоящее время поддерживается только WAV/PCM.
Возвращаемое значение
Созданная конфигурация ввода звука.
fromStreamOutput(AudioOutputStream | PushAudioOutputStreamCallback)
Создает объект AudioConfig, представляющий указанный поток вывода звука
static function fromStreamOutput(audioStream: AudioOutputStream | PushAudioOutputStreamCallback): AudioConfig
Параметры
- audioStream
Задает пользовательский поток вывода звука.
Возвращаемое значение
Созданная конфигурация вывода звука. Добавлено в версию 1.11.0
fromWavFileInput(File | Buffer, string)
Создает объект AudioConfig, представляющий указанный файл.
static function fromWavFileInput(file: File | Buffer, name?: string): AudioConfig
Параметры
- file
-
File | Buffer
- name
-
string
Возвращаемое значение
Созданная конфигурация ввода звука.
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
Новое значение свойства.