ExtensionWindow

Defined in: window/extension.ts:42

This utility class represents the extension window. It allows manipulation of the window (e.g., resizing), and also serves as an event emitter for all events that the window should be able to handle.

Currently, the following events are available:

scene-load: notifies in the event of a scene change. Handler is a function f(sceneNumber: number). For Split Mode scene-load listens to the changes on the preview window.
sources-list-highlight: notifies when a user hovers over a source in the stage, returning its source id, or when the mouse moves out of a source bounding box, returning null. Source id is also returned when hovering over the bottom panel. Handler is a function f(id: string)
sources-list-select: notifies when a user clicks a source in the stage. Source id is also returned when source is selected from the bottom panel. Handler is a function f(id: string)
sources-list-update: notifies when there are changes on list sources whether on stage or bottom panel. Handler is a function(ids: string) where ids are comma separated source ids.
scene-delete : notifies when a scene is deleted. Handler is a function f(index: number, uid: string). Works only on version 2.8.1606.1601 or higher.
scene-add : notifies when a scene is added. Handler is a function f(index: number, uid: string). Works only on version 2.8.1606.1701 or higher.
scene-delete-all : notifies all scenes are deleted. Handler is a function f(type: newpres/loadpres). Works only on version 3.3.1801.1901 or higher.
bscn-load : notifies when user loads a scene file via XBC, File menu > Load Scene…
push-to-live : notifies when a particular scene was pushed to live by user. Handler is a function f(sceneIndex: number).

Use the on(event: string, handler: Function) function to listen to an event.

Extends

EventEmitter

Constructors

Constructor

new ExtensionWindow(): ExtensionWindow

Defined in: window/extension.ts:65

** For Deprecation

Use getInstance()

Returns

ExtensionWindow

Overrides

EventEmitter.constructor

Properties

_encounteredFirstSceneChange

static _encounteredFirstSceneChange: boolean = false

Defined in: window/extension.ts:45

_proxyHandlers

static _proxyHandlers: object = {}

Defined in: util/eventemitter.ts:7

Inherited from

EventEmitter._proxyHandlers

_remoteHandlers

static _remoteHandlers: object = {}

Defined in: util/eventemitter.ts:6

Inherited from

EventEmitter._remoteHandlers

_subscriptions

static _subscriptions: string[] = []

Defined in: window/extension.ts:44

_value

static _value: string

Defined in: window/extension.ts:336

Methods

close()

close(): void

Defined in: window/extension.ts:403

** For deprecation, please use the static method instead

Returns

void

disableClose()

disableClose(): void

Defined in: window/extension.ts:417

** For deprecation, please use the static method instead

Returns

void

emit()

emit(event, …params): void

Defined in: util/eventemitter.ts:66

This function lets an event trigger with any number of supplied parameters.

Parameters

event

string

params

…any[]

Returns

void

Inherited from

EventEmitter.emit

enableClose()

enableClose(): void

Defined in: window/extension.ts:431

** For deprecation, please use the static method instead

Returns

void

off()

off(event, handler): void

Defined in: util/eventemitter.ts:37

This function removes a handler to an event.

Parameters

event

string

handler

Function

Returns

void

Inherited from

EventEmitter.off

on()

on(event, handler, _id?): void

Defined in: util/eventemitter.ts:10

This function attaches a handler to an event. Duplicate handlers are allowed.

Parameters

event

string

handler

Function

_id?

string

Returns

void

Inherited from

EventEmitter.on

resize()

resize(width, height): void

Defined in: window/extension.ts:332

** For deprecation, please use the static method instead

Parameters

width

number

height

number

Returns

void

setBorder()

setBorder(flag): void

Defined in: window/extension.ts:389

** For deprecation, please use the static method instead

Parameters

flag

number

Returns

void

setTitle()

setTitle(value): Promise<any>

Defined in: window/extension.ts:357

** For deprecation, please use the static method instead

Parameters

value

string

Returns

Promise<any>

_finalCallback()

static _finalCallback(message): Promise<void>

Defined in: util/eventemitter.ts:99

Parameters

message

string

Returns

Promise<void>

Inherited from

EventEmitter._finalCallback

_setCallback()

static _setCallback(message): Promise<unknown>

Defined in: util/eventemitter.ts:90

Parameters

message

string

Returns

Promise<unknown>

Inherited from

EventEmitter._setCallback

close()

static close(): void

Defined in: window/extension.ts:396

Closes this extension window

Returns

void

disableClose()

static disableClose(): void

Defined in: window/extension.ts:410

Disable Close Button on this extension’s window

Returns

void

emit()

static emit(event, …params): void

Defined in: window/extension.ts:80

param: (event: string, …params: any[])

Allows this class to emit an event.

Parameters

event

string

params

…any[]

Returns

void

enableClose()

static enableClose(): void

Defined in: window/extension.ts:424

Enable Close Button on this extension’s window

Returns

void

getInstance()

static getInstance(): ExtensionWindow

Defined in: window/extension.ts:53

** For deprecation, the need for getting the instance of an ExtensionWindow looks redundant, ** since an ExtensionWinow should technically have a single instance

Gets the instance of the window utility. Use this instead of the constructor.

Returns

ExtensionWindow

off()

static off(event, handler): void

Defined in: window/extension.ts:317

Parameters

event

string

handler

Function

Returns

void

on()

static on(event, handler): Promise<any>

Defined in: window/extension.ts:95

param: (event: string, handler: Function)

Allows listening to events that this class emits.

Parameters

event

string

handler

Function

Returns

Promise<any>

resize()

static resize(width, height): void

Defined in: window/extension.ts:325

param: (width: number, height: number)

Resizes this extension’s window.

Parameters

width

number

height

number

Returns

void

setBorder()

static setBorder(flag): void

Defined in: window/extension.ts:382

param (flag: number)

Modifies this extension’s window border.

‘4’ is th e base command on setting border flags.

Flags can be: (bit 0 - enable border) (bit 1 - enable caption) (bit 2 - enable sizing) (bit 3 - enable minimize btn) (bit 4 - enable maximize btn)

Parameters

flag

number

Returns

void

setTitle()

static setTitle(value): Promise<any>

Defined in: window/extension.ts:343

param: (value: string)

Renames the extension window.

Parameters

value

string

Returns

Promise<any>