Skip to content
XJS Framework
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Guides
Home
Quick Start
Tutorials
Support
Components
Components
Components
Docs Code Sample
Docs Member Card
Docs Navbar
Docs Navigation
Docs Quicklinks
Docs Search
Docs Search Results
Tutorials
Tutorials
Types of Plugins
Installing XJS - Advanced
Developing Source Plugins
Developing Source Properties Windows
Developing Extension Plugins
Advanced Plugins
Debugging Your Plugins
Modern Bundlers and ESM
Linked Sources
Start/Stop Broadcast
Common Errors
Authenticating to External Services
Using DLLs for Extensibility
60 FPS Browser Sources
Remote XJS
API Reference
Enumerations
ActionAfterPlayback
AudioDeviceDataflow
AudioDeviceState
ChromaAntiAliasLevel
ChromaPrimaryColors
ItemTypes
KeyingType
MaskEffect
ViewTypes
Classes
App
AudioDevice
AudioItem
AudioSource
CameraDevice
CameraItem
CameraSource
ChannelManager
Color
CuePoint
Dialog
Dll
Environment
Extension
ExtensionWindow
File
Filter
FlashItem
FlashSource
Game
GameItem
GameSource
Group
GroupItem
HtmlItem
HtmlSource
ImageItem
ImageSource
IO
Item
LanguageInfo
MediaItem
MediaSource
MicrophoneDevice
Output
Rectangle
Remote
Replay
ReplayItem
ReplaySource
Scene
SceneItem
SceneSource
Screen
ScreenItem
ScreenSource
Source
SourcePluginWindow
SourcePropsWindow
StreamInfo
System
Thumbnail
Transition
Url
VideoPlaylist
VideoPlaylistItem
VideoPlaylistSource
Variables
MediaTypes
Functions
exec
ready
_subscribeEventManager
Contributor Reference
core/app
Classes
App
core/channelmanager
Classes
ChannelManager
Functions
_subscribeEventManager
core/dll
Classes
Dll
core/environment
Classes
Environment
core/extension
Classes
Extension
core/filter
Classes
Filter
core/items/audio
Classes
AudioItem
core/items/camera
Classes
CameraItem
core/items/flash
Classes
FlashItem
core/items/game
Classes
GameItem
core/items/genericitem
Classes
GenericItem
core/items/group
Classes
GroupItem
core/items/html
Classes
HtmlItem
core/items/ichroma
Enumerations
ChromaAntiAliasLevel
ChromaPrimaryColors
KeyingType
Classes
ItemChroma
Interfaces
IItemChroma
core/items/icolor
Classes
ItemColor
Interfaces
IItemColor
core/items/ieffects
Enumerations
MaskEffect
Classes
ItemEffect
Interfaces
IItemEffect
core/items/igroup
Classes
ItemGroup
Interfaces
IItemGroup
core/items/ilayout
Classes
ItemLayout
Interfaces
IItemLayout
core/items/image
Classes
ImageItem
core/items/item
Enumerations
ViewTypes
Classes
Item
core/items/itransition
Classes
ItemTransition
Interfaces
IItemTransition
core/items/media
Classes
MediaItem
core/items/replay
Classes
ReplayItem
core/items/sceneitem
Classes
SceneItem
core/items/screen
Classes
ScreenItem
core/items/videoplaylist
Classes
VideoPlaylistItem
core/languageinfo
Classes
LanguageInfo
core/output
Classes
Output
core/outputtarget
Interfaces
BroadcastOptions
OutputTargetOptions
Type Aliases
OutputTarget
Variables
ALL_INDEX
LOCAL_RECORDING
OUTPUT_SUFFIX
Functions
decodeStreamChannelName
getOutputParam
getViewOutputsCount
isOutputTargetActive
normalizeOutputTarget
rememberOutputEvent
resolveOutputIndices
resolveStreamEventChannelName
resolveStreamEventIndex
takePendingOutputIndex
withOutputSuffix
core/scene
Classes
Scene
core/source/audio
Classes
AudioSource
core/source/camera
Classes
CameraSource
core/source/cuepoint
Classes
CuePoint
core/source/flash
Classes
FlashSource
core/source/game
Classes
GameSource
core/source/html
Classes
HtmlSource
core/source/iaudio
Classes
Audio
Interfaces
IAudio
core/source/iaudiosource
Classes
SourceAudio
Interfaces
ISourceAudio
core/source/icamera
Classes
SourceCamera
Interfaces
ISourceCamera
core/source/iconfig
Classes
SourceConfigurable
Interfaces
ISourceConfigurable
core/source/iflash
Classes
SourceFlash
Interfaces
ISourceFlash
core/source/igame
Classes
iSourceGame
Interfaces
ISourceGame
core/source/ihtml
Classes
iSourceHtml
Interfaces
ISourceHtml
core/source/iimage
Classes
SourceImage
Interfaces
ISourceImage
core/source/image
Classes
ImageSource
core/source/imedia
Classes
SourceMedia
Interfaces
ISourceMedia
core/source/iplayback
Enumerations
ActionAfterPlayback
Classes
SourcePlayback
Interfaces
ISourcePlayback
Variables
AUDIO_REGEX
VIDEO_REGEX
core/source/ireplay
Classes
SourceReplay
Interfaces
ISourceReplay
core/source/iscene
Classes
SourceScene
Interfaces
ISourceScene
core/source/iscreen
Classes
iSourceScreen
Interfaces
ISourceScreen
core/source/isource
Enumerations
ItemTypes
Classes
iSource
Interfaces
ISource
core/source/ivideoplaylist
Classes
SourceVideoPlaylist
Interfaces
ISourceVideoPlaylist
core/source/media
Classes
MediaSource
Variables
MediaTypes
core/source/replay
Classes
ReplaySource
core/source/scenesource
Classes
SceneSource
core/source/screen
Classes
ScreenSource
core/source/source
Classes
Source
core/source/videoplaylist
Classes
VideoPlaylistSource
core/streaminfo
Classes
StreamInfo
core/thumbnail
Classes
Thumbnail
core/transition
Classes
Transition
index
References
_subscribeEventManager
ActionAfterPlayback
App
AudioDevice
AudioDeviceDataflow
AudioDeviceState
AudioItem
AudioSource
CameraDevice
CameraItem
CameraSource
ChannelManager
ChromaAntiAliasLevel
ChromaPrimaryColors
Color
CuePoint
Dialog
Dll
Environment
exec
Extension
ExtensionWindow
File
Filter
FlashItem
FlashSource
Game
GameItem
GameSource
Group
GroupItem
HtmlItem
HtmlSource
ImageItem
ImageSource
IO
Item
ItemTypes
KeyingType
LanguageInfo
MaskEffect
MediaItem
MediaSource
MediaTypes
MicrophoneDevice
Output
ready
Rectangle
Remote
Replay
ReplayItem
ReplaySource
Scene
SceneItem
SceneSource
Screen
ScreenItem
ScreenSource
Source
SourcePluginWindow
SourcePropsWindow
StreamInfo
System
Thumbnail
Transition
Url
VideoPlaylist
VideoPlaylistItem
VideoPlaylistSource
ViewTypes
internal/app
Classes
App
internal/eventmanager
Classes
EventManager
internal/global
Classes
Global
internal/init
Functions
default
internal/internal
Variables
DEBUG
Functions
exec
finalCallback
internal/item
Classes
Item
internal/remote
Classes
Remote
internal/util/json
Classes
JSON
internal/util/logger
Classes
Logger
internal/util/mixin
Functions
applyMixins
internal/util/splitmode
Functions
checkSplitmode
splitMode
internal/util/version
Variables
addSceneEventFixVersion
deleteSceneEventFixVersion
globalsrcMinVersion
handlePreStreamDialogFixVersion
itemSubscribeEventVersion
minVersion
mockVersion
scenePresetsVersion
sceneSourceVersion
sceneUidAddDeleteVersion
sceneUidMinVersion
Functions
getVersion
setMockVersion
versionCompare
internal/util/xml
Classes
XML
system/audio
Classes
AudioDevice
system/camera
Classes
CameraDevice
system/file
Classes
File
system/game
Classes
Game
system/group
Classes
Group
system/iaddable
Interfaces
Addable
system/microphone
Classes
MicrophoneDevice
system/replay
Classes
Replay
system/screen
Classes
Screen
system/system
Enumerations
AudioDeviceDataflow
AudioDeviceState
Classes
System
system/url
Classes
Url
system/videoplaylist
Classes
VideoPlaylist
util/addtosceneutil
Classes
AddToSceneEventEmitter
Functions
addToSceneHandler
guid
util/color
Classes
Color
util/eventemitter
Classes
EventEmitter
util/io
Classes
IO
util/itemtyperesolve
Functions
ItemTypeResolve
util/ready
Functions
finishReady
ready
setOnce
setReady
util/rectangle
Classes
Rectangle
util/sourcetyperesolve
Functions
SourceTypeResolve
util/window
Variables
default
window/config
Classes
SourcePropsWindow
window/dialog
Classes
Dialog
window/extension
Classes
ExtensionWindow
window/source
Classes
SourcePluginWindow
GitHub
Select theme
Dark
Light
Auto
setReady
setReady
():
void
Defined in:
util/ready.ts:78
Returns
Section titled “Returns”
void
