obsproject/obs-browser

# npm
npm install --save-dev @types/obs-studio

# yarn
yarn add --dev @types/obs-studio

/**
 * @returns {string} OBS Browser plugin version
 */
window.obsstudio.pluginVersion
// => 2.17.0

/**
 * @callback EventListener
 * @param {CustomEvent} event
 */

/**
 * @param {string} type
 * @param {EventListener} listener
 */
window.addEventListener('obsSceneChanged', function(event) {
	var t = document.createTextNode(event.detail.name)
	document.body.appendChild(t)
})

/**
 * @typedef {number} Level - The level of permissions. 0 for NONE, 1 for READ_OBS (OBS data), 2 for READ_USER (User data), 3 for BASIC, 4 for ADVANCED and 5 for ALL
 */

/**
 * @callback LevelCallback
 * @param {Level} level
 */

/**
 * @param {LevelCallback} cb - The callback that receives the current control level.
 */
window.obsstudio.getControlLevel(function (level) {
    console.log(level)
})

/**
 * @typedef {Object} Status
 * @property {boolean} recording - not affected by pause state
 * @property {boolean} recordingPaused
 * @property {boolean} streaming
 * @property {boolean} replaybuffer
 * @property {boolean} virtualcam
 */

/**
 * @callback StatusCallback
 * @param {Status} status
 */

/**
 * @param {StatusCallback} cb - The callback that receives the current output status of OBS.
 */
window.obsstudio.getStatus(function (status) {
	console.log(status)
})

/**
 * @typedef {Object} Scene
 * @property {string} name - name of the scene
 * @property {number} width - width of the scene
 * @property {number} height - height of the scene
 */

/**
 * @callback SceneCallback
 * @param {Scene} scene
 */

/**
 * @param {SceneCallback} cb - The callback that receives the current scene in OBS.
 */
window.obsstudio.getCurrentScene(function(scene) {
    console.log(scene)
})

/**
 * @callback ScenesCallback
 * @param {string[]} scenes
 */

/**
 * @param {ScenesCallback} cb - The callback that receives the scenes.
 */
window.obsstudio.getScenes(function (scenes) {
    console.log(scenes)
})

/**
 * @callback TransitionsCallback
 * @param {string[]} transitions
 */

/**
 * @param {TransitionsCallback} cb - The callback that receives the transitions.
 */
window.obsstudio.getTransitions(function (transitions) {
    console.log(transitions)
})

/**
 * @callback TransitionCallback
 * @param {string} transition
 */

/**
 * @param {TransitionCallback} cb - The callback that receives the transition currently set.
 */
window.obsstudio.getCurrentTransition(function (transition) {
    console.log(transition)
})

/**
 * Does not accept any parameters and does not return anything
 */
window.obsstudio.saveReplayBuffer()

/**
 * Does not accept any parameters and does not return anything
 */
window.obsstudio.startReplayBuffer()

/**
 * Does not accept any parameters and does not return anything
 */
window.obsstudio.stopReplayBuffer()

/**
 * @param {string} name - Name of the scene
 */
window.obsstudio.setCurrentScene(name)

/**
 * @param {string} name - Name of the transition
 */
window.obsstudio.setCurrentTransition(name)

/**
 * Does not accept any parameters and does not return anything
 */
window.obsstudio.startStreaming()

/**
 * Does not accept any parameters and does not return anything
 */
window.obsstudio.stopStreaming()

/**
 * Does not accept any parameters and does not return anything
 */
window.obsstudio.startRecording()

/**
 * Does not accept any parameters and does not return anything
 */
window.obsstudio.stopRecording()

/**
 * Does not accept any parameters and does not return anything
 */
window.obsstudio.pauseRecording()

/**
 * Does not accept any parameters and does not return anything
 */
window.obsstudio.unpauseRecording()

/**
 * Does not accept any parameters and does not return anything
 */
window.obsstudio.startVirtualcam()

/**
 * Does not accept any parameters and does not return anything
 */
window.obsstudio.stopVirtualcam()

/**
 * onVisibilityChange gets callbacks when the visibility of the browser source changes in OBS
 *
 * @deprecated
 * @see obsSourceVisibleChanged
 * @param {boolean} visibility - True -> visible, False -> hidden
 */
window.obsstudio.onVisibilityChange = function(visibility) {

};

/**
 * onActiveChange gets callbacks when the active/inactive state of the browser source changes in OBS
 *
 * @deprecated
 * @see obsSourceActiveChanged
 * @param {bool} True -> active, False -> inactive
 */
window.obsstudio.onActiveChange = function(active) {

};