Skip to main content

Reaction

General#

getVersion#

Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
const version = await moduleObs.getVersion()
console.log(version)
}

getStats#

Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
const stats = await moduleObs.getStats()
console.log(stats)
}

getInfo#

Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
const info = await moduleObs.getInfo()
console.log(info)
}

Scene#

sceneGetCurrent#

Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
const currentScene = await moduleObs.sceneGetCurrent()
console.log(currentScene)
}

sceneSetCurrent#

FieldTypeRequiredDefaultDescription
scenestringโœ”๏ธnoneYour scene name
Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
await moduleObs.sceneSetCurrent("Scene 1")
}

Source#

sourceGetSettings#

FieldTypeRequiredDefaultDescription
sourcestringโœ”๏ธnoneYour source name
Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
const sceneSettings = await moduleObs.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#
const reaction = async (event) => {
const newSourceSettings = await moduleObs.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#
const reaction = async (event) => {
const volume = await moduleObs.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#
const reaction = async (event) => {
await moduleObs.sourceSetVolume("Audio / Mix", 1)
}

sourceGetMute#

FieldTypeRequiredDefaultDescription
sourcestringโœ”๏ธnoneYour source name
Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
const sourceMuteState = await moduleObs.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#
const reaction = async (event) => {
await moduleObs.sourceSetMute("Audio / Mix", true)
}

sourceMuteToggle#

FieldTypeRequiredDefaultDescription
sourcestringโœ”๏ธnoneYour source name
Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
await moduleObs.sourceMuteToggle("Audio / Mix")
}

Text#

textGDIGetSettings#

FieldTypeRequiredDefaultDescription
sourcestringโœ”๏ธnoneYour source name
Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
const textSettings = await moduleObs.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#
const reaction = async (event) => {
await moduleObs.textGDISetSettings("A sample Text", { text: 'COUCOU' })
}

textFreeGetSettings#

FieldTypeRequiredDefaultDescription
sourcestringโœ”๏ธnoneYour source name
Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
const textSettings = await moduleObs.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#
const reaction = async (event) => {
await moduleObs.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#
const reaction = async (event) => {
const version = await moduleObs.filterGetSettings("camera", "sepia")
console.log(version)
}

filterSetSettings#

FieldTypeRequiredDefaultDescription
sourcestringโœ”๏ธnoneYour source name
filterstringโœ”๏ธnoneYour filter name
settingsSetSourceFilterSettingsโœ”๏ธnoneYour new filter settings
Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
await moduleObs.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#
const reaction = async (event) => {
await moduleObs.filterSetVisibility("camera", "sepia", true)
}

filterToggleVisibility#

FieldTypeRequiredDefaultDescription
sourcestringโœ”๏ธnoneYour source name
filterstringโœ”๏ธnoneYour filter name
Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
await moduleObs.filterToggleVisibility("camera", "sepia")
}

Scene Items#

sceneItemGetSettings#

FieldTypeRequiredDefaultDescription
scenestringโœ”๏ธnoneYour scene name
itemstringโœ”๏ธnoneYour item name
Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
const sceneItemSettings = await moduleObs.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#
const reaction = async (event) => {
await moduleObs.sceneItemSetSettings("scene 1", "camera", { visible: true })
}

sceneItemSetVisibility#

FieldTypeRequiredDefaultDescription
scenestringโœ”๏ธnoneYour scene name
itemstringโœ”๏ธnoneYour item name
visibilitybooleanโœ”๏ธnoneYour new item visibility
Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
await moduleObs.sourceItemSetVisibility("scene 1", "camera", true)
}

sceneItemVisibilityToggle#

FieldTypeRequiredDefaultDescription
scenestringโœ”๏ธnoneYour scene name
itemstringโœ”๏ธnoneYour item name
Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
await moduleObs.sourceItemVisibilityToggle("scene 1", "camera")
}

sceneItemSetScale#

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#
const reaction = async (event) => {
await moduleObs.sourceItemSetScale("scene 1", "camera", 0.5, 0.5)
}

sceneItemSetPosition#

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#
const reaction = async (event) => {
await moduleObs.sourceItemSetPosition("scene 1", "camera", 500, 100)
}

sceneItemSetRotation#

FieldTypeRequiredDefaultDescription
scenestringโœ”๏ธnoneYour scene name
itemstringโœ”๏ธnoneYour item name
rotationnumberโœ”๏ธnoneYour new item rotation
Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
await moduleObs.sourceItemSetRotation("scene 1", "camera", 360)
}

Streaming#

streamingGetStatus#

Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
const streamingStatus = await moduleObs.streamingGetStatus()
console.log(streamingStatus)
}

streamingToggle#

Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
await moduleObs.streamingToggle()
}

streamingStart#

Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
await moduleObs.streamingStart()
}

streamingStop#

Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
await moduleObs.streamingStop()
}

Recording#

recordingGetStatus#

Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
const recordingStatus = await moduleObs.recordingGetStatus()
console.log(recordingStatus)
}

recordingToggle#

Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
await moduleObs.recordingToggle()
}

recordingStart#

Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
await moduleObs.recordingStart()
}

recordingStop#

Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
await moduleObs.recordingStop()
}

recordingPause#

Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
await moduleObs.recordingPause()
}

recordingResume#

Return#

Return a Promise who resolve with this.

Example#
const reaction = async (event) => {
await moduleObs.recordingResume()
}