AudioDevice

Defined in: system/audio.ts:33

The AudioDevice Class is the object returned by #system/System System Class getAudioDevices method. It provides you with methods to fetch the audio device object’s attributes, and also provides methods to convert it back to an XML object that is compatible with XBC.

If you are looking to add a microphone device to the stage, please see #system/MicrophoneDevice System/MicrophoneDevice instead.

Basic Usage

var XJS = require('xjs');
var System = XJS.System;

System.getAudioDevices().then(function(audios) {
  for (var i in audios) {
    // Do not include the imaginary xsplit audio device if that ever exist
    if (audios[i].getName().indexOf('xsplit') === -1) {
      xml = audios[i].toXML();
      // do something with the XML here
    }
  }
});

Constructors

Constructor

new AudioDevice(props?): AudioDevice

Defined in: system/audio.ts:59

Parameters

props?

Returns

AudioDevice

Properties

SYSTEM_LEVEL_ENABLE

static SYSTEM_LEVEL_ENABLE: number = 1

Defined in: system/audio.ts:35

---

SYSTEM_LEVEL_MUTE

static SYSTEM_LEVEL_MUTE: number = 0

Defined in: system/audio.ts:34

---

SYSTEM_MUTE_CHANGE_NOT_ALLOWED

static SYSTEM_MUTE_CHANGE_NOT_ALLOWED: number = 255

Defined in: system/audio.ts:36

Methods

_setDelay()

_setDelay(delay): AudioDevice

Defined in: system/audio.ts:314

param: delay (100 nanoseconds in units)

return: AudioDevice (used for chaining)

Sets the loopback capture delay value

Usage

audioDevice._setDelay(100);

Parameters

delay

number

Returns

AudioDevice

---

_setEnabled()

_setEnabled(enabled): AudioDevice

Defined in: system/audio.ts:205

param: enabled

return: AudioDevice (used for chaining)

Enables audio device/sets software mute

Usage

audioDevice._setEnabled(true);

Parameters

enabled

boolean

Returns

AudioDevice

---

_setLevel()

_setLevel(level): AudioDevice

Defined in: system/audio.ts:170

param: level

return: AudioDevice (used for chaining)

Sets the device audio level in the application

Usage

audioDevice._setLevel(100);

Parameters

level

number

Returns

AudioDevice

---

_setSystemEnabled()

_setSystemEnabled(hwenabled): AudioDevice

Defined in: system/audio.ts:279

param: systemEnabled

return: AudioDevice (used for chaining)

Enables audio device/sets software mute

Usage

// you may use the following:
//     * AudioDevice.SYSTEM_LEVEL_MUTE (0)
//     * AudioDevice.SYSTEM_LEVEL_ENABLE (1)
//     * AudioDevice.SYSTEM_MUTE_CHANGE_NOT_ALLOWED (255)
audioDevice._setSystemEnabled(AudioDevice.SYSTEM_LEVEL_MUTE);

Parameters

hwenabled

number

Returns

AudioDevice

---

_setSystemLevel()

_setSystemLevel(hwlevel): AudioDevice

Defined in: system/audio.ts:240

param: volume

return: AudioDevice (used for chaining)

Sets the device system volume

Usage

audioDevice._setSystemLevel(100);

Parameters

hwlevel

number

Returns

AudioDevice

---

getDataFlow()

getDataFlow(): string

Defined in: system/audio.ts:122

return: string

Gets whether device is capturing or rendering audio

Usage

var audioDataFlow = device.getDataFlow();
  //where possible values are 'Render' or 'Capture'

Returns

string

---

getDelay()

getDelay(): number

Defined in: system/audio.ts:296

return: number (100 nanoseconds in units)

Get the loopback capture delay value

Usage

var audioDelay = audioDevice.getDelay();

Returns

number

---

getId()

getId(): string

Defined in: system/audio.ts:91

return: string

Gets the device ID

Usage

var audioDeviceID = device.getId();

Returns

string

---

getLevel()

getLevel(): number

Defined in: system/audio.ts:152

return: number

Gets the device audio level in the application

Usage

var audioDeviceVolumeLevel = audioDevice.getLevel();

Returns

number

---

getName()

getName(): string

Defined in: system/audio.ts:106

return: string

Gets the device name

Usage

var audioDeviceName = device.getName();

Returns

string

---

getSystemEnabled()

getSystemEnabled(): number

Defined in: system/audio.ts:257

return: number

Gets whether audio device is enabled/muted in the system

Usage

var systemAudioDeviceEnabled = audioDevice.getSystemEnabled();

Returns

number

---

getSystemLevel()

getSystemLevel(): number

Defined in: system/audio.ts:222

return: number

Gets the device system volume

Usage

var systemVolumeLevel = audioDevice.getSystemLevel();

Returns

number

---

isDefaultDevice()

isDefaultDevice(): boolean

Defined in: system/audio.ts:137

return: boolean

Gets whether audio device is the system default

Usage

var audioIsDefaultDevice = audioDevice.isDefaultDevice();

Returns

boolean

---

isEnabled()

isEnabled(): boolean

Defined in: system/audio.ts:187

return: boolean

Gets whether the audio device is enabled/not

Usage

var isAudioDeviceEnabled = audioDevice.isEnabled();

Returns

boolean

---

toString()

toString(): string

Defined in: system/audio.ts:331

return: string

Converts the AudioDevice object to XML-formatted string

Usage

var audioDeviceXMLString = AudioDevice.toString();

Returns

string

---

parse()

static parse(deviceJXON): AudioDevice

Defined in: system/audio.ts:360

param: deviceJXON

return: AudioDevice

Converts a JSON object into an AudioDevice object

Usage

var newAudioDevice = AudioDevice.parse(deviceJSONObj);

Parameters

deviceJXON

JSON

Returns

AudioDevice