Reaction

General

getVersion

Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
const version = await services.plugin('obs', 'getVersion')
console.log(version)
}

getStats

Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
const stats = await services.plugin('obs', 'getStats')
console.log(stats)
}

getInfo

Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
const info = await services.plugin('obs', 'getInfo')
console.log(info)
}

Scene

sceneGetCurrent

Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
const currentScene = await services.plugin('obs', 'sceneGetCurrent')
console.log(currentScene)
}

sceneSetCurrent

FieldTypeRequiredDefaultDescription
scenestring✔️noneYour scene name
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'sceneSetCurrent', 'Scene 1')
}

Source

sourceGetSettings

FieldTypeRequiredDefaultDescription
sourcestring✔️noneYour source name
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
const sceneSettings = await services.plugin('obs', 'sourceGetSettings', 'Scene 1')
console.log(sceneSettings)
}

sourceSetSettings

FieldTypeRequiredDefaultDescription
sourcestring✔️noneYour source name
settingsobject✔️noneYour new source settings
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
const newSourceSettings = await services.plugin('obs', 'sourceSetSettings', 'Scene 1', { visibility: false })
console.log(newSourceSettings)
}

sourceGetVolume

FieldTypeRequiredDefaultDescription
sourcestring✔️noneYour source name
useDecibelboolean✔️falseOutput volume in decibels of attenuation instead of amplitude/mul.
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
const volume = await services.plugin('obs', 'sourceGetVolume', 'Audio / Mix')
console.log(volume)
}

sourceSetVolume

FieldTypeRequiredDefaultDescription
sourcestring✔️noneYour source name
volumenumber✔️noneDesired volume. Must be between 0.0 and 1.0 for mul, and under 0.0 for dB.
useDecibelboolean✔️falseOutput volume in decibels of attenuation instead of amplitude/mul.
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'sourceSetVolume', 'Audio / Mix', 1)
}

sourceGetMute

FieldTypeRequiredDefaultDescription
sourcestring✔️noneYour source name
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
const sourceMuteState = await services.plugin('obs', 'sourceGetMute', 'Audio / Mix')
console.log(sourceMuteState)
}

sourceSetMute

FieldTypeRequiredDefaultDescription
sourcestring✔️noneYour source name
muteboolean✔️noneDesired mute status
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'sourceSetMute', 'Audio / Mix', true)
}

sourceMuteToggle

FieldTypeRequiredDefaultDescription
sourcestring✔️noneYour source name
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'sourceMuteToggle', 'Audio / Mix')
}

Text

textGDIGetSettings

FieldTypeRequiredDefaultDescription
sourcestring✔️noneYour source name
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
const textSettings = await services.plugin('obs', 'textGDIGetSettings', 'A sample Text')
console.log(textSettings)
}

textGDISetSettings

FieldTypeRequiredDefaultDescription
sourcestring✔️noneYour source name
settingsTextGDIPlusProperties✔️noneYour source settings
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'textGDISetSettings', 'A sample Text', { text: 'COUCOU' })
}

textFreeGetSettings

FieldTypeRequiredDefaultDescription
sourcestring✔️noneYour source name
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
const textSettings = await services.plugin('obs', 'textFreeGetSettings', 'A sample Text')
console.log(textSettings)
}

textFreeSetSettings

FieldTypeRequiredDefaultDescription
sourcestring✔️noneYour source name
settingsTextFreeType2Properties✔️noneYour source settings
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'textFreeSetSettings', 'A sample Text', { text: 'COUCOU' })
}

Filter

filterGetSettings

FieldTypeRequiredDefaultDescription
sourcestring✔️noneYour source name
filterstring✔️noneYour filter name
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
const version = await services.plugin('obs', 'filterGetSettings', 'camera', 'sepia')
console.log(version)
}

filterSetSettings

FieldTypeRequiredDefaultDescription
sourcestring✔️noneYour source name
filterstring✔️noneYour filter name
settingsthis✔️noneYour new filter settings
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'filterSetSettings', 'camera', 'sepia', { noidear: true })
}

filterSetVisibility

FieldTypeRequiredDefaultDescription
sourcestring✔️noneYour source name
filterstring✔️noneYour filter name
visibilityboolean✔️noneYour new filter visibility
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'filterSetVisibility', 'camera', 'sepia', true)
}

filterToggleVisibility

FieldTypeRequiredDefaultDescription
sourcestring✔️noneYour source name
filterstring✔️noneYour filter name
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'filterToggleVisibility', 'camera', 'sepia')
}

Scene Items

sourceItemGetSettings

FieldTypeRequiredDefaultDescription
scenestring✔️noneYour scene name
itemstring✔️noneYour item name
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
const sceneItemSettings = await services.plugin('obs', 'sourceItemGetSettings', 'scene 1', 'camera')
console.log(sceneItemSettings)
}

sceneItemSetSettings

FieldTypeRequiredDefaultDescription
scenestring✔️noneYour scene name
itemstring✔️noneYour item name
settingsSceneItemProperties✔️noneYour new scene item settings
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'sceneItemSetSettings', 'scene 1', 'camera', { visible: true })
}

sourceItemSetVisibility

FieldTypeRequiredDefaultDescription
scenestring✔️noneYour scene name
itemstring✔️noneYour item name
visibilityboolean✔️noneYour new item visibility
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'sourceItemSetVisibility', 'scene 1', 'camera', true)
}

sourceItemVisibilityToggle

FieldTypeRequiredDefaultDescription
scenestring✔️noneYour scene name
itemstring✔️noneYour item name
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'sourceItemVisibilityToggle', 'scene 1', 'camera')
}

sourceItemSetScale

FieldTypeRequiredDefaultDescription
scenestring✔️noneYour scene name
itemstring✔️noneYour item name
xnumber✔️noneYour new item X scale
ynumber✔️noneYour new item Y scale
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'sourceItemSetScale', 'scene 1', 'camera', 0.5, 0.5)
}

sourceItemSetPosition

FieldTypeRequiredDefaultDescription
scenestring✔️noneYour scene name
itemstring✔️noneYour item name
xnumber✔️noneYour new item X position
ynumber✔️noneYour new item Y position
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'sourceItemSetPosition', 'scene 1', 'camera', 500, 100)
}

sourceItemSetRotation

FieldTypeRequiredDefaultDescription
scenestring✔️noneYour scene name
itemstring✔️noneYour item name
rotationnumber✔️noneYour new item rotation
Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'sourceItemSetRotation', 'scene 1', 'camera', 360)
}

Streaming

streamingGetStatus

Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
const streamingStatus = await services.plugin('obs', 'streamingGetStatus')
console.log(streamingStatus)
}

streamingToggle

Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'streamingToggle')
}

streamingStart

Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'streamingStart')
}

streamingStop

Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'streamingStop')
}

Recording

recordingGetStatus

Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
const recordingStatus = await services.plugin('obs', 'recordingGetStatus')
console.log(recordingStatus)
}

recordingToggle

Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'recordingToggle')
}

recordingStart

Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'recordingStart')
}

recordingStop

Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'recordingStop')
}

recordingPause

Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'recordingPause')
}

recordingResume

Return

Return a Promise who resolve with this.

Example
module.exports = async (data, services) => {
await services.plugin('obs', 'recordingResume')
}