Output

Defined in: core/output.ts:138

Constructors

Constructor

new Output(props?): Output

Defined in: core/output.ts:148

Parameters

props?

name

string

Returns

Output

Properties

_callback

static _callback: object = {}

Defined in: core/output.ts:139

---

_id

static _id: string

Defined in: core/output.ts:140

---

_localRecording

static _localRecording: boolean = false

Defined in: core/output.ts:145

---

_proxyCallback

static _proxyCallback: object = {}

Defined in: core/output.ts:143

---

_remoteCallback

static _remoteCallback: object = {}

Defined in: core/output.ts:142

Methods

getDisplayName()

getDisplayName(): Promise<string>

Defined in: core/output.ts:359

return: Promise

Gets the name of the Output as displayed in the Outputs menu.

Returns

Promise<string>

---

getName()

getName(): Promise<string>

Defined in: core/output.ts:348

return: Promise

Gets the actual name of the Output.

Returns

Promise<string>

---

pauseLocalRecording()

pauseLocalRecording(): Promise<boolean>

Defined in: core/output.ts:435

** For Deprecation, please use the static method instead

return: Promise

Pause a local recording.

Returns

Promise<boolean>

---

startBroadcast()

startBroadcast(optionBag?): Promise<boolean>

Defined in: core/output.ts:399

param: ([options]) – see below

return: Promise<boolean>

Start a broadcast of the provided channel.

Accepts an optional JSON object argument, which can be used to indicate certain flags, such as (additional options may be added):

• suppressPrestreamDialog : used to bypass the showing of the pre-stream dialog of the outputs supporting it, will use last settings provided
• outputTarget : optional 0-based target output index (0 … count-1) or 'all'. Count comes from host getProperty('viewoutputscount') and is not a fixed max of 2. 'all' fans out to each index; the host only receives numeric output=N (never output=all). Omit for legacy single-target / default behavior.

output.startBroadcast({ suppressPrestreamDialog: true });
output.startBroadcast({ suppressPrestreamDialog: true, outputTarget: 'all' });
output.startBroadcast({ outputTarget: '0' });

Parameters

optionBag?

BroadcastOptions

Returns

Promise<boolean>

---

stopBroadcast()

stopBroadcast(optionBag?): Promise<boolean>

Defined in: core/output.ts:424

param: ([options]) – see below

return: Promise<boolean>

Stop a broadcast of the provided channel.

Accepts an optional JSON object argument:

• outputTarget : optional 0-based target output index (0 … count-1) or 'all'. Count comes from host getProperty('viewoutputscount') and is not a fixed max of 2. 'all' fans out to each index; the host only receives numeric output=N (never output=all). Omit for legacy single-target / default behavior.

Parameters

optionBag?

OutputTargetOptions

Returns

Promise<boolean>

---

unpauseLocalRecording()

unpauseLocalRecording(): Promise<boolean>

Defined in: core/output.ts:466

** For Deprecation, please use the static method instead

return: Promise

Unpause a local recording.

Returns

Promise<boolean>

---

_finalCallback()

static _finalCallback(message): Promise<unknown>

Defined in: core/output.ts:554

Parameters

message

string

Returns

Promise<unknown>

---

_getBroadcastChannels()

static _getBroadcastChannels(id, …args): Promise<unknown>

Defined in: core/output.ts:490

Parameters

id

string

args

…any[]

Returns

Promise<unknown>

---

getOutputList()

static getOutputList(): Promise<Output[]>

Defined in: core/output.ts:182

param: (id: string)

return Promise<Output[]>

Fetch all available Outputs you can broadcast on based on your installed Broadcast plugin.

Basic Usage

var xjs = require('xjs');

xjs.Output.getOutputList()
.then(function(outputs) {
  outputs.map(output => {
   output.getName()
   .then(function(name) {
     if(name.includes('Twitch')) {
       output.startBroadcast({
         suppressPrestreamDialog : true
       });
     }
   })
 })
})

Returns

Promise<Output[]>

---

pauseLocalRecording()

static pauseLocalRecording(optionBag?): Promise<boolean>

Defined in: core/output.ts:320

param: ([options]) – see below

return: Promise<boolean>

Pause a local recording.

Accepts an optional JSON object argument:

• outputTarget : optional 0-based target output index (0 … count-1) or 'all'. Count comes from host getProperty('viewoutputscount') and is not a fixed max of 2. 'all' fans out to each index; the host only receives numeric output=N (never output=all). Omit for legacy single-target / default behavior.

Parameters

optionBag?

OutputTargetOptions

Returns

Promise<boolean>

---

setSceneToRecord()

static setSceneToRecord(scene): Promise<boolean>

Defined in: core/output.ts:234

param: scene<number|Scene>

return: Promise<boolean>

Sets a scene to record. Set to live scene or blank string to reset

Parameters

scene

any

Returns

Promise<boolean>

---

startLocalRecording()

static startLocalRecording(optionBag?): Promise<boolean>

Defined in: core/output.ts:277

param: ([options]) – see below

return: Promise<boolean>

Start a local recording.

Accepts an optional JSON object argument:

• outputTarget : optional 0-based target output index (0 … count-1) or 'all'. Count comes from host getProperty('viewoutputscount') and is not a fixed max of 2. 'all' fans out to each index; the host only receives numeric output=N (never output=all). Omit for legacy single-target / default behavior.

Parameters

optionBag?

OutputTargetOptions

Returns

Promise<boolean>

---

stopLocalRecording()

static stopLocalRecording(optionBag?): Promise<boolean>

Defined in: core/output.ts:301

param: ([options]) – see below

return: Promise<boolean>

Stop a local recording.

Accepts an optional JSON object argument:

• outputTarget : optional 0-based target output index (0 … count-1) or 'all'. Count comes from host getProperty('viewoutputscount') and is not a fixed max of 2. 'all' fans out to each index; the host only receives numeric output=N (never output=all). Omit for legacy single-target / default behavior.

Parameters

optionBag?

OutputTargetOptions

Returns

Promise<boolean>

---

unpauseLocalRecording()

static unpauseLocalRecording(optionBag?): Promise<boolean>

Defined in: core/output.ts:339

param: ([options]) – see below

return: Promise<boolean>

Unpause a local recording.

Accepts an optional JSON object argument:

• outputTarget : optional 0-based target output index (0 … count-1) or 'all'. Count comes from host getProperty('viewoutputscount') and is not a fixed max of 2. 'all' fans out to each index; the host only receives numeric output=N (never output=all). Omit for legacy single-target / default behavior.

Parameters

optionBag?

OutputTargetOptions

Returns

Promise<boolean>