AudioConfig class
Představuje konfiguraci zvukového vstupu, která se používá k určení typu vstupu, který se má použít (mikrofon, soubor, datový proud).
Metody
close() | Explicitně uvolní všechny externí prostředky připojené k objektu. |
from |
Vytvoří objekt AudioConfig představující zadaný výstupní zvukový soubor. |
from |
Vytvoří objekt AudioConfig představující výchozí mikrofon v systému. |
from |
Vytvoří objekt AudioConfig představující výchozí reproduktor. |
from |
Vytvoří objekt AudioConfig představující mikrofon se zadaným ID zařízení. |
from |
Vytvoří AudioConfig objekt představující vlastní objekt IPlayer. Objekt IPlayer můžete použít k ovládání pozastavení, obnovení atd. |
from |
Vytvoří AudioConfig objekt představující zadaný datový proud. |
from |
Vytvoří objekt AudioConfig představující zadaný výstupní zvukový stream. |
from |
Vytvoří AudioConfig objekt představující zadaný soubor. |
get |
Vrátí aktuální hodnotu libovolné vlastnosti. |
set |
Nastaví libovolnou vlastnost. |
Podrobnosti metody
close()
Explicitně uvolní všechny externí prostředky připojené k objektu.
function close()
fromAudioFileOutput(PathLike)
Vytvoří objekt AudioConfig představující zadaný výstupní zvukový soubor.
static function fromAudioFileOutput(filename: PathLike): AudioConfig
Parametry
- filename
-
PathLike
název souboru výstupního zvukového souboru
Návraty
Konfigurace zvukového výstupu, která se vytváří. Přidáno ve verzi 1.11.0
fromDefaultMicrophoneInput()
Vytvoří objekt AudioConfig představující výchozí mikrofon v systému.
static function fromDefaultMicrophoneInput(): AudioConfig
Návraty
Konfigurace zvukového vstupu, která se vytváří.
fromDefaultSpeakerOutput()
Vytvoří objekt AudioConfig představující výchozí reproduktor.
static function fromDefaultSpeakerOutput(): AudioConfig
Návraty
Konfigurace zvukového výstupu, která se vytváří. Přidáno ve verzi 1.11.0
fromMicrophoneInput(string)
Vytvoří objekt AudioConfig představující mikrofon se zadaným ID zařízení.
static function fromMicrophoneInput(deviceId?: string): AudioConfig
Parametry
- deviceId
-
string
Určuje ID zařízení mikrofonu, který se má použít. Použije se výchozí mikrofon a hodnota se vynechá.
Návraty
Konfigurace zvukového vstupu, která se vytváří.
fromSpeakerOutput(IPlayer)
Vytvoří AudioConfig objekt představující vlastní objekt IPlayer. Objekt IPlayer můžete použít k ovládání pozastavení, obnovení atd.
static function fromSpeakerOutput(player?: IPlayer): AudioConfig
Parametry
- player
- IPlayer
objekt IPlayer pro přehrávání.
Návraty
Konfigurace zvukového výstupu, která se vytváří. Přidáno ve verzi 1.12.0
fromStreamInput(AudioInputStream | PullAudioInputStreamCallback | MediaStream)
Vytvoří AudioConfig objekt představující zadaný datový proud.
static function fromStreamInput(audioStream: AudioInputStream | PullAudioInputStreamCallback | MediaStream): AudioConfig
Parametry
- audioStream
-
AudioInputStream | PullAudioInputStreamCallback | MediaStream
Určuje vlastní stream zvukového vstupu. V současné době se podporuje pouze WAV/PCM.
Návraty
Konfigurace zvukového vstupu, která se vytváří.
fromStreamOutput(AudioOutputStream | PushAudioOutputStreamCallback)
Vytvoří objekt AudioConfig představující zadaný výstupní zvukový stream.
static function fromStreamOutput(audioStream: AudioOutputStream | PushAudioOutputStreamCallback): AudioConfig
Parametry
- audioStream
Určuje vlastní zvukový výstupní stream.
Návraty
Konfigurace zvukového výstupu, která se vytváří. Přidáno ve verzi 1.11.0
fromWavFileInput(File | Buffer, string)
Vytvoří AudioConfig objekt představující zadaný soubor.
static function fromWavFileInput(file: File | Buffer, name?: string): AudioConfig
Parametry
- file
-
File | Buffer
- name
-
string
Návraty
Konfigurace zvukového vstupu, která se vytváří.
getProperty(string, string)
Vrátí aktuální hodnotu libovolné vlastnosti.
function getProperty(name: string, def?: string): string
Parametry
- name
-
string
Název vlastnosti, která se má dotazovat.
- def
-
string
Hodnota, která se má vrátit v případě, že vlastnost není známa.
Návraty
string
Aktuální nebo zadaná výchozí hodnota dané vlastnosti.
setProperty(string, string)
Nastaví libovolnou vlastnost.
function setProperty(name: string, value: string)
Parametry
- name
-
string
Název vlastnosti, kterou chcete nastavit.
- value
-
string
Nová hodnota vlastnosti.