Reaction
General
getVersion
Return
Return a Promise who resolve with this.
Example
getStats
Return
Return a Promise who resolve with this.
Example
getInfo
Return
Return a Promise who resolve with this.
Example
Scene
sceneGetCurrent
Return
Return a Promise who resolve with this.
Example
sceneSetCurrent
Field | Type | Required | Default | Description |
---|---|---|---|---|
scene | string | ✔️ | none | Your scene name |
Return
Return a Promise who resolve with this.
Example
Source
sourceGetSettings
Field | Type | Required | Default | Description |
---|---|---|---|---|
source | string | ✔️ | none | Your source name |
Return
Return a Promise who resolve with this.
Example
sourceSetSettings
Field | Type | Required | Default | Description |
---|---|---|---|---|
source | string | ✔️ | none | Your source name |
settings | object | ✔️ | none | Your new source settings |
Return
Return a Promise who resolve with this.
Example
sourceGetVolume
Field | Type | Required | Default | Description |
---|---|---|---|---|
source | string | ✔️ | none | Your source name |
useDecibel | boolean | ✔️ | false | Output volume in decibels of attenuation instead of amplitude/mul. |
Return
Return a Promise who resolve with this.
Example
sourceSetVolume
Field | Type | Required | Default | Description |
---|---|---|---|---|
source | string | ✔️ | none | Your source name |
volume | number | ✔️ | none | Desired volume. Must be between 0.0 and 1.0 for mul, and under 0.0 for dB. |
useDecibel | boolean | ✔️ | false | Output volume in decibels of attenuation instead of amplitude/mul. |
Return
Return a Promise who resolve with this.
Example
sourceGetMute
Field | Type | Required | Default | Description |
---|---|---|---|---|
source | string | ✔️ | none | Your source name |
Return
Return a Promise who resolve with this.
Example
sourceSetMute
Field | Type | Required | Default | Description |
---|---|---|---|---|
source | string | ✔️ | none | Your source name |
mute | boolean | ✔️ | none | Desired mute status |
Return
Return a Promise who resolve with this.
Example
sourceMuteToggle
Field | Type | Required | Default | Description |
---|---|---|---|---|
source | string | ✔️ | none | Your source name |
Return
Return a Promise who resolve with this.
Example
Text
textGDIGetSettings
Field | Type | Required | Default | Description |
---|---|---|---|---|
source | string | ✔️ | none | Your source name |
Return
Return a Promise who resolve with this.
Example
textGDISetSettings
Field | Type | Required | Default | Description |
---|---|---|---|---|
source | string | ✔️ | none | Your source name |
settings | TextGDIPlusProperties | ✔️ | none | Your source settings |
Return
Return a Promise who resolve with this.
Example
textFreeGetSettings
Field | Type | Required | Default | Description |
---|---|---|---|---|
source | string | ✔️ | none | Your source name |
Return
Return a Promise who resolve with this.
Example
textFreeSetSettings
Field | Type | Required | Default | Description |
---|---|---|---|---|
source | string | ✔️ | none | Your source name |
settings | TextFreeType2Properties | ✔️ | none | Your source settings |
Return
Return a Promise who resolve with this.
Example
Filter
filterGetSettings
Field | Type | Required | Default | Description |
---|---|---|---|---|
source | string | ✔️ | none | Your source name |
filter | string | ✔️ | none | Your filter name |
Return
Return a Promise who resolve with this.
Example
filterSetSettings
Field | Type | Required | Default | Description |
---|---|---|---|---|
source | string | ✔️ | none | Your source name |
filter | string | ✔️ | none | Your filter name |
settings | this | ✔️ | none | Your new filter settings |
Return
Return a Promise who resolve with this.
Example
filterSetVisibility
Field | Type | Required | Default | Description |
---|---|---|---|---|
source | string | ✔️ | none | Your source name |
filter | string | ✔️ | none | Your filter name |
visibility | boolean | ✔️ | none | Your new filter visibility |
Return
Return a Promise who resolve with this.
Example
filterToggleVisibility
Field | Type | Required | Default | Description |
---|---|---|---|---|
source | string | ✔️ | none | Your source name |
filter | string | ✔️ | none | Your filter name |
Return
Return a Promise who resolve with this.
Example
Scene Items
sourceItemGetSettings
Field | Type | Required | Default | Description |
---|---|---|---|---|
scene | string | ✔️ | none | Your scene name |
item | string | ✔️ | none | Your item name |
Return
Return a Promise who resolve with this.
Example
sceneItemSetSettings
Field | Type | Required | Default | Description |
---|---|---|---|---|
scene | string | ✔️ | none | Your scene name |
item | string | ✔️ | none | Your item name |
settings | SceneItemProperties | ✔️ | none | Your new scene item settings |
Return
Return a Promise who resolve with this.
Example
sourceItemSetVisibility
Field | Type | Required | Default | Description |
---|---|---|---|---|
scene | string | ✔️ | none | Your scene name |
item | string | ✔️ | none | Your item name |
visibility | boolean | ✔️ | none | Your new item visibility |
Return
Return a Promise who resolve with this.
Example
sourceItemVisibilityToggle
Field | Type | Required | Default | Description |
---|---|---|---|---|
scene | string | ✔️ | none | Your scene name |
item | string | ✔️ | none | Your item name |
Return
Return a Promise who resolve with this.
Example
sourceItemSetScale
Field | Type | Required | Default | Description |
---|---|---|---|---|
scene | string | ✔️ | none | Your scene name |
item | string | ✔️ | none | Your item name |
x | number | ✔️ | none | Your new item X scale |
y | number | ✔️ | none | Your new item Y scale |
Return
Return a Promise who resolve with this.
Example
sourceItemSetPosition
Field | Type | Required | Default | Description |
---|---|---|---|---|
scene | string | ✔️ | none | Your scene name |
item | string | ✔️ | none | Your item name |
x | number | ✔️ | none | Your new item X position |
y | number | ✔️ | none | Your new item Y position |
Return
Return a Promise who resolve with this.
Example
sourceItemSetRotation
Field | Type | Required | Default | Description |
---|---|---|---|---|
scene | string | ✔️ | none | Your scene name |
item | string | ✔️ | none | Your item name |
rotation | number | ✔️ | none | Your new item rotation |
Return
Return a Promise who resolve with this.
Example
Streaming
streamingGetStatus
Return
Return a Promise who resolve with this.
Example
streamingToggle
Return
Return a Promise who resolve with this.
Example
streamingStart
Return
Return a Promise who resolve with this.
Example
streamingStop
Return
Return a Promise who resolve with this.
Example
Recording
recordingGetStatus
Return
Return a Promise who resolve with this.
Example
recordingToggle
Return
Return a Promise who resolve with this.
Example
recordingStart
Return
Return a Promise who resolve with this.
Example
recordingStop
Return
Return a Promise who resolve with this.
Example
recordingPause
Return
Return a Promise who resolve with this.
Example
recordingResume
Return
Return a Promise who resolve with this.