Options
All
  • Public
  • Public/Protected
  • All
Menu

XJS 3.0 API Reference

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AsyncId

AsyncId: number

CallbackFunction

CallbackFunction: (...value: string[]) => void

Type declaration

    • (...value: string[]): void

    • Parameters

      • Rest ...value: string[]

      Returns void

ClientId

ClientId: string

EventMetaDataType

EventMetaDataType: { environmentValidator: () => boolean; key: string }

Type declaration

  • environmentValidator: () => boolean
      • (): boolean

      • Returns boolean

  • key: string

ExecFunc

ExecFunc: (fn: string, ...args: ExecArgument[]) => Promise<string>

Type declaration

    • (fn: string, ...args: ExecArgument[]): Promise<string>

    • Parameters

      • fn: string
      • Rest ...args: ExecArgument[]

      Returns Promise<string>

InstanceList

InstanceList: any[]

KeyValuePair

KeyValuePair: {}

Type declaration

  • [key: string]: unknown

Placement

Placement: { defpos: string; id: string; name: string; preset_id: string; preset_trtime: string; trtime: string }

Type declaration

  • defpos: string
  • id: string
  • name: string
  • preset_id: string
  • preset_trtime: string
  • trtime: string

Position

Position: { bottom: number; left: number; right: number; top: number }

Type declaration

  • bottom: number
  • left: number
  • right: number
  • top: number

PresetId

PresetId: string

PropertyParam

PropertyParam: IKeyValuePair | string | boolean | number

SceneId

SceneId: string

SceneIdentifier

SceneIdentifier: number | string

SceneIndex

SceneIndex: number

SceneInfo

SceneInfo: { id: SceneId; index: SceneIndex; name: string }

Type declaration

ValueParam

ValueParam: string | boolean | number

ViewIndex

ViewIndex: number | string

Variables

Const ASYNC_CALLBACK_TIMEOUT

ASYNC_CALLBACK_TIMEOUT: 60000 = 60000

Const EVENT

EVENT: "event" = "event"

Const callbacks

callbacks: {}

Type declaration

Functions

default

  • default(config: Config): void

Const isEvent

  • isEvent(type: string): boolean

Const off

  • off(key: string, cb: any): void

resize

  • resize(width: number, height: number): void

sendToPlugin

  • sendToPlugin(key: string, payload: any): void

setCustomTabs

  • setCustomTabs(tabs: string[]): void

setMode

  • setMode(mode?: string): void

setTabsOrder

  • setTabsOrder(tabs: string[]): void

setVisible

  • setVisible(isVisible: boolean): void

Object literals

Const AppProps

AppProps: object

audioDevices

audioDevices: {}

Type declaration

audioDevicesWASAPI

audioDevicesWASAPI: {}

Type declaration

microphoneDev2

microphoneDev2: object

key

key: string = "microphonedev2"

setValidator

  • setValidator(xml: string): boolean

sceneIndex

sceneIndex: object

key

key: string = "scene:${view}"

getTransformer

  • getTransformer(value: string): number

getValidator

  • getValidator(param: { view: ViewIndex }): boolean

setTransformer

setValidator

sceneItems

sceneItems: object

key

key: string = "sceneconfig:${scene}"

getValidator

setTransformer

  • setTransformer(value: { value: string }): string

setValidator

sceneName

sceneName: object

key

key: string = "scenename:${scene}"

getValidator

setTransformer

  • setTransformer(value: { value: string }): string

setValidator

sceneNewPreset

sceneNewPreset: object

key

key: string = "scenenewpreset:${scene}"

getValidator

setValidator

  • setValidator(): void

scenePreset

scenePreset: object

key

key: string = "scenepreset:${scene}"

getValidator

setTransformer

  • setTransformer(value: { value: string }): string

setValidator

scenePresetList

scenePresetList: object

key

key: string = "scenepresetlist:${scene}"

getTransformer

  • getTransformer(value: string): string[]

getValidator

setValidator

  • setValidator(): void

scenePresetTransition

scenePresetTransition: object

key

key: string = "scenepresettransitionfunc:${scene}"

getTransformer

  • getTransformer(value: string): string

getValidator

setTransformer

  • setTransformer(value: { value: string }): string

setValidator

scenePresetTransitionTime

scenePresetTransitionTime: object

key

key: string = "scenepresettransitiontime:${scene}"

getTransformer

  • getTransformer(value: string): number

getValidator

setTransformer

  • setTransformer(value: { value: number }): string

setValidator

sceneRemovePreset

sceneRemovePreset: object

key

key: string = "sceneremovepreset:${scene}"

getValidator

  • getValidator(): void

setTransformer

  • setTransformer(value: { value: string }): string

setValidator

sceneThumbnail

sceneThumbnail: object

key

key: string = "sceneshot:${scene}:${width},${height}"

getValidator

  • getValidator(param: { height: number; scene: SceneIdentifier; width: number }): boolean

setValidator

  • setValidator(): void

scenes

scenes: object

key

key: string = "sceneconfig"

setValidator

  • setValidator(xml: string): boolean

wasapiEnum

wasapiEnum: object

key

key: string = "wasapienum"

setValidator

  • setValidator(xml: string): boolean

Const ItemProps

ItemProps: object

An object that contains commonly used item properties

browser60fps

browser60fps: object

key

key: string = "prop:Browser60fps"

getTransformer

  • getTransformer(value: string): boolean

setTransformer

  • setTransformer(value: boolean): string

setValidator

  • setValidator(value: boolean): boolean

customName

customName: object

key

key: string = "prop:cname"

setValidator

  • setValidator(name: string): boolean

fileInfo

fileInfo: object

key

key: string = "FileInfo"

setValidator

  • setValidator(): void

item

item: object

key

key: string = "prop:item"

itemList

itemList: object

key

key: string = "itemlist"

getTransformer

  • getTransformer(value: string): string[]

setTransformer

  • setTransformer(): void

setValidator

  • setValidator(): void

keepAspectRatio

keepAspectRatio: object

key

key: string = "prop:keep_ar"

getTransformer

  • getTransformer(value: string): boolean

setTransformer

  • setTransformer(value: boolean): string

setValidator

  • setValidator(value: boolean): boolean

position

position: object

key

key: string = "prop:pos"

getTransformer

  • getTransformer(value: string): Position

setTransformer

setValidator

srcid

srcid: object

key

key: string = "prop:srcid"

transparency

transparency: object

key

key: string = "prop:alpha"

getTransformer

  • getTransformer(value: string): number

setTransformer

  • setTransformer(value: number): string

setValidator

  • setValidator(value: number): boolean

type

type: object

key

key: string = "prop:type"

getTransformer

  • getTransformer(type: string): string

setTransformer

  • setTransformer(params: { item: string; type: string }): string

  • Parameters

    • params: { item: string; type: string }
      • item: string
      • type: string

    Returns string

setValidator

  • setValidator(params: { item: string; type: string }): boolean

  • Parameters

    • params: { item: string; type: string }
      • item: string
      • type: string

    Returns boolean

visibility

visibility: object

key

key: string = "prop:visible"

getTransformer

  • getTransformer(isVisible: string): boolean

setTransformer

  • setTransformer(isVisible: boolean): string

setValidator

  • setValidator(isVisible: boolean): boolean

Const sourcePropertyWindow

sourcePropertyWindow: object

configure

configure: default

emit

emit: sendToPlugin

off

off: off

on

on: default

resize

resize: resize

setCustomTabs

setCustomTabs: setCustomTabs

setMode

setMode: setMode

setTabsOrder

setTabsOrder: setTabsOrder

setVisible

setVisible: setVisible

Generated using TypeDoc