App

Defined in: core/app.ts:100

The App Class provides you methods to get and set application-related functionalities.

Basic Usage

var xjs = require('xjs');
var App = new xjs.App();

App.getFrameTime().then(function(frametime) {
  window.frametime = frametime;
});

For methods referring to application audio (i.e. mic and speaker settings, silence detection, etc.). This will affect XBC settings but will not be reflected in the General Settings Window (also will not be persistent after logging out of/exiting the application).

Constructors

Constructor

new App(): App

Returns

App

Methods

clearBrowserCookies()

clearBrowserCookies(cookiePath): Promise<boolean>

Defined in: core/app.ts:1459

return: Promise

Clears all cookies across all browser instances. Not available to source plugins (call this from the source properties window instead.)

Usage

App.clearBrowserCookies().then(function(val) {
 var isCleared = val;
});

Parameters

cookiePath

string

Returns

Promise<boolean>

---

enableNoiseSuppression()

enableNoiseSuppression(enabled): Promise<boolean>

Defined in: core/app.ts:1252

param: enabled

return: Promise<boolean>

Enables or disables noise suppression

Usage

App.enableNoiseSuppression(enabled).then(function(val) {
  var isSet = val;
});

Parameters

enabled

boolean

Returns

Promise<boolean>

---

enableSilenceDetection()

enableSilenceDetection(enabled): Promise<boolean>

Defined in: core/app.ts:978

param: enabled

return: Promise<boolean>

Enables or disables silence detection

Usage

App.enableSilenceDetection(enabled).then(function(val) {
  var isSet = val;
});

Parameters

enabled

boolean

Returns

Promise<boolean>

---

getFramesRendered()

getFramesRendered(): Promise<number>

Defined in: core/app.ts:215

return: Promise

Gets the total number of frames rendered

Usage

App.getFramesRendered().then(function(res) {
  var framesrendered = res;
});

Returns

Promise<number>

---

getFrametime()

getFrametime(): Promise<number>

Defined in: core/app.ts:125

Compatibility alias for older examples and functional tests.

Returns

Promise<number>

---

getFrameTime()

getFrameTime(): Promise<number>

Defined in: core/app.ts:114

return: Promise

Gets application’s frame time (duration per frame in 100ns unit)

Usage

App.getFrameTime().then(function(res) {
  var frameTime = res;
});

Returns

Promise<number>

---

getPrimaryMic()

getPrimaryMic(): Promise<AudioDevice>

Defined in: core/app.ts:240

return: Promise

Gets the primary microphone device used in the application

See also: #system/AudioDevice System/AudioDevice

Usage

App.getPrimaryMic().then(function(audioDevice) {
  var primaryMic = audioDevice;
});

Returns

Promise<AudioDevice>

---

getPrimarySpeaker()

getPrimarySpeaker(): Promise<AudioDevice>

Defined in: core/app.ts:278

return: Promise

Gets the primary speaker/audio render device used in the application

See also: #system/AudioDevice System/AudioDevice

Usage

App.getPrimarySpeaker().then(function(audioDevice) {
  var primarySpeaker = audioDevice;
});

Returns

Promise<AudioDevice>

---

getResolution()

getResolution(): Promise<Rectangle>

Defined in: core/app.ts:145

return: Promise

Gets application default output resolution in pixels.

See also: #util/Rectangle Util/Rectangle

Usage

App.getResolution().then(function(res) {
  var height = res.getHeight();
  var width = res.getWidth();
});

Returns

Promise<Rectangle>

---

getSilenceDetectionPeriod()

getSilenceDetectionPeriod(): Promise<number>

Defined in: core/app.ts:1013

return: Promise

Gets silence detection period, the length of time after voice detection before silence is again detected

Usage

App.getSilenceDetectionPeriod().then(function(val) {
  var silenceDetectionPeriod = val;
});

Returns

Promise<number>

---

getSilenceDetectionThreshold()

getSilenceDetectionThreshold(): Promise<number>

Defined in: core/app.ts:1111

return: Promise

Gets silence detection threshold/silence amplitude

Usage

App.getSilenceDetectionThreshold().then(function(val) {
  var silenceDetectionTfhreshold = val;
});

Returns

Promise<number>

---

getTransition()

getTransition(): Promise<Transition>

Defined in: core/app.ts:1286

return: Promise

Gets the transition for scene changes

See also: #core/Transition Core/Transition

Usage

App.getTransition().then(function(res) {
  var transitionid = res;
});

Returns

Promise<Transition>

---

getTransitionTime()

getTransitionTime(): Promise<number>

Defined in: core/app.ts:1368

return: Promise

Gets the scene transition duration in milliseconds

Usage

App.getTransitionTime().then(function(res) {
  var transitiontime = res;
});

Returns

Promise<number>

---

getTransitionVolume()

getTransitionVolume(): Promise<number>

Defined in: core/app.ts:1413

return: Promise

Gets the scene transition volume

Usage

App.getTransitionVolume().then(function(res) {
  var transitionVolume = res;
});

Returns

Promise<number>

---

getUserIdHash()

getUserIdHash(): Promise<string>

Defined in: core/app.ts:1483

return: Promise

Returns a hashed string that may be used to differentiate among logged-in users. This will be useful in such cases as persisting data to be used by certain XSplit users only.

Returns

Promise<string>

---

getVersion()

getVersion(): Promise<string>

Defined in: core/app.ts:192

return: Promise

Refers to XSplit Broadcaster version number

Usage

App.getVersion().then(function(res) {
  var version = res;
});

Returns

Promise<string>

---

getViewport()

getViewport(): Promise<Rectangle>

Defined in: core/app.ts:170

return: Promise

Gets application viewport display resolution

See also: #util/Rectangle Util/Rectangle

Usage

App.getViewport().then(function(res) {
  var height = res.getHeight();
  var width = res.getWidth();
});

Returns

Promise<Rectangle>

---

isNoiseSuppressionEnabled()

isNoiseSuppressionEnabled(): Promise<boolean>

Defined in: core/app.ts:1208

return: Promise

Gets whether noise suppression is enabled

Usage

App.isNoiseSuppressionEnabled().then(function(val) {
  var isEnabled = val;
});

Returns

Promise<boolean>

---

isSilenceDetectionEnabled()

isSilenceDetectionEnabled(): Promise<boolean>

Defined in: core/app.ts:935

return: Promise

Gets whether silence detection is enabled

Usage

App.isSilenceDetectionEnabled().then(function(val) {
  var isEnabled = val;
});

Returns

Promise<boolean>

---

setPrimaryMicDelay()

setPrimaryMicDelay(delay): Promise<boolean>

Defined in: core/app.ts:565

param: delay (100 nanoseconds in units)

return: Promise<boolean>

Sets the loopback capture delay of the primary microphone set

Usage

App.setPrimaryMicDelay(delay).then(function(val) {
  var isSet = val;
});

Parameters

delay

number

Returns

Promise<boolean>

---

setPrimaryMicEnabled()

setPrimaryMicEnabled(enabled): Promise<boolean>

Defined in: core/app.ts:383

param: enabled

return: Promise<boolean>

Sets whether the primary microphone set is enabled or disabled in the applicaation

Usage

App.setPrimaryMicEnabled(enabled).then(function(val) {
  var isSet = val;
});

Parameters

enabled

boolean

Returns

Promise<boolean>

---

setPrimaryMicLevel()

setPrimaryMicLevel(volume): Promise<boolean>

Defined in: core/app.ts:318

param: volume (0 to 100 normal range, > 100 will boost volume level)

return: Promise<boolean>

Sets the application audio level of the primary microphone set

Usage

App.setPrimaryMicLevel(volume).then(function(val) {
  var isSet = val;
});

Parameters

volume

number

Returns

Promise<boolean>

---

setPrimaryMicSystemEnabled()

setPrimaryMicSystemEnabled(hwenabled): Promise<boolean>

Defined in: core/app.ts:502

param: hwenabled (0 or 1, or set to 255 to avoid mute change)

return: Promise<boolean>

Sets whether the primary microphone set is enabled or disabled in the system

Usage

App.setPrimaryMicSystemEnabled(enabled).then(function(val) {
  var isSet = val;
});

Parameters

hwenabled

number

Returns

Promise<boolean>

---

setPrimaryMicSystemLevel()

setPrimaryMicSystemLevel(volume): Promise<boolean>

Defined in: core/app.ts:443

param: volume (0 to 100)

return: Promise<boolean>

Sets the system audio level of the primary microphone set

Usage

App.setPrimaryMicSystemLevel(volume).then(function(val) {
  var isSet = val;
});

Parameters

volume

number

Returns

Promise<boolean>

---

setPrimarySpeakerDelay()

setPrimarySpeakerDelay(delay): Promise<boolean>

Defined in: core/app.ts:875

param: delay (100 nanoseconds in units)

return: Promise<boolean>

Sets the loopback capture delay of the primary speaker/audio render device

Usage

App.setPrimarySpeakerDelay(delay).then(function(val) {
  var isSet = val;
});

Parameters

delay

number

Returns

Promise<boolean>

---

setPrimarySpeakerEnabled()

setPrimarySpeakerEnabled(enabled): Promise<boolean>

Defined in: core/app.ts:693

param: enabled

return: Promise<boolean>

Sets whether the primary speaker/audio render device set is enabled or disabled in the applicaation

Usage

App.setPrimarySpeakerEnabled(enabled).then(function(val) {
  var isSet = val;
});

Parameters

enabled

boolean

Returns

Promise<boolean>

---

setPrimarySpeakerLevel()

setPrimarySpeakerLevel(volume): Promise<boolean>

Defined in: core/app.ts:628

param: volume (0 to 100 normal range, > 100 will boost volume level)

return: Promise<boolean>

Sets the application audio level of the primary speaker/audio render device

Usage

App.setPrimarySpeakerLevel(volume).then(function(val) {
  var isSet = val;
});

Parameters

volume

number

Returns

Promise<boolean>

---

setPrimarySpeakerSystemEnabled()

setPrimarySpeakerSystemEnabled(hwenabled): Promise<boolean>

Defined in: core/app.ts:812

param: hwenabled (0 or 1, or set to 255 to avoid mute change)

return: Promise<boolean>

Sets whether the primary speaker/audio render device set is enabled or disabled in the system

Usage

App.setPrimarySpeakerSystemEnabled(enabled).then(function(val) {
  var isSet = val;
});

Parameters

hwenabled

number

Returns

Promise<boolean>

---

setPrimarySpeakerSystemLevel()

setPrimarySpeakerSystemLevel(volume): Promise<boolean>

Defined in: core/app.ts:753

param: volume (0 to 100)

return: Promise<boolean>

Sets the system audio level of the primary speaker/audio render device set

Usage

App.setPrimarySpeakerSystemLevel(volume).then(function(val) {
  var isSet = val;
});

Parameters

volume

number

Returns

Promise<boolean>

---

setSilenceDetectionPeriod()

setSilenceDetectionPeriod(sdPeriod): Promise<boolean>

Defined in: core/app.ts:1065

param: sdPeriod

return: Promise<boolean>

Sets silence detection period (0-60000 ms), the length of time after voice detection before silence is again detected

Usage

App.setSilenceDetectionPeriod(sdPeriod).then(function(val) {
  var isSet = val;
});

Parameters

sdPeriod

number

Returns

Promise<boolean>

---

setSilenceDetectionThreshold()

setSilenceDetectionThreshold(sdThreshold): Promise<boolean>

Defined in: core/app.ts:1162

param: sdThreshold

return: Promise<boolean>

Sets silence detection threshold/silence amplitude (values from 0-128)

Usage

App.setSilenceDetectionThreshold(sdThreshold).then(function(val) {
  var isSet = val;
});

Parameters

sdThreshold

number

Returns

Promise<boolean>

---

setTransition()

setTransition(transition): Promise<boolean>

Defined in: core/app.ts:1347

param: transition

return: Promise<boolean>

Sets the transition for scene changes

See also: #core/Transition Core/Transition

Usage

var xjs = require('xjs'),
    Transition = xjs.Transition,
    App = new xjs.App();

App.setTransition(Transition.CLOCK).then(function(val) {
 var isSet = val;
});

Parameters

transition

Transition

Returns

Promise<boolean>

---

setTransitionTime()

setTransitionTime(time): Promise<boolean>

Defined in: core/app.ts:1392

param: time

return: Promise<boolean>

Sets the scene transition duration in milliseconds

Usage

App.setTransitionTime(time).then(function(val) {
 var isSet = val;
});

Parameters

time

number

Returns

Promise<boolean>

---

setTransitionVolume()

setTransitionVolume(volume): Promise<boolean>

Defined in: core/app.ts:1437

param: volume

return: Promise<boolean>

Sets the scene transition volume

Usage

App.setTransitionVolume(volume).then(function(val) {
 var isSet = val;
});

Parameters

volume

number

Returns

Promise<boolean>