SourcePropsWindow
Defined in: window/config.ts:23
This utility class exposes functionality for source plugin developers to handle the properties window for their source plugins. The framework also uses this class for its own internal purposes.
Developers can use this class to specify how their configuration HTML should be rendered within the built-in window in XSplit Broadcaster. This class also serves as an event emitter for specific important events.
Inherits from: #util/EventEmitter Util/EventEmitter
At the moment, the only relevant event for developers is:
set-selected-tab: used when using Tabbed mode. Passes the name of the selected tab so properties window can update itself accordingly.
Use the on(event: string, handler: Function) function to listen to an event.
Extends
Section titled “Extends”EventEmitter
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SourcePropsWindow():
SourcePropsWindow
Defined in: window/config.ts:42
Use getInstance() instead.
Returns
Section titled “Returns”SourcePropsWindow
Overrides
Section titled “Overrides”EventEmitter.constructor
Properties
Section titled “Properties”_proxyHandlers
Section titled “_proxyHandlers”
static_proxyHandlers:object={}
Defined in: util/eventemitter.ts:7
Inherited from
Section titled “Inherited from”EventEmitter._proxyHandlers
_remoteHandlers
Section titled “_remoteHandlers”
static_remoteHandlers:object={}
Defined in: util/eventemitter.ts:6
Inherited from
Section titled “Inherited from”EventEmitter._remoteHandlers
Methods
Section titled “Methods”close()
Section titled “close()”close():
Promise<any>
Defined in: window/config.ts:173
Closes the properties window.
Returns
Section titled “Returns”Promise<any>
emit()
Section titled “emit()”emit(
event, …params):void
Defined in: util/eventemitter.ts:66
This function lets an event trigger with any number of supplied parameters.
Parameters
Section titled “Parameters”string
params
Section titled “params”…any[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”EventEmitter.emit
off(
event,handler):void
Defined in: util/eventemitter.ts:37
This function removes a handler to an event.
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Function
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”EventEmitter.off
on(
event,handler,_id?):void
Defined in: util/eventemitter.ts:10
This function attaches a handler to an event. Duplicate handlers are allowed.
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Function
string
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”EventEmitter.on
requestDialogTitleChange()
Section titled “requestDialogTitleChange()”requestDialogTitleChange(
name):void
Defined in: window/config.ts:165
param: name
Changes the title of the source properties dialog. Note: The title change is temporary, as re-opening the source properties resets the title to the display name of the source (custom name takes precedence over name)
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
resize()
Section titled “resize()”resize(
width,height):void
Defined in: window/config.ts:147
param: width
Resizes the properties window. Currently only works when using full window mode.
Parameters
Section titled “Parameters”number
height
Section titled “height”number
Returns
Section titled “Returns”void
showLoading()
Section titled “showLoading()”showLoading(
show):void
Defined in: window/config.ts:184
param: show
Toggles on/off the load indicator of the source properties dialog
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
useFullWindow()
Section titled “useFullWindow()”useFullWindow():
void
Defined in: window/config.ts:90
Informs the application that the plugin intends to use the entire window for rendering its configuration.
Returns
Section titled “Returns”void
useTabbedWindow()
Section titled “useTabbedWindow()”useTabbedWindow(
config):void
Defined in: window/config.ts:109
param: ({customTabs: string[], tabOrder: string[]})
Informs the application that the plugin intends to use the existing tab system to render its properties window.
The customTabs node should contain a list of tab titles that the plugin
will create for itself.
The tabOrder node contains the desired order of tabs. This list comes
from the specified custom tabs, and the set of reusable XSplit tabs:
‘Color’, ‘Layout’ and ‘Transition’.
Parameters
Section titled “Parameters”config
Section titled “config”customTabs
Section titled “customTabs”string[]
tabOrder
Section titled “tabOrder”string[]
Returns
Section titled “Returns”void
_finalCallback()
Section titled “_finalCallback()”
static_finalCallback(message):Promise<void>
Defined in: util/eventemitter.ts:99
Parameters
Section titled “Parameters”message
Section titled “message”string
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”EventEmitter._finalCallback
_setCallback()
Section titled “_setCallback()”
static_setCallback(message):Promise<unknown>
Defined in: util/eventemitter.ts:90
Parameters
Section titled “Parameters”message
Section titled “message”string
Returns
Section titled “Returns”Promise<unknown>
Inherited from
Section titled “Inherited from”EventEmitter._setCallback
getInstance()
Section titled “getInstance()”
staticgetInstance():SourcePropsWindow
Defined in: window/config.ts:32
Gets the instance of the window utility. Use this instead of the constructor.
Returns
Section titled “Returns”SourcePropsWindow