MicrophoneDevice

Defined in: system/microphone.ts:27

The MicrophoneDevice class provides you with methods to add a microphone device as a source on the stage.

Basic Usage

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

System.getMicrophones().then(function(microphones) {
 for (var i in microphones) {
   microphones[i].addToScene();
 }
});

Implements

• Addable

Constructors

Constructor

new MicrophoneDevice(): MicrophoneDevice

Returns

MicrophoneDevice

Methods

addToScene()

addToScene(value?): Promise<any>

Defined in: system/microphone.ts:115

param: (value?: number | Scene)

return: Promise<any>

Adds this microphone device to the current scene by default. Accepts an optional parameter value, which, when supplied, points to the scene where item will be added instead. If ready config {listenToItemAdd: true} it returns item id, else returns boolean.

Note: There is yet no way to detect error responses for this action.

Parameters

value?

number | Scene

Returns

Promise<any>

Implementation of

Addable.addToScene

---

getDisplayId()

getDisplayId(): string

Defined in: system/microphone.ts:59

return: string

Gets the display ID

Usage

var micDisplayId = device.getDisplayId();

Returns

string

---

getName()

getName(): string

Defined in: system/microphone.ts:74

return: string

Gets the device name

Usage

var micName = device.getName();

Returns

string

---

toXML()

toXML(): XML

Defined in: system/microphone.ts:89

return: XML

Converts Microphone object into an XML object

Usage

var microphoneXML = microphone.toXML();

Returns

XML

---

parse()

static parse(jxon): MicrophoneDevice

Defined in: system/microphone.ts:39

param: (deviceJXON: JXON)

return MicrophoneDevice

Create a MicrophoneDevice onject based on a JXON object

Parameters

jxon

JSON

Returns

MicrophoneDevice