Mirrored_Repos/obs-websocket
1
0
Fork 0
mirror of https://github.com/Palakis/obs-websocket.git synced 2024-08-30 18:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
obs-websocket/docs/generated/comments.json

8350 lines
235 KiB
JSON
Raw Blame History

{
"typedefs": [
{
"subheads": [],
"typedef": "{Object} `SceneItem` An OBS Scene Item.",
"property": [
"{Number} `cy`",
"{Number} `cx`",
"{String} `name` The name of this Scene Item.",
"{int} `id` Scene item ID",
"{Boolean} `render` Whether or not this Scene Item is set to \"visible\".",
"{Boolean} `locked` Whether or not this Scene Item is locked and can't be moved around",
"{Number} `source_cx`",
"{Number} `source_cy`",
"{String} `type` Source type. Value is one of the following: \"input\", \"filter\", \"transition\", \"scene\" or \"unknown\"",
"{Number} `volume`",
"{Number} `x`",
"{Number} `y`",
"{String (optional)} `parentGroupName` Name of the item's parent (if this item belongs to a group)",
"{Array<SceneItem> (optional)} `groupChildren` List of children (if this item is a group)"
],
"properties": [
{
"type": "Number",
"name": "cy",
"description": ""
},
{
"type": "Number",
"name": "cx",
"description": ""
},
{
"type": "String",
"name": "name",
"description": "The name of this Scene Item."
},
{
"type": "int",
"name": "id",
"description": "Scene item ID"
},
{
"type": "Boolean",
"name": "render",
"description": "Whether or not this Scene Item is set to \"visible\"."
},
{
"type": "Boolean",
"name": "locked",
"description": "Whether or not this Scene Item is locked and can't be moved around"
},
{
"type": "Number",
"name": "source_cx",
"description": ""
},
{
"type": "Number",
"name": "source_cy",
"description": ""
},
{
"type": "String",
"name": "type",
"description": "Source type. Value is one of the following: \"input\", \"filter\", \"transition\", \"scene\" or \"unknown\""
},
{
"type": "Number",
"name": "volume",
"description": ""
},
{
"type": "Number",
"name": "x",
"description": ""
},
{
"type": "Number",
"name": "y",
"description": ""
},
{
"type": "String (optional)",
"name": "parentGroupName",
"description": "Name of the item's parent (if this item belongs to a group)"
},
{
"type": "Array<SceneItem> (optional)",
"name": "groupChildren",
"description": "List of children (if this item is a group)"
}
],
"typedefs": [
{
"type": "Object",
"name": "SceneItem",
"description": "An OBS Scene Item."
}
],
"name": "",
"heading": {
"level": 2,
"text": ""
},
"examples": []
},
{
"subheads": [],
"typedef": "{Object} `SceneItemTransform`",
"property": [
"{int} `position.x` The x position of the scene item from the left.",
"{int} `position.y` The y position of the scene item from the top.",
"{int} `position.alignment` The point on the scene item that the item is manipulated from.",
"{double} `rotation` The clockwise rotation of the scene item in degrees around the point of alignment.",
"{double} `scale.x` The x-scale factor of the scene item.",
"{double} `scale.y` The y-scale factor of the scene item.",
"{int} `crop.top` The number of pixels cropped off the top of the scene item before scaling.",
"{int} `crop.right` The number of pixels cropped off the right of the scene item before scaling.",
"{int} `crop.bottom` The number of pixels cropped off the bottom of the scene item before scaling.",
"{int} `crop.left` The number of pixels cropped off the left of the scene item before scaling.",
"{bool} `visible` If the scene item is visible.",
"{bool} `locked` If the scene item is locked in position.",
"{String} `bounds.type` Type of bounding box. Can be \"OBS_BOUNDS_STRETCH\", \"OBS_BOUNDS_SCALE_INNER\", \"OBS_BOUNDS_SCALE_OUTER\", \"OBS_BOUNDS_SCALE_TO_WIDTH\", \"OBS_BOUNDS_SCALE_TO_HEIGHT\", \"OBS_BOUNDS_MAX_ONLY\" or \"OBS_BOUNDS_NONE\".",
"{int} `bounds.alignment` Alignment of the bounding box.",
"{double} `bounds.x` Width of the bounding box.",
"{double} `bounds.y` Height of the bounding box.",
"{int} `sourceWidth` Base width (without scaling) of the source",
"{int} `sourceHeight` Base source (without scaling) of the source",
"{double} `width` Scene item width (base source width multiplied by the horizontal scaling factor)",
"{double} `height` Scene item height (base source height multiplied by the vertical scaling factor)",
"{String (optional)} `parentGroupName` Name of the item's parent (if this item belongs to a group)",
"{Array<SceneItemTransform> (optional)} `groupChildren` List of children (if this item is a group)"
],
"properties": [
{
"type": "int",
"name": "position.x",
"description": "The x position of the scene item from the left."
},
{
"type": "int",
"name": "position.y",
"description": "The y position of the scene item from the top."
},
{
"type": "int",
"name": "position.alignment",
"description": "The point on the scene item that the item is manipulated from."
},
{
"type": "double",
"name": "rotation",
"description": "The clockwise rotation of the scene item in degrees around the point of alignment."
},
{
"type": "double",
"name": "scale.x",
"description": "The x-scale factor of the scene item."
},
{
"type": "double",
"name": "scale.y",
"description": "The y-scale factor of the scene item."
},
{
"type": "int",
"name": "crop.top",
"description": "The number of pixels cropped off the top of the scene item before scaling."
},
{
"type": "int",
"name": "crop.right",
"description": "The number of pixels cropped off the right of the scene item before scaling."
},
{
"type": "int",
"name": "crop.bottom",
"description": "The number of pixels cropped off the bottom of the scene item before scaling."
},
{
"type": "int",
"name": "crop.left",
"description": "The number of pixels cropped off the left of the scene item before scaling."
},
{
"type": "bool",
"name": "visible",
"description": "If the scene item is visible."
},
{
"type": "bool",
"name": "locked",
"description": "If the scene item is locked in position."
},
{
"type": "String",
"name": "bounds.type",
"description": "Type of bounding box. Can be \"OBS_BOUNDS_STRETCH\", \"OBS_BOUNDS_SCALE_INNER\", \"OBS_BOUNDS_SCALE_OUTER\", \"OBS_BOUNDS_SCALE_TO_WIDTH\", \"OBS_BOUNDS_SCALE_TO_HEIGHT\", \"OBS_BOUNDS_MAX_ONLY\" or \"OBS_BOUNDS_NONE\"."
},
{
"type": "int",
"name": "bounds.alignment",
"description": "Alignment of the bounding box."
},
{
"type": "double",
"name": "bounds.x",
"description": "Width of the bounding box."
},
{
"type": "double",
"name": "bounds.y",
"description": "Height of the bounding box."
},
{
"type": "int",
"name": "sourceWidth",
"description": "Base width (without scaling) of the source"
},
{
"type": "int",
"name": "sourceHeight",
"description": "Base source (without scaling) of the source"
},
{
"type": "double",
"name": "width",
"description": "Scene item width (base source width multiplied by the horizontal scaling factor)"
},
{
"type": "double",
"name": "height",
"description": "Scene item height (base source height multiplied by the vertical scaling factor)"
},
{
"type": "String (optional)",
"name": "parentGroupName",
"description": "Name of the item's parent (if this item belongs to a group)"
},
{
"type": "Array<SceneItemTransform> (optional)",
"name": "groupChildren",
"description": "List of children (if this item is a group)"
}
],
"typedefs": [
{
"type": "Object",
"name": "SceneItemTransform",
"description": ""
}
],
"name": "",
"heading": {
"level": 2,
"text": ""
},
"examples": []
},
{
"subheads": [],
"typedef": "{Object} `OBSStats`",
"property": [
"{double} `fps` Current framerate.",
"{int} `render-total-frames` Number of frames rendered",
"{int} `render-missed-frames` Number of frames missed due to rendering lag",
"{int} `output-total-frames` Number of frames outputted",
"{int} `output-skipped-frames` Number of frames skipped due to encoding lag",
"{double} `average-frame-time` Average frame render time (in milliseconds)",
"{double} `cpu-usage` Current CPU usage (percentage)",
"{double} `memory-usage` Current RAM usage (in megabytes)",
"{double} `free-disk-space` Free recording disk space (in megabytes)"
],
"properties": [
{
"type": "double",
"name": "fps",
"description": "Current framerate."
},
{
"type": "int",
"name": "render-total-frames",
"description": "Number of frames rendered"
},
{
"type": "int",
"name": "render-missed-frames",
"description": "Number of frames missed due to rendering lag"
},
{
"type": "int",
"name": "output-total-frames",
"description": "Number of frames outputted"
},
{
"type": "int",
"name": "output-skipped-frames",
"description": "Number of frames skipped due to encoding lag"
},
{
"type": "double",
"name": "average-frame-time",
"description": "Average frame render time (in milliseconds)"
},
{
"type": "double",
"name": "cpu-usage",
"description": "Current CPU usage (percentage)"
},
{
"type": "double",
"name": "memory-usage",
"description": "Current RAM usage (in megabytes)"
},
{
"type": "double",
"name": "free-disk-space",
"description": "Free recording disk space (in megabytes)"
}
],
"typedefs": [
{
"type": "Object",
"name": "OBSStats",
"description": ""
}
],
"name": "",
"heading": {
"level": 2,
"text": ""
},
"examples": []
},
{
"subheads": [],
"typedef": "{Object} `Output`",
"property": [
"{String} `name` Output name",
"{String} `type` Output type/kind",
"{int} `width` Video output width",
"{int} `height` Video output height",
"{Object} `flags` Output flags",
"{int} `flags.rawValue` Raw flags value",
"{boolean} `flags.audio` Output uses audio",
"{boolean} `flags.video` Output uses video",
"{boolean} `flags.encoded` Output is encoded",
"{boolean} `flags.multiTrack` Output uses several audio tracks",
"{boolean} `flags.service` Output uses a service",
"{Object} `settings` Output name",
"{boolean} `active` Output status (active or not)",
"{boolean} `reconnecting` Output reconnection status (reconnecting or not)",
"{double} `congestion` Output congestion",
"{int} `totalFrames` Number of frames sent",
"{int} `droppedFrames` Number of frames dropped",
"{int} `totalBytes` Total bytes sent"
],
"properties": [
{
"type": "String",
"name": "name",
"description": "Output name"
},
{
"type": "String",
"name": "type",
"description": "Output type/kind"
},
{
"type": "int",
"name": "width",
"description": "Video output width"
},
{
"type": "int",
"name": "height",
"description": "Video output height"
},
{
"type": "Object",
"name": "flags",
"description": "Output flags"
},
{
"type": "int",
"name": "flags.rawValue",
"description": "Raw flags value"
},
{
"type": "boolean",
"name": "flags.audio",
"description": "Output uses audio"
},
{
"type": "boolean",
"name": "flags.video",
"description": "Output uses video"
},
{
"type": "boolean",
"name": "flags.encoded",
"description": "Output is encoded"
},
{
"type": "boolean",
"name": "flags.multiTrack",
"description": "Output uses several audio tracks"
},
{
"type": "boolean",
"name": "flags.service",
"description": "Output uses a service"
},
{
"type": "Object",
"name": "settings",
"description": "Output name"
},
{
"type": "boolean",
"name": "active",
"description": "Output status (active or not)"
},
{
"type": "boolean",
"name": "reconnecting",
"description": "Output reconnection status (reconnecting or not)"
},
{
"type": "double",
"name": "congestion",
"description": "Output congestion"
},
{
"type": "int",
"name": "totalFrames",
"description": "Number of frames sent"
},
{
"type": "int",
"name": "droppedFrames",
"description": "Number of frames dropped"
},
{
"type": "int",
"name": "totalBytes",
"description": "Total bytes sent"
}
],
"typedefs": [
{
"type": "Object",
"name": "Output",
"description": ""
}
],
"name": "",
"heading": {
"level": 2,
"text": ""
},
"examples": []
},
{
"subheads": [],
"typedef": "{Object} `Scene`",
"property": [
"{String} `name` Name of the currently active scene.",
"{Array<SceneItem>} `sources` Ordered list of the current scene's source items."
],
"properties": [
{
"type": "String",
"name": "name",
"description": "Name of the currently active scene."
},
{
"type": "Array<SceneItem>",
"name": "sources",
"description": "Ordered list of the current scene's source items."
}
],
"typedefs": [
{
"type": "Object",
"name": "Scene",
"description": ""
}
],
"name": "",
"heading": {
"level": 2,
"text": ""
},
"examples": []
}
],
"events": {
"scenes": [
{
"subheads": [],
"description": "Indicates a scene change.",
"return": [
"{String} `scene-name` The new scene.",
"{Array<SceneItem>} `sources` List of scene items in the new scene. Same specification as [`GetCurrentScene`](#getcurrentscene)."
],
"api": "events",
"name": "SwitchScenes",
"category": "scenes",
"since": "0.3",
"returns": [
{
"type": "String",
"name": "scene-name",
"description": "The new scene."
},
{
"type": "Array<SceneItem>",
"name": "sources",
"description": "List of scene items in the new scene. Same specification as [`GetCurrentScene`](#getcurrentscene)."
}
],
"names": [
{
"name": "",
"description": "SwitchScenes"
}
],
"categories": [
{
"name": "",
"description": "scenes"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "SwitchScenes"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "The scene list has been modified.\nScenes have been added, removed, or renamed.",
"api": "events",
"name": "ScenesChanged",
"category": "scenes",
"since": "0.3",
"names": [
{
"name": "",
"description": "ScenesChanged"
}
],
"categories": [
{
"name": "",
"description": "scenes"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "ScenesChanged"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Triggered when switching to another scene collection or when renaming the current scene collection.",
"api": "events",
"name": "SceneCollectionChanged",
"category": "scenes",
"since": "4.0.0",
"names": [
{
"name": "",
"description": "SceneCollectionChanged"
}
],
"categories": [
{
"name": "",
"description": "scenes"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "SceneCollectionChanged"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Triggered when a scene collection is created, added, renamed, or removed.",
"api": "events",
"name": "SceneCollectionListChanged",
"category": "scenes",
"since": "4.0.0",
"names": [
{
"name": "",
"description": "SceneCollectionListChanged"
}
],
"categories": [
{
"name": "",
"description": "scenes"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "SceneCollectionListChanged"
},
"lead": "",
"type": "class",
"examples": []
}
],
"transitions": [
{
"subheads": [],
"description": "The active transition has been changed.",
"return": "{String} `transition-name` The name of the new active transition.",
"api": "events",
"name": "SwitchTransition",
"category": "transitions",
"since": "4.0.0",
"returns": [
{
"type": "String",
"name": "transition-name",
"description": "The name of the new active transition."
}
],
"names": [
{
"name": "",
"description": "SwitchTransition"
}
],
"categories": [
{
"name": "",
"description": "transitions"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "SwitchTransition"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "The list of available transitions has been modified.\nTransitions have been added, removed, or renamed.",
"api": "events",
"name": "TransitionListChanged",
"category": "transitions",
"since": "4.0.0",
"names": [
{
"name": "",
"description": "TransitionListChanged"
}
],
"categories": [
{
"name": "",
"description": "transitions"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "TransitionListChanged"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "The active transition duration has been changed.",
"return": "{int} `new-duration` New transition duration.",
"api": "events",
"name": "TransitionDurationChanged",
"category": "transitions",
"since": "4.0.0",
"returns": [
{
"type": "int",
"name": "new-duration",
"description": "New transition duration."
}
],
"names": [
{
"name": "",
"description": "TransitionDurationChanged"
}
],
"categories": [
{
"name": "",
"description": "transitions"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "TransitionDurationChanged"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "A transition (other than \"cut\") has begun.",
"return": [
"{String} `name` Transition name.",
"{String} `type` Transition type.",
"{int} `duration` Transition duration (in milliseconds).",
"{String} `from-scene` Source scene of the transition",
"{String} `to-scene` Destination scene of the transition"
],
"api": "events",
"name": "TransitionBegin",
"category": "transitions",
"since": "4.0.0",
"returns": [
{
"type": "String",
"name": "name",
"description": "Transition name."
},
{
"type": "String",
"name": "type",
"description": "Transition type."
},
{
"type": "int",
"name": "duration",
"description": "Transition duration (in milliseconds)."
},
{
"type": "String",
"name": "from-scene",
"description": "Source scene of the transition"
},
{
"type": "String",
"name": "to-scene",
"description": "Destination scene of the transition"
}
],
"names": [
{
"name": "",
"description": "TransitionBegin"
}
],
"categories": [
{
"name": "",
"description": "transitions"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "TransitionBegin"
},
"lead": "",
"type": "class",
"examples": []
}
],
"profiles": [
{
"subheads": [],
"description": "Triggered when switching to another profile or when renaming the current profile.",
"api": "events",
"name": "ProfileChanged",
"category": "profiles",
"since": "4.0.0",
"names": [
{
"name": "",
"description": "ProfileChanged"
}
],
"categories": [
{
"name": "",
"description": "profiles"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "ProfileChanged"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Triggered when a profile is created, added, renamed, or removed.",
"api": "events",
"name": "ProfileListChanged",
"category": "profiles",
"since": "4.0.0",
"names": [
{
"name": "",
"description": "ProfileListChanged"
}
],
"categories": [
{
"name": "",
"description": "profiles"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "ProfileListChanged"
},
"lead": "",
"type": "class",
"examples": []
}
],
"streaming": [
{
"subheads": [],
"description": "A request to start streaming has been issued.",
"return": "{boolean} `preview-only` Always false (retrocompatibility).",
"api": "events",
"name": "StreamStarting",
"category": "streaming",
"since": "0.3",
"returns": [
{
"type": "boolean",
"name": "preview-only",
"description": "Always false (retrocompatibility)."
}
],
"names": [
{
"name": "",
"description": "StreamStarting"
}
],
"categories": [
{
"name": "",
"description": "streaming"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "StreamStarting"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Streaming started successfully.",
"api": "events",
"name": "StreamStarted",
"category": "streaming",
"since": "0.3",
"names": [
{
"name": "",
"description": "StreamStarted"
}
],
"categories": [
{
"name": "",
"description": "streaming"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "StreamStarted"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "A request to stop streaming has been issued.",
"return": "{boolean} `preview-only` Always false (retrocompatibility).",
"api": "events",
"name": "StreamStopping",
"category": "streaming",
"since": "0.3",
"returns": [
{
"type": "boolean",
"name": "preview-only",
"description": "Always false (retrocompatibility)."
}
],
"names": [
{
"name": "",
"description": "StreamStopping"
}
],
"categories": [
{
"name": "",
"description": "streaming"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "StreamStopping"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Streaming stopped successfully.",
"api": "events",
"name": "StreamStopped",
"category": "streaming",
"since": "0.3",
"names": [
{
"name": "",
"description": "StreamStopped"
}
],
"categories": [
{
"name": "",
"description": "streaming"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "StreamStopped"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Emit every 2 seconds.",
"return": [
"{boolean} `streaming` Current streaming state.",
"{boolean} `recording` Current recording state.",
"{boolean} `replay-buffer-active` Replay Buffer status",
"{int} `bytes-per-sec` Amount of data per second (in bytes) transmitted by the stream encoder.",
"{int} `kbits-per-sec` Amount of data per second (in kilobits) transmitted by the stream encoder.",
"{double} `strain` Percentage of dropped frames.",
"{int} `total-stream-time` Total time (in seconds) since the stream started.",
"{int} `num-total-frames` Total number of frames transmitted since the stream started.",
"{int} `num-dropped-frames` Number of frames dropped by the encoder since the stream started.",
"{double} `fps` Current framerate.",
"{int} `render-total-frames` Number of frames rendered",
"{int} `render-missed-frames` Number of frames missed due to rendering lag",
"{int} `output-total-frames` Number of frames outputted",
"{int} `output-skipped-frames` Number of frames skipped due to encoding lag",
"{double} `average-frame-time` Average frame time (in milliseconds)",
"{double} `cpu-usage` Current CPU usage (percentage)",
"{double} `memory-usage` Current RAM usage (in megabytes)",
"{double} `free-disk-space` Free recording disk space (in megabytes)",
"{boolean} `preview-only` Always false (retrocompatibility)."
],
"api": "events",
"name": "StreamStatus",
"category": "streaming",
"since": "0.3",
"returns": [
{
"type": "boolean",
"name": "streaming",
"description": "Current streaming state."
},
{
"type": "boolean",
"name": "recording",
"description": "Current recording state."
},
{
"type": "boolean",
"name": "replay-buffer-active",
"description": "Replay Buffer status"
},
{
"type": "int",
"name": "bytes-per-sec",
"description": "Amount of data per second (in bytes) transmitted by the stream encoder."
},
{
"type": "int",
"name": "kbits-per-sec",
"description": "Amount of data per second (in kilobits) transmitted by the stream encoder."
},
{
"type": "double",
"name": "strain",
"description": "Percentage of dropped frames."
},
{
"type": "int",
"name": "total-stream-time",
"description": "Total time (in seconds) since the stream started."
},
{
"type": "int",
"name": "num-total-frames",
"description": "Total number of frames transmitted since the stream started."
},
{
"type": "int",
"name": "num-dropped-frames",
"description": "Number of frames dropped by the encoder since the stream started."
},
{
"type": "double",
"name": "fps",
"description": "Current framerate."
},
{
"type": "int",
"name": "render-total-frames",
"description": "Number of frames rendered"
},
{
"type": "int",
"name": "render-missed-frames",
"description": "Number of frames missed due to rendering lag"
},
{
"type": "int",
"name": "output-total-frames",
"description": "Number of frames outputted"
},
{
"type": "int",
"name": "output-skipped-frames",
"description": "Number of frames skipped due to encoding lag"
},
{
"type": "double",
"name": "average-frame-time",
"description": "Average frame time (in milliseconds)"
},
{
"type": "double",
"name": "cpu-usage",
"description": "Current CPU usage (percentage)"
},
{
"type": "double",
"name": "memory-usage",
"description": "Current RAM usage (in megabytes)"
},
{
"type": "double",
"name": "free-disk-space",
"description": "Free recording disk space (in megabytes)"
},
{
"type": "boolean",
"name": "preview-only",
"description": "Always false (retrocompatibility)."
}
],
"names": [
{
"name": "",
"description": "StreamStatus"
}
],
"categories": [
{
"name": "",
"description": "streaming"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "StreamStatus"
},
"lead": "",
"type": "class",
"examples": []
}
],
"recording": [
{
"subheads": [],
"description": "A request to start recording has been issued.",
"api": "events",
"name": "RecordingStarting",
"category": "recording",
"since": "0.3",
"names": [
{
"name": "",
"description": "RecordingStarting"
}
],
"categories": [
{
"name": "",
"description": "recording"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "RecordingStarting"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Recording started successfully.",
"api": "events",
"name": "RecordingStarted",
"category": "recording",
"since": "0.3",
"names": [
{
"name": "",
"description": "RecordingStarted"
}
],
"categories": [
{
"name": "",
"description": "recording"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "RecordingStarted"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "A request to stop recording has been issued.",
"api": "events",
"name": "RecordingStopping",
"category": "recording",
"since": "0.3",
"names": [
{
"name": "",
"description": "RecordingStopping"
}
],
"categories": [
{
"name": "",
"description": "recording"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "RecordingStopping"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Recording stopped successfully.",
"api": "events",
"name": "RecordingStopped",
"category": "recording",
"since": "0.3",
"names": [
{
"name": "",
"description": "RecordingStopped"
}
],
"categories": [
{
"name": "",
"description": "recording"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "RecordingStopped"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Current recording paused",
"api": "events",
"name": "RecordingPaused",
"category": "recording",
"since": "4.7.0",
"names": [
{
"name": "",
"description": "RecordingPaused"
}
],
"categories": [
{
"name": "",
"description": "recording"
}
],
"sinces": [
{
"name": "",
"description": "4.7.0"
}
],
"heading": {
"level": 2,
"text": "RecordingPaused"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Current recording resumed",
"api": "events",
"name": "RecordingResumed",
"category": "recording",
"since": "4.7.0",
"names": [
{
"name": "",
"description": "RecordingResumed"
}
],
"categories": [
{
"name": "",
"description": "recording"
}
],
"sinces": [
{
"name": "",
"description": "4.7.0"
}
],
"heading": {
"level": 2,
"text": "RecordingResumed"
},
"lead": "",
"type": "class",
"examples": []
}
],
"replay buffer": [
{
"subheads": [],
"description": "A request to start the replay buffer has been issued.",
"api": "events",
"name": "ReplayStarting",
"category": "replay buffer",
"since": "4.2.0",
"names": [
{
"name": "",
"description": "ReplayStarting"
}
],
"categories": [
{
"name": "",
"description": "replay buffer"
}
],
"sinces": [
{
"name": "",
"description": "4.2.0"
}
],
"heading": {
"level": 2,
"text": "ReplayStarting"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Replay Buffer started successfully",
"api": "events",
"name": "ReplayStarted",
"category": "replay buffer",
"since": "4.2.0",
"names": [
{
"name": "",
"description": "ReplayStarted"
}
],
"categories": [
{
"name": "",
"description": "replay buffer"
}
],
"sinces": [
{
"name": "",
"description": "4.2.0"
}
],
"heading": {
"level": 2,
"text": "ReplayStarted"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "A request to stop the replay buffer has been issued.",
"api": "events",
"name": "ReplayStopping",
"category": "replay buffer",
"since": "4.2.0",
"names": [
{
"name": "",
"description": "ReplayStopping"
}
],
"categories": [
{
"name": "",
"description": "replay buffer"
}
],
"sinces": [
{
"name": "",
"description": "4.2.0"
}
],
"heading": {
"level": 2,
"text": "ReplayStopping"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Replay Buffer stopped successfully",
"api": "events",
"name": "ReplayStopped",
"category": "replay buffer",
"since": "4.2.0",
"names": [
{
"name": "",
"description": "ReplayStopped"
}
],
"categories": [
{
"name": "",
"description": "replay buffer"
}
],
"sinces": [
{
"name": "",
"description": "4.2.0"
}
],
"heading": {
"level": 2,
"text": "ReplayStopped"
},
"lead": "",
"type": "class",
"examples": []
}
],
"other": [
{
"subheads": [],
"description": "OBS is exiting.",
"api": "events",
"name": "Exiting",
"category": "other",
"since": "0.3",
"names": [
{
"name": "",
"description": "Exiting"
}
],
"categories": [
{
"name": "",
"description": "other"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "Exiting"
},
"lead": "",
"type": "class",
"examples": []
}
],
"general": [
{
"subheads": [],
"description": "Emitted every 2 seconds after enabling it by calling SetHeartbeat.",
"return": [
"{boolean} `pulse` Toggles between every JSON message as an \"I am alive\" indicator.",
"{string (optional)} `current-profile` Current active profile.",
"{string (optional)} `current-scene` Current active scene.",
"{boolean (optional)} `streaming` Current streaming state.",
"{int (optional)} `total-stream-time` Total time (in seconds) since the stream started.",
"{int (optional)} `total-stream-bytes` Total bytes sent since the stream started.",
"{int (optional)} `total-stream-frames` Total frames streamed since the stream started.",
"{boolean (optional)} `recording` Current recording state.",
"{int (optional)} `total-record-time` Total time (in seconds) since recording started.",
"{int (optional)} `total-record-bytes` Total bytes recorded since the recording started.",
"{int (optional)} `total-record-frames` Total frames recorded since the recording started.",
"{OBSStats} `stats` OBS Stats"
],
"api": "events",
"name": "Heartbeat",
"category": "general",
"returns": [
{
"type": "boolean",
"name": "pulse",
"description": "Toggles between every JSON message as an \"I am alive\" indicator."
},
{
"type": "string (optional)",
"name": "current-profile",
"description": "Current active profile."
},
{
"type": "string (optional)",
"name": "current-scene",
"description": "Current active scene."
},
{
"type": "boolean (optional)",
"name": "streaming",
"description": "Current streaming state."
},
{
"type": "int (optional)",
"name": "total-stream-time",
"description": "Total time (in seconds) since the stream started."
},
{
"type": "int (optional)",
"name": "total-stream-bytes",
"description": "Total bytes sent since the stream started."
},
{
"type": "int (optional)",
"name": "total-stream-frames",
"description": "Total frames streamed since the stream started."
},
{
"type": "boolean (optional)",
"name": "recording",
"description": "Current recording state."
},
{
"type": "int (optional)",
"name": "total-record-time",
"description": "Total time (in seconds) since recording started."
},
{
"type": "int (optional)",
"name": "total-record-bytes",
"description": "Total bytes recorded since the recording started."
},
{
"type": "int (optional)",
"name": "total-record-frames",
"description": "Total frames recorded since the recording started."
},
{
"type": "OBSStats",
"name": "stats",
"description": "OBS Stats"
}
],
"names": [
{
"name": "",
"description": "Heartbeat"
}
],
"categories": [
{
"name": "",
"description": "general"
}
],
"heading": {
"level": 2,
"text": "Heartbeat"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "A custom broadcast message was received",
"return": [
"{String} `realm` Identifier provided by the sender",
"{Object} `data` User-defined data"
],
"api": "events",
"name": "BroadcastCustomMessage",
"category": "general",
"since": "4.7.0",
"returns": [
{
"type": "String",
"name": "realm",
"description": "Identifier provided by the sender"
},
{
"type": "Object",
"name": "data",
"description": "User-defined data"
}
],
"names": [
{
"name": "",
"description": "BroadcastCustomMessage"
}
],
"categories": [
{
"name": "",
"description": "general"
}
],
"sinces": [
{
"name": "",
"description": "4.7.0"
}
],
"heading": {
"level": 2,
"text": "BroadcastCustomMessage"
},
"lead": "",
"type": "class",
"examples": []
}
],
"sources": [
{
"subheads": [],
"description": "A source has been created. A source can be an input, a scene or a transition.",
"return": [
"{String} `sourceName` Source name",
"{String} `sourceType` Source type. Can be \"input\", \"scene\", \"transition\" or \"filter\".",
"{String} `sourceKind` Source kind.",
"{Object} `sourceSettings` Source settings"
],
"api": "events",
"name": "SourceCreated",
"category": "sources",
"since": "4.6.0",
"returns": [
{
"type": "String",
"name": "sourceName",
"description": "Source name"
},
{
"type": "String",
"name": "sourceType",
"description": "Source type. Can be \"input\", \"scene\", \"transition\" or \"filter\"."
},
{
"type": "String",
"name": "sourceKind",
"description": "Source kind."
},
{
"type": "Object",
"name": "sourceSettings",
"description": "Source settings"
}
],
"names": [
{
"name": "",
"description": "SourceCreated"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.6.0"
}
],
"heading": {
"level": 2,
"text": "SourceCreated"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "A source has been destroyed/removed. A source can be an input, a scene or a transition.",
"return": [
"{String} `sourceName` Source name",
"{String} `sourceType` Source type. Can be \"input\", \"scene\", \"transition\" or \"filter\".",
"{String} `sourceKind` Source kind."
],
"api": "events",
"name": "SourceDestroyed",
"category": "sources",
"since": "4.6.0",
"returns": [
{
"type": "String",
"name": "sourceName",
"description": "Source name"
},
{
"type": "String",
"name": "sourceType",
"description": "Source type. Can be \"input\", \"scene\", \"transition\" or \"filter\"."
},
{
"type": "String",
"name": "sourceKind",
"description": "Source kind."
}
],
"names": [
{
"name": "",
"description": "SourceDestroyed"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.6.0"
}
],
"heading": {
"level": 2,
"text": "SourceDestroyed"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "The volume of a source has changed.",
"return": [
"{String} `sourceName` Source name",
"{float} `volume` Source volume"
],
"api": "events",
"name": "SourceVolumeChanged",
"category": "sources",
"since": "4.6.0",
"returns": [
{
"type": "String",
"name": "sourceName",
"description": "Source name"
},
{
"type": "float",
"name": "volume",
"description": "Source volume"
}
],
"names": [
{
"name": "",
"description": "SourceVolumeChanged"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.6.0"
}
],
"heading": {
"level": 2,
"text": "SourceVolumeChanged"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "A source has been muted or unmuted.",
"return": [
"{String} `sourceName` Source name",
"{boolean} `muted` Mute status of the source"
],
"api": "events",
"name": "SourceMuteStateChanged",
"category": "sources",
"since": "4.6.0",
"returns": [
{
"type": "String",
"name": "sourceName",
"description": "Source name"
},
{
"type": "boolean",
"name": "muted",
"description": "Mute status of the source"
}
],
"names": [
{
"name": "",
"description": "SourceMuteStateChanged"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.6.0"
}
],
"heading": {
"level": 2,
"text": "SourceMuteStateChanged"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "The audio sync offset of a source has changed.",
"return": [
"{String} `sourceName` Source name",
"{int} `syncOffset` Audio sync offset of the source (in nanoseconds)"
],
"api": "events",
"name": "SourceAudioSyncOffsetChanged",
"category": "sources",
"since": "4.6.0",
"returns": [
{
"type": "String",
"name": "sourceName",
"description": "Source name"
},
{
"type": "int",
"name": "syncOffset",
"description": "Audio sync offset of the source (in nanoseconds)"
}
],
"names": [
{
"name": "",
"description": "SourceAudioSyncOffsetChanged"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.6.0"
}
],
"heading": {
"level": 2,
"text": "SourceAudioSyncOffsetChanged"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Audio mixer routing changed on a source.",
"return": [
"{String} `sourceName` Source name",
"{Array<Object>} `mixers` Routing status of the source for each audio mixer (array of 6 values)",
"{int} `mixers.*.id` Mixer number",
"{boolean} `mixers.*.enabled` Routing status",
"{String} `hexMixersValue` Raw mixer flags (little-endian, one bit per mixer) as an hexadecimal value"
],
"api": "events",
"name": "SourceAudioMixersChanged",
"category": "sources",
"since": "4.6.0",
"returns": [
{
"type": "String",
"name": "sourceName",
"description": "Source name"
},
{
"type": "Array<Object>",
"name": "mixers",
"description": "Routing status of the source for each audio mixer (array of 6 values)"
},
{
"type": "int",
"name": "mixers.*.id",
"description": "Mixer number"
},
{
"type": "boolean",
"name": "mixers.*.enabled",
"description": "Routing status"
},
{
"type": "String",
"name": "hexMixersValue",
"description": "Raw mixer flags (little-endian, one bit per mixer) as an hexadecimal value"
}
],
"names": [
{
"name": "",
"description": "SourceAudioMixersChanged"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.6.0"
}
],
"heading": {
"level": 2,
"text": "SourceAudioMixersChanged"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "A source has been renamed.",
"return": [
"{String} `previousName` Previous source name",
"{String} `newName` New source name"
],
"api": "events",
"name": "SourceRenamed",
"category": "sources",
"since": "4.6.0",
"returns": [
{
"type": "String",
"name": "previousName",
"description": "Previous source name"
},
{
"type": "String",
"name": "newName",
"description": "New source name"
}
],
"names": [
{
"name": "",
"description": "SourceRenamed"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.6.0"
}
],
"heading": {
"level": 2,
"text": "SourceRenamed"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "A filter was added to a source.",
"return": [
"{String} `sourceName` Source name",
"{String} `filterName` Filter name",
"{String} `filterType` Filter type",
"{Object} `filterSettings` Filter settings"
],
"api": "events",
"name": "SourceFilterAdded",
"category": "sources",
"since": "4.6.0",
"returns": [
{
"type": "String",
"name": "sourceName",
"description": "Source name"
},
{
"type": "String",
"name": "filterName",
"description": "Filter name"
},
{
"type": "String",
"name": "filterType",
"description": "Filter type"
},
{
"type": "Object",
"name": "filterSettings",
"description": "Filter settings"
}
],
"names": [
{
"name": "",
"description": "SourceFilterAdded"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.6.0"
}
],
"heading": {
"level": 2,
"text": "SourceFilterAdded"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "A filter was removed from a source.",
"return": [
"{String} `sourceName` Source name",
"{String} `filterName` Filter name",
"{String} `filterType` Filter type"
],
"api": "events",
"name": "SourceFilterRemoved",
"category": "sources",
"since": "4.6.0",
"returns": [
{
"type": "String",
"name": "sourceName",
"description": "Source name"
},
{
"type": "String",
"name": "filterName",
"description": "Filter name"
},
{
"type": "String",
"name": "filterType",
"description": "Filter type"
}
],
"names": [
{
"name": "",
"description": "SourceFilterRemoved"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.6.0"
}
],
"heading": {
"level": 2,
"text": "SourceFilterRemoved"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "The visibility/enabled state of a filter changed",
"return": [
"{String} `sourceName` Source name",
"{String} `filterName` Filter name",
"{Boolean} `filterEnabled` New filter state"
],
"api": "events",
"name": "SourceFilterVisibilityChanged",
"category": "sources",
"since": "4.7.0",
"returns": [
{
"type": "String",
"name": "sourceName",
"description": "Source name"
},
{
"type": "String",
"name": "filterName",
"description": "Filter name"
},
{
"type": "Boolean",
"name": "filterEnabled",
"description": "New filter state"
}
],
"names": [
{
"name": "",
"description": "SourceFilterVisibilityChanged"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.7.0"
}
],
"heading": {
"level": 2,
"text": "SourceFilterVisibilityChanged"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Filters in a source have been reordered.",
"return": [
"{String} `sourceName` Source name",
"{Array<Object>} `filters` Ordered Filters list",
"{String} `filters.*.name` Filter name",
"{String} `filters.*.type` Filter type"
],
"api": "events",
"name": "SourceFiltersReordered",
"category": "sources",
"since": "4.6.0",
"returns": [
{
"type": "String",
"name": "sourceName",
"description": "Source name"
},
{
"type": "Array<Object>",
"name": "filters",
"description": "Ordered Filters list"
},
{
"type": "String",
"name": "filters.*.name",
"description": "Filter name"
},
{
"type": "String",
"name": "filters.*.type",
"description": "Filter type"
}
],
"names": [
{
"name": "",
"description": "SourceFiltersReordered"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.6.0"
}
],
"heading": {
"level": 2,
"text": "SourceFiltersReordered"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Scene items have been reordered.",
"return": [
"{String} `scene-name` Name of the scene where items have been reordered.",
"{Array<Object>} `scene-items` Ordered list of scene items",
"{String} `scene-items.*.source-name` Item source name",
"{int} `scene-items.*.item-id` Scene item unique ID"
],
"api": "events",
"name": "SourceOrderChanged",
"category": "sources",
"since": "4.0.0",
"returns": [
{
"type": "String",
"name": "scene-name",
"description": "Name of the scene where items have been reordered."
},
{
"type": "Array<Object>",
"name": "scene-items",
"description": "Ordered list of scene items"
},
{
"type": "String",
"name": "scene-items.*.source-name",
"description": "Item source name"
},
{
"type": "int",
"name": "scene-items.*.item-id",
"description": "Scene item unique ID"
}
],
"names": [
{
"name": "",
"description": "SourceOrderChanged"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "SourceOrderChanged"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "An item has been added to the current scene.",
"return": [
"{String} `scene-name` Name of the scene.",
"{String} `item-name` Name of the item added to the scene.",
"{int} `item-id` Scene item ID"
],
"api": "events",
"name": "SceneItemAdded",
"category": "sources",
"since": "4.0.0",
"returns": [
{
"type": "String",
"name": "scene-name",
"description": "Name of the scene."
},
{
"type": "String",
"name": "item-name",
"description": "Name of the item added to the scene."
},
{
"type": "int",
"name": "item-id",
"description": "Scene item ID"
}
],
"names": [
{
"name": "",
"description": "SceneItemAdded"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "SceneItemAdded"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "An item has been removed from the current scene.",
"return": [
"{String} `scene-name` Name of the scene.",
"{String} `item-name` Name of the item removed from the scene.",
"{int} `item-id` Scene item ID"
],
"api": "events",
"name": "SceneItemRemoved",
"category": "sources",
"since": "4.0.0",
"returns": [
{
"type": "String",
"name": "scene-name",
"description": "Name of the scene."
},
{
"type": "String",
"name": "item-name",
"description": "Name of the item removed from the scene."
},
{
"type": "int",
"name": "item-id",
"description": "Scene item ID"
}
],
"names": [
{
"name": "",
"description": "SceneItemRemoved"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "SceneItemRemoved"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "An item's visibility has been toggled.",
"return": [
"{String} `scene-name` Name of the scene.",
"{String} `item-name` Name of the item in the scene.",
"{int} `item-id` Scene item ID",
"{boolean} `item-visible` New visibility state of the item."
],
"api": "events",
"name": "SceneItemVisibilityChanged",
"category": "sources",
"since": "4.0.0",
"returns": [
{
"type": "String",
"name": "scene-name",
"description": "Name of the scene."
},
{
"type": "String",
"name": "item-name",
"description": "Name of the item in the scene."
},
{
"type": "int",
"name": "item-id",
"description": "Scene item ID"
},
{
"type": "boolean",
"name": "item-visible",
"description": "New visibility state of the item."
}
],
"names": [
{
"name": "",
"description": "SceneItemVisibilityChanged"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "SceneItemVisibilityChanged"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "An item's transform has been changed.",
"return": [
"{String} `scene-name` Name of the scene.",
"{String} `item-name` Name of the item in the scene.",
"{int} `item-id` Scene item ID",
"{SceneItemTransform} `transform` Scene item transform properties"
],
"api": "events",
"name": "SceneItemTransformChanged",
"category": "sources",
"since": "4.6.0",
"returns": [
{
"type": "String",
"name": "scene-name",
"description": "Name of the scene."
},
{
"type": "String",
"name": "item-name",
"description": "Name of the item in the scene."
},
{
"type": "int",
"name": "item-id",
"description": "Scene item ID"
},
{
"type": "SceneItemTransform",
"name": "transform",
"description": "Scene item transform properties"
}
],
"names": [
{
"name": "",
"description": "SceneItemTransformChanged"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.6.0"
}
],
"heading": {
"level": 2,
"text": "SceneItemTransformChanged"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "A scene item is selected.",
"return": [
"{String} `scene-name` Name of the scene.",
"{String} `item-name` Name of the item in the scene.",
"{int} `item-id` Name of the item in the scene."
],
"api": "events",
"name": "SceneItemSelected",
"category": "sources",
"since": "4.6.0",
"returns": [
{
"type": "String",
"name": "scene-name",
"description": "Name of the scene."
},
{
"type": "String",
"name": "item-name",
"description": "Name of the item in the scene."
},
{
"type": "int",
"name": "item-id",
"description": "Name of the item in the scene."
}
],
"names": [
{
"name": "",
"description": "SceneItemSelected"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.6.0"
}
],
"heading": {
"level": 2,
"text": "SceneItemSelected"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "A scene item is deselected.",
"return": [
"{String} `scene-name` Name of the scene.",
"{String} `item-name` Name of the item in the scene.",
"{int} `item-id` Name of the item in the scene."
],
"api": "events",
"name": "SceneItemDeselected",
"category": "sources",
"since": "4.6.0",
"returns": [
{
"type": "String",
"name": "scene-name",
"description": "Name of the scene."
},
{
"type": "String",
"name": "item-name",
"description": "Name of the item in the scene."
},
{
"type": "int",
"name": "item-id",
"description": "Name of the item in the scene."
}
],
"names": [
{
"name": "",
"description": "SceneItemDeselected"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.6.0"
}
],
"heading": {
"level": 2,
"text": "SceneItemDeselected"
},
"lead": "",
"type": "class",
"examples": []
}
],
"studio mode": [
{
"subheads": [],
"description": "The selected preview scene has changed (only available in Studio Mode).",
"return": [
"{String} `scene-name` Name of the scene being previewed.",
"{Array<SceneItem>} `sources` List of sources composing the scene. Same specification as [`GetCurrentScene`](#getcurrentscene)."
],
"api": "events",
"name": "PreviewSceneChanged",
"category": "studio mode",
"since": "4.1.0",
"returns": [
{
"type": "String",
"name": "scene-name",
"description": "Name of the scene being previewed."
},
{
"type": "Array<SceneItem>",
"name": "sources",
"description": "List of sources composing the scene. Same specification as [`GetCurrentScene`](#getcurrentscene)."
}
],
"names": [
{
"name": "",
"description": "PreviewSceneChanged"
}
],
"categories": [
{
"name": "",
"description": "studio mode"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "PreviewSceneChanged"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Studio Mode has been enabled or disabled.",
"return": "{boolean} `new-state` The new enabled state of Studio Mode.",
"api": "events",
"name": "StudioModeSwitched",
"category": "studio mode",
"since": "4.1.0",
"returns": [
{
"type": "boolean",
"name": "new-state",
"description": "The new enabled state of Studio Mode."
}
],
"names": [
{
"name": "",
"description": "StudioModeSwitched"
}
],
"categories": [
{
"name": "",
"description": "studio mode"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "StudioModeSwitched"
},
"lead": "",
"type": "class",
"examples": []
}
]
},
"requests": {
"general": [
{
"subheads": [],
"description": "Returns the latest version of the plugin and the API.",
"return": [
"{double} `version` OBSRemote compatible API version. Fixed to 1.1 for retrocompatibility.",
"{String} `obs-websocket-version` obs-websocket plugin version.",
"{String} `obs-studio-version` OBS Studio program version.",
"{String} `available-requests` List of available request types, formatted as a comma-separated list string (e.g. : \"Method1,Method2,Method3\")."
],
"api": "requests",
"name": "GetVersion",
"category": "general",
"since": "0.3",
"returns": [
{
"type": "double",
"name": "version",
"description": "OBSRemote compatible API version. Fixed to 1.1 for retrocompatibility."
},
{
"type": "String",
"name": "obs-websocket-version",
"description": "obs-websocket plugin version."
},
{
"type": "String",
"name": "obs-studio-version",
"description": "OBS Studio program version."
},
{
"type": "String",
"name": "available-requests",
"description": "List of available request types, formatted as a comma-separated list string (e.g. : \"Method1,Method2,Method3\")."
}
],
"names": [
{
"name": "",
"description": "GetVersion"
}
],
"categories": [
{
"name": "",
"description": "general"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "GetVersion"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Tells the client if authentication is required. If so, returns authentication parameters `challenge`\nand `salt` (see \"Authentication\" for more information).",
"return": [
"{boolean} `authRequired` Indicates whether authentication is required.",
"{String (optional)} `challenge`",
"{String (optional)} `salt`"
],
"api": "requests",
"name": "GetAuthRequired",
"category": "general",
"since": "0.3",
"returns": [
{
"type": "boolean",
"name": "authRequired",
"description": "Indicates whether authentication is required."
},
{
"type": "String (optional)",
"name": "challenge",
"description": ""
},
{
"type": "String (optional)",
"name": "salt",
"description": ""
}
],
"names": [
{
"name": "",
"description": "GetAuthRequired"
}
],
"categories": [
{
"name": "",
"description": "general"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "GetAuthRequired"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Attempt to authenticate the client to the server.",
"param": "{String} `auth` Response to the auth challenge (see \"Authentication\" for more information).",
"api": "requests",
"name": "Authenticate",
"category": "general",
"since": "0.3",
"params": [
{
"type": "String",
"name": "auth",
"description": "Response to the auth challenge (see \"Authentication\" for more information)."
}
],
"names": [
{
"name": "",
"description": "Authenticate"
}
],
"categories": [
{
"name": "",
"description": "general"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "Authenticate"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Enable/disable sending of the Heartbeat event",
"param": "{boolean} `enable` Starts/Stops emitting heartbeat messages",
"api": "requests",
"name": "SetHeartbeat",
"category": "general",
"since": "4.3.0",
"params": [
{
"type": "boolean",
"name": "enable",
"description": "Starts/Stops emitting heartbeat messages"
}
],
"names": [
{
"name": "",
"description": "SetHeartbeat"
}
],
"categories": [
{
"name": "",
"description": "general"
}
],
"sinces": [
{
"name": "",
"description": "4.3.0"
}
],
"heading": {
"level": 2,
"text": "SetHeartbeat"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Set the filename formatting string",
"param": "{String} `filename-formatting` Filename formatting string to set.",
"api": "requests",
"name": "SetFilenameFormatting",
"category": "general",
"since": "4.3.0",
"params": [
{
"type": "String",
"name": "filename-formatting",
"description": "Filename formatting string to set."
}
],
"names": [
{
"name": "",
"description": "SetFilenameFormatting"
}
],
"categories": [
{
"name": "",
"description": "general"
}
],
"sinces": [
{
"name": "",
"description": "4.3.0"
}
],
"heading": {
"level": 2,
"text": "SetFilenameFormatting"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get the filename formatting string",
"return": "{String} `filename-formatting` Current filename formatting string.",
"api": "requests",
"name": "GetFilenameFormatting",
"category": "general",
"since": "4.3.0",
"returns": [
{
"type": "String",
"name": "filename-formatting",
"description": "Current filename formatting string."
}
],
"names": [
{
"name": "",
"description": "GetFilenameFormatting"
}
],
"categories": [
{
"name": "",
"description": "general"
}
],
"sinces": [
{
"name": "",
"description": "4.3.0"
}
],
"heading": {
"level": 2,
"text": "GetFilenameFormatting"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get OBS stats (almost the same info as provided in OBS' stats window)",
"return": "{OBSStats} `stats` OBS stats",
"api": "requests",
"name": "GetStats",
"category": "general",
"since": "4.6.0",
"returns": [
{
"type": "OBSStats",
"name": "stats",
"description": "OBS stats"
}
],
"names": [
{
"name": "",
"description": "GetStats"
}
],
"categories": [
{
"name": "",
"description": "general"
}
],
"sinces": [
{
"name": "",
"description": "4.6.0"
}
],
"heading": {
"level": 2,
"text": "GetStats"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Broadcast custom message to all connected WebSocket clients",
"param": [
"{String} `realm` Identifier to be choosen by the client",
"{Object} `data` User-defined data"
],
"api": "requests",
"name": "BroadcastCustomMessage",
"category": "general",
"since": "4.7.0",
"params": [
{
"type": "String",
"name": "realm",
"description": "Identifier to be choosen by the client"
},
{
"type": "Object",
"name": "data",
"description": "User-defined data"
}
],
"names": [
{
"name": "",
"description": "BroadcastCustomMessage"
}
],
"categories": [
{
"name": "",
"description": "general"
}
],
"sinces": [
{
"name": "",
"description": "4.7.0"
}
],
"heading": {
"level": 2,
"text": "BroadcastCustomMessage"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get basic OBS video information",
"return": [
"{int} `baseWidth` Base (canvas) width",
"{int} `baseHeight` Base (canvas) height",
"{int} `outputWidth` Output width",
"{int} `outputHeight` Output height",
"{String} `scaleType` Scaling method used if output size differs from base size",
"{double} `fps` Frames rendered per second",
"{String} `videoFormat` Video color format",
"{String} `colorSpace` Color space for YUV",
"{String} `colorRange` Color range (full or partial)"
],
"api": "requests",
"name": "GetVideoInfo",
"category": "general",
"since": "4.6.0",
"returns": [
{
"type": "int",
"name": "baseWidth",
"description": "Base (canvas) width"
},
{
"type": "int",
"name": "baseHeight",
"description": "Base (canvas) height"
},
{
"type": "int",
"name": "outputWidth",
"description": "Output width"
},
{
"type": "int",
"name": "outputHeight",
"description": "Output height"
},
{
"type": "String",
"name": "scaleType",
"description": "Scaling method used if output size differs from base size"
},
{
"type": "double",
"name": "fps",
"description": "Frames rendered per second"
},
{
"type": "String",
"name": "videoFormat",
"description": "Video color format"
},
{
"type": "String",
"name": "colorSpace",
"description": "Color space for YUV"
},
{
"type": "String",
"name": "colorRange",
"description": "Color range (full or partial)"
}
],
"names": [
{
"name": "",
"description": "GetVideoInfo"
}
],
"categories": [
{
"name": "",
"description": "general"
}
],
"sinces": [
{
"name": "",
"description": "4.6.0"
}
],
"heading": {
"level": 2,
"text": "GetVideoInfo"
},
"lead": "",
"type": "class",
"examples": []
}
],
"outputs": [
{
"subheads": [],
"description": "List existing outputs",
"return": "{Array<Output>} `outputs` Outputs list",
"api": "requests",
"name": "ListOutputs",
"category": "outputs",
"since": "4.7.0",
"returns": [
{
"type": "Array<Output>",
"name": "outputs",
"description": "Outputs list"
}
],
"names": [
{
"name": "",
"description": "ListOutputs"
}
],
"categories": [
{
"name": "",
"description": "outputs"
}
],
"sinces": [
{
"name": "",
"description": "4.7.0"
}
],
"heading": {
"level": 2,
"text": "ListOutputs"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get information about a single output",
"param": "{String} `outputName` Output name",
"return": "{Output} `outputInfo` Output info",
"api": "requests",
"name": "GetOutputInfo",
"category": "outputs",
"since": "4.7.0",
"returns": [
{
"type": "Output",
"name": "outputInfo",
"description": "Output info"
}
],
"params": [
{
"type": "String",
"name": "outputName",
"description": "Output name"
}
],
"names": [
{
"name": "",
"description": "GetOutputInfo"
}
],
"categories": [
{
"name": "",
"description": "outputs"
}
],
"sinces": [
{
"name": "",
"description": "4.7.0"
}
],
"heading": {
"level": 2,
"text": "GetOutputInfo"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Start an output",
"param": "{String} `outputName` Output name",
"api": "requests",
"name": "StartOutput",
"category": "outputs",
"since": "4.7.0",
"params": [
{
"type": "String",
"name": "outputName",
"description": "Output name"
}
],
"names": [
{
"name": "",
"description": "StartOutput"
}
],
"categories": [
{
"name": "",
"description": "outputs"
}
],
"sinces": [
{
"name": "",
"description": "4.7.0"
}
],
"heading": {
"level": 2,
"text": "StartOutput"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Stop an output",
"param": [
"{String} `outputName` Output name",
"{boolean (optional)} `force` Force stop (default: false)"
],
"api": "requests",
"name": "StopOutput",
"category": "outputs",
"since": "4.7.0",
"params": [
{
"type": "String",
"name": "outputName",
"description": "Output name"
},
{
"type": "boolean (optional)",
"name": "force",
"description": "Force stop (default: false)"
}
],
"names": [
{
"name": "",
"description": "StopOutput"
}
],
"categories": [
{
"name": "",
"description": "outputs"
}
],
"sinces": [
{
"name": "",
"description": "4.7.0"
}
],
"heading": {
"level": 2,
"text": "StopOutput"
},
"lead": "",
"type": "class",
"examples": []
}
],
"profiles": [
{
"subheads": [],
"description": "Set the currently active profile.",
"param": "{String} `profile-name` Name of the desired profile.",
"api": "requests",
"name": "SetCurrentProfile",
"category": "profiles",
"since": "4.0.0",
"params": [
{
"type": "String",
"name": "profile-name",
"description": "Name of the desired profile."
}
],
"names": [
{
"name": "",
"description": "SetCurrentProfile"
}
],
"categories": [
{
"name": "",
"description": "profiles"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "SetCurrentProfile"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get the name of the current profile.",
"return": "{String} `profile-name` Name of the currently active profile.",
"api": "requests",
"name": "GetCurrentProfile",
"category": "profiles",
"since": "4.0.0",
"returns": [
{
"type": "String",
"name": "profile-name",
"description": "Name of the currently active profile."
}
],
"names": [
{
"name": "",
"description": "GetCurrentProfile"
}
],
"categories": [
{
"name": "",
"description": "profiles"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "GetCurrentProfile"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get a list of available profiles.",
"return": "{Array<Object>} `profiles` List of available profiles.",
"api": "requests",
"name": "ListProfiles",
"category": "profiles",
"since": "4.0.0",
"returns": [
{
"type": "Array<Object>",
"name": "profiles",
"description": "List of available profiles."
}
],
"names": [
{
"name": "",
"description": "ListProfiles"
}
],
"categories": [
{
"name": "",
"description": "profiles"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "ListProfiles"
},
"lead": "",
"type": "class",
"examples": []
}
],
"recording": [
{
"subheads": [],
"description": "Toggle recording on or off.",
"api": "requests",
"name": "StartStopRecording",
"category": "recording",
"since": "0.3",
"names": [
{
"name": "",
"description": "StartStopRecording"
}
],
"categories": [
{
"name": "",
"description": "recording"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "StartStopRecording"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Start recording.\nWill return an `error` if recording is already active.",
"api": "requests",
"name": "StartRecording",
"category": "recording",
"since": "4.1.0",
"names": [
{
"name": "",
"description": "StartRecording"
}
],
"categories": [
{
"name": "",
"description": "recording"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "StartRecording"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Stop recording.\nWill return an `error` if recording is not active.",
"api": "requests",
"name": "StopRecording",
"category": "recording",
"since": "4.1.0",
"names": [
{
"name": "",
"description": "StopRecording"
}
],
"categories": [
{
"name": "",
"description": "recording"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "StopRecording"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Pause the current recording.\nReturns an error if recording is not active or already paused.",
"api": "requests",
"name": "PauseRecording",
"category": "recording",
"since": "4.7.0",
"names": [
{
"name": "",
"description": "PauseRecording"
}
],
"categories": [
{
"name": "",
"description": "recording"
}
],
"sinces": [
{
"name": "",
"description": "4.7.0"
}
],
"heading": {
"level": 2,
"text": "PauseRecording"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Resume/unpause the current recording (if paused).\nReturns an error if recording is not active or not paused.",
"api": "requests",
"name": "ResumeRecording",
"category": "recording",
"since": "4.7.0",
"names": [
{
"name": "",
"description": "ResumeRecording"
}
],
"categories": [
{
"name": "",
"description": "recording"
}
],
"sinces": [
{
"name": "",
"description": "4.7.0"
}
],
"heading": {
"level": 2,
"text": "ResumeRecording"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "\n\nPlease note: if `SetRecordingFolder` is called while a recording is\nin progress, the change won't be applied immediately and will be\neffective on the next recording.",
"param": "{String} `rec-folder` Path of the recording folder.",
"api": "requests",
"name": "SetRecordingFolder",
"category": "recording",
"since": "4.1.0",
"params": [
{
"type": "String",
"name": "rec-folder",
"description": "Path of the recording folder."
}
],
"names": [
{
"name": "",
"description": "SetRecordingFolder"
}
],
"categories": [
{
"name": "",
"description": "recording"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "SetRecordingFolder"
},
"lead": "In the current profile, sets the recording folder of the Simple and Advanced output modes to the specified value.",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get the path of the current recording folder.",
"return": "{String} `rec-folder` Path of the recording folder.",
"api": "requests",
"name": "GetRecordingFolder",
"category": "recording",
"since": "4.1.0",
"returns": [
{
"type": "String",
"name": "rec-folder",
"description": "Path of the recording folder."
}
],
"names": [
{
"name": "",
"description": "GetRecordingFolder"
}
],
"categories": [
{
"name": "",
"description": "recording"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "GetRecordingFolder"
},
"lead": "",
"type": "class",
"examples": []
}
],
"replay buffer": [
{
"subheads": [],
"description": "Toggle the Replay Buffer on/off.",
"api": "requests",
"name": "StartStopReplayBuffer",
"category": "replay buffer",
"since": "4.2.0",
"names": [
{
"name": "",
"description": "StartStopReplayBuffer"
}
],
"categories": [
{
"name": "",
"description": "replay buffer"
}
],
"sinces": [
{
"name": "",
"description": "4.2.0"
}
],
"heading": {
"level": 2,
"text": "StartStopReplayBuffer"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Start recording into the Replay Buffer.\nWill return an `error` if the Replay Buffer is already active or if the\n\"Save Replay Buffer\" hotkey is not set in OBS' settings.\nSetting this hotkey is mandatory, even when triggering saves only\nthrough obs-websocket.",
"api": "requests",
"name": "StartReplayBuffer",
"category": "replay buffer",
"since": "4.2.0",
"names": [
{
"name": "",
"description": "StartReplayBuffer"
}
],
"categories": [
{
"name": "",
"description": "replay buffer"
}
],
"sinces": [
{
"name": "",
"description": "4.2.0"
}
],
"heading": {
"level": 2,
"text": "StartReplayBuffer"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Stop recording into the Replay Buffer.\nWill return an `error` if the Replay Buffer is not active.",
"api": "requests",
"name": "StopReplayBuffer",
"category": "replay buffer",
"since": "4.2.0",
"names": [
{
"name": "",
"description": "StopReplayBuffer"
}
],
"categories": [
{
"name": "",
"description": "replay buffer"
}
],
"sinces": [
{
"name": "",
"description": "4.2.0"
}
],
"heading": {
"level": 2,
"text": "StopReplayBuffer"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Flush and save the contents of the Replay Buffer to disk. This is\nbasically the same as triggering the \"Save Replay Buffer\" hotkey.\nWill return an `error` if the Replay Buffer is not active.",
"api": "requests",
"name": "SaveReplayBuffer",
"category": "replay buffer",
"since": "4.2.0",
"names": [
{
"name": "",
"description": "SaveReplayBuffer"
}
],
"categories": [
{
"name": "",
"description": "replay buffer"
}
],
"sinces": [
{
"name": "",
"description": "4.2.0"
}
],
"heading": {
"level": 2,
"text": "SaveReplayBuffer"
},
"lead": "",
"type": "class",
"examples": []
}
],
"scene collections": [
{
"subheads": [],
"description": "Change the active scene collection.",
"param": "{String} `sc-name` Name of the desired scene collection.",
"api": "requests",
"name": "SetCurrentSceneCollection",
"category": "scene collections",
"since": "4.0.0",
"params": [
{
"type": "String",
"name": "sc-name",
"description": "Name of the desired scene collection."
}
],
"names": [
{
"name": "",
"description": "SetCurrentSceneCollection"
}
],
"categories": [
{
"name": "",
"description": "scene collections"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "SetCurrentSceneCollection"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get the name of the current scene collection.",
"return": "{String} `sc-name` Name of the currently active scene collection.",
"api": "requests",
"name": "GetCurrentSceneCollection",
"category": "scene collections",
"since": "4.0.0",
"returns": [
{
"type": "String",
"name": "sc-name",
"description": "Name of the currently active scene collection."
}
],
"names": [
{
"name": "",
"description": "GetCurrentSceneCollection"
}
],
"categories": [
{
"name": "",
"description": "scene collections"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "GetCurrentSceneCollection"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "List available scene collections",
"return": "{Array<String>} `scene-collections` Scene collections list",
"api": "requests",
"name": "ListSceneCollections",
"category": "scene collections",
"since": "4.0.0",
"returns": [
{
"type": "Array<String>",
"name": "scene-collections",
"description": "Scene collections list"
}
],
"names": [
{
"name": "",
"description": "ListSceneCollections"
}
],
"categories": [
{
"name": "",
"description": "scene collections"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "ListSceneCollections"
},
"lead": "",
"type": "class",
"examples": []
}
],
"scene items": [
{
"subheads": [],
"description": "Gets the scene specific properties of the specified source item.\nCoordinates are relative to the item's parent (the scene or group it belongs to).",
"param": [
"{String (optional)} `scene-name` the name of the scene that the source item belongs to. Defaults to the current scene.",
"{String} `item` The name of the source."
],
"return": [
"{String} `name` The name of the source.",
"{int} `position.x` The x position of the source from the left.",
"{int} `position.y` The y position of the source from the top.",
"{int} `position.alignment` The point on the source that the item is manipulated from.",
"{double} `rotation` The clockwise rotation of the item in degrees around the point of alignment.",
"{double} `scale.x` The x-scale factor of the source.",
"{double} `scale.y` The y-scale factor of the source.",
"{int} `crop.top` The number of pixels cropped off the top of the source before scaling.",
"{int} `crop.right` The number of pixels cropped off the right of the source before scaling.",
"{int} `crop.bottom` The number of pixels cropped off the bottom of the source before scaling.",
"{int} `crop.left` The number of pixels cropped off the left of the source before scaling.",
"{bool} `visible` If the source is visible.",
"{bool} `locked` If the source's transform is locked.",
"{String} `bounds.type` Type of bounding box. Can be \"OBS_BOUNDS_STRETCH\", \"OBS_BOUNDS_SCALE_INNER\", \"OBS_BOUNDS_SCALE_OUTER\", \"OBS_BOUNDS_SCALE_TO_WIDTH\", \"OBS_BOUNDS_SCALE_TO_HEIGHT\", \"OBS_BOUNDS_MAX_ONLY\" or \"OBS_BOUNDS_NONE\".",
"{int} `bounds.alignment` Alignment of the bounding box.",
"{double} `bounds.x` Width of the bounding box.",
"{double} `bounds.y` Height of the bounding box.",
"{int} `sourceWidth` Base width (without scaling) of the source",
"{int} `sourceHeight` Base source (without scaling) of the source",
"{double} `width` Scene item width (base source width multiplied by the horizontal scaling factor)",
"{double} `height` Scene item height (base source height multiplied by the vertical scaling factor)"
],
"property": [
"{String (optional)} `parentGroupName` Name of the item's parent (if this item belongs to a group)",
"{Array<SceneItemTransform> (optional)} `groupChildren` List of children (if this item is a group)"
],
"api": "requests",
"name": "GetSceneItemProperties",
"category": "scene items",
"since": "4.3.0",
"returns": [
{
"type": "String",
"name": "name",
"description": "The name of the source."
},
{
"type": "int",
"name": "position.x",
"description": "The x position of the source from the left."
},
{
"type": "int",
"name": "position.y",
"description": "The y position of the source from the top."
},
{
"type": "int",
"name": "position.alignment",
"description": "The point on the source that the item is manipulated from."
},
{
"type": "double",
"name": "rotation",
"description": "The clockwise rotation of the item in degrees around the point of alignment."
},
{
"type": "double",
"name": "scale.x",
"description": "The x-scale factor of the source."
},
{
"type": "double",
"name": "scale.y",
"description": "The y-scale factor of the source."
},
{
"type": "int",
"name": "crop.top",
"description": "The number of pixels cropped off the top of the source before scaling."
},
{
"type": "int",
"name": "crop.right",
"description": "The number of pixels cropped off the right of the source before scaling."
},
{
"type": "int",
"name": "crop.bottom",
"description": "The number of pixels cropped off the bottom of the source before scaling."
},
{
"type": "int",
"name": "crop.left",
"description": "The number of pixels cropped off the left of the source before scaling."
},
{
"type": "bool",
"name": "visible",
"description": "If the source is visible."
},
{
"type": "bool",
"name": "locked",
"description": "If the source's transform is locked."
},
{
"type": "String",
"name": "bounds.type",
"description": "Type of bounding box. Can be \"OBS_BOUNDS_STRETCH\", \"OBS_BOUNDS_SCALE_INNER\", \"OBS_BOUNDS_SCALE_OUTER\", \"OBS_BOUNDS_SCALE_TO_WIDTH\", \"OBS_BOUNDS_SCALE_TO_HEIGHT\", \"OBS_BOUNDS_MAX_ONLY\" or \"OBS_BOUNDS_NONE\"."
},
{
"type": "int",
"name": "bounds.alignment",
"description": "Alignment of the bounding box."
},
{
"type": "double",
"name": "bounds.x",
"description": "Width of the bounding box."
},
{
"type": "double",
"name": "bounds.y",
"description": "Height of the bounding box."
},
{
"type": "int",
"name": "sourceWidth",
"description": "Base width (without scaling) of the source"
},
{
"type": "int",
"name": "sourceHeight",
"description": "Base source (without scaling) of the source"
},
{
"type": "double",
"name": "width",
"description": "Scene item width (base source width multiplied by the horizontal scaling factor)"
},
{
"type": "double",
"name": "height",
"description": "Scene item height (base source height multiplied by the vertical scaling factor)"
}
],
"params": [
{
"type": "String (optional)",
"name": "scene-name",
"description": "the name of the scene that the source item belongs to. Defaults to the current scene."
},
{
"type": "String",
"name": "item",
"description": "The name of the source."
}
],
"properties": [
{
"type": "String (optional)",
"name": "parentGroupName",
"description": "Name of the item's parent (if this item belongs to a group)"
},
{
"type": "Array<SceneItemTransform> (optional)",
"name": "groupChildren",
"description": "List of children (if this item is a group)"
}
],
"names": [
{
"name": "",
"description": "GetSceneItemProperties"
}
],
"categories": [
{
"name": "",
"description": "scene items"
}
],
"sinces": [
{
"name": "",
"description": "4.3.0"
}
],
"heading": {
"level": 2,
"text": "GetSceneItemProperties"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Sets the scene specific properties of a source. Unspecified properties will remain unchanged.\nCoordinates are relative to the item's parent (the scene or group it belongs to).",
"param": [
"{String (optional)} `scene-name` the name of the scene that the source item belongs to. Defaults to the current scene.",
"{String} `item` The name of the source.",
"{int (optional)} `position.x` The new x position of the source.",
"{int (optional)} `position.y` The new y position of the source.",
"{int (optional)} `position.alignment` The new alignment of the source.",
"{double (optional)} `rotation` The new clockwise rotation of the item in degrees.",
"{double (optional)} `scale.x` The new x scale of the item.",
"{double (optional)} `scale.y` The new y scale of the item.",
"{int (optional)} `crop.top` The new amount of pixels cropped off the top of the source before scaling.",
"{int (optional)} `crop.bottom` The new amount of pixels cropped off the bottom of the source before scaling.",
"{int (optional)} `crop.left` The new amount of pixels cropped off the left of the source before scaling.",
"{int (optional)} `crop.right` The new amount of pixels cropped off the right of the source before scaling.",
"{bool (optional)} `visible` The new visibility of the source. 'true' shows source, 'false' hides source.",
"{bool (optional)} `locked` The new locked status of the source. 'true' keeps it in its current position, 'false' allows movement.",
"{String (optional)} `bounds.type` The new bounds type of the source. Can be \"OBS_BOUNDS_STRETCH\", \"OBS_BOUNDS_SCALE_INNER\", \"OBS_BOUNDS_SCALE_OUTER\", \"OBS_BOUNDS_SCALE_TO_WIDTH\", \"OBS_BOUNDS_SCALE_TO_HEIGHT\", \"OBS_BOUNDS_MAX_ONLY\" or \"OBS_BOUNDS_NONE\".",
"{int (optional)} `bounds.alignment` The new alignment of the bounding box. (0-2, 4-6, 8-10)",
"{double (optional)} `bounds.x` The new width of the bounding box.",
"{double (optional)} `bounds.y` The new height of the bounding box."
],
"api": "requests",
"name": "SetSceneItemProperties",
"category": "scene items",
"since": "4.3.0",
"params": [
{
"type": "String (optional)",
"name": "scene-name",
"description": "the name of the scene that the source item belongs to. Defaults to the current scene."
},
{
"type": "String",
"name": "item",
"description": "The name of the source."
},
{
"type": "int (optional)",
"name": "position.x",
"description": "The new x position of the source."
},
{
"type": "int (optional)",
"name": "position.y",
"description": "The new y position of the source."
},
{
"type": "int (optional)",
"name": "position.alignment",
"description": "The new alignment of the source."
},
{
"type": "double (optional)",
"name": "rotation",
"description": "The new clockwise rotation of the item in degrees."
},
{
"type": "double (optional)",
"name": "scale.x",
"description": "The new x scale of the item."
},
{
"type": "double (optional)",
"name": "scale.y",
"description": "The new y scale of the item."
},
{
"type": "int (optional)",
"name": "crop.top",
"description": "The new amount of pixels cropped off the top of the source before scaling."
},
{
"type": "int (optional)",
"name": "crop.bottom",
"description": "The new amount of pixels cropped off the bottom of the source before scaling."
},
{
"type": "int (optional)",
"name": "crop.left",
"description": "The new amount of pixels cropped off the left of the source before scaling."
},
{
"type": "int (optional)",
"name": "crop.right",
"description": "The new amount of pixels cropped off the right of the source before scaling."
},
{
"type": "bool (optional)",
"name": "visible",
"description": "The new visibility of the source. 'true' shows source, 'false' hides source."
},
{
"type": "bool (optional)",
"name": "locked",
"description": "The new locked status of the source. 'true' keeps it in its current position, 'false' allows movement."
},
{
"type": "String (optional)",
"name": "bounds.type",
"description": "The new bounds type of the source. Can be \"OBS_BOUNDS_STRETCH\", \"OBS_BOUNDS_SCALE_INNER\", \"OBS_BOUNDS_SCALE_OUTER\", \"OBS_BOUNDS_SCALE_TO_WIDTH\", \"OBS_BOUNDS_SCALE_TO_HEIGHT\", \"OBS_BOUNDS_MAX_ONLY\" or \"OBS_BOUNDS_NONE\"."
},
{
"type": "int (optional)",
"name": "bounds.alignment",
"description": "The new alignment of the bounding box. (0-2, 4-6, 8-10)"
},
{
"type": "double (optional)",
"name": "bounds.x",
"description": "The new width of the bounding box."
},
{
"type": "double (optional)",
"name": "bounds.y",
"description": "The new height of the bounding box."
}
],
"names": [
{
"name": "",
"description": "SetSceneItemProperties"
}
],
"categories": [
{
"name": "",
"description": "scene items"
}
],
"sinces": [
{
"name": "",
"description": "4.3.0"
}
],
"heading": {
"level": 2,
"text": "SetSceneItemProperties"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Reset a scene item.",
"param": [
"{String (optional)} `scene-name` Name of the scene the source belongs to. Defaults to the current scene.",
"{String} `item` Name of the source item."
],
"api": "requests",
"name": "ResetSceneItem",
"category": "scene items",
"since": "4.2.0",
"params": [
{
"type": "String (optional)",
"name": "scene-name",
"description": "Name of the scene the source belongs to. Defaults to the current scene."
},
{
"type": "String",
"name": "item",
"description": "Name of the source item."
}
],
"names": [
{
"name": "",
"description": "ResetSceneItem"
}
],
"categories": [
{
"name": "",
"description": "scene items"
}
],
"sinces": [
{
"name": "",
"description": "4.2.0"
}
],
"heading": {
"level": 2,
"text": "ResetSceneItem"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Show or hide a specified source item in a specified scene.",
"param": [
"{String} `source` Scene item name in the specified scene.",
"{boolean} `render` true = shown ; false = hidden",
"{String (optional)} `scene-name` Name of the scene where the source resides. Defaults to the currently active scene."
],
"api": "requests",
"name": "SetSceneItemRender",
"category": "scene items",
"since": "0.3",
"deprecated": "Since 4.3.0. Prefer the use of SetSceneItemProperties.",
"params": [
{
"type": "String",
"name": "source",
"description": "Scene item name in the specified scene."
},
{
"type": "boolean",
"name": "render",
"description": "true = shown ; false = hidden"
},
{
"type": "String (optional)",
"name": "scene-name",
"description": "Name of the scene where the source resides. Defaults to the currently active scene."
}
],
"names": [
{
"name": "",
"description": "SetSceneItemRender"
}
],
"categories": [
{
"name": "",
"description": "scene items"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"deprecateds": [
{
"name": "",
"description": "Since 4.3.0. Prefer the use of SetSceneItemProperties."
}
],
"heading": {
"level": 2,
"text": "SetSceneItemRender"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Sets the coordinates of a specified source item.",
"param": [
"{String (optional)} `scene-name` The name of the scene that the source item belongs to. Defaults to the current scene.",
"{String} `item` The name of the source item.",
"{double} `x` X coordinate.",
"{double} `y` Y coordinate."
],
"api": "requests",
"name": "SetSceneItemPosition",
"category": "scene items",
"since": "4.0.0",
"deprecated": "Since 4.3.0. Prefer the use of SetSceneItemProperties.",
"params": [
{
"type": "String (optional)",
"name": "scene-name",
"description": "The name of the scene that the source item belongs to. Defaults to the current scene."
},
{
"type": "String",
"name": "item",
"description": "The name of the source item."
},
{
"type": "double",
"name": "x",
"description": "X coordinate."
},
{
"type": "double",
"name": "y",
"description": "Y coordinate."
}
],
"names": [
{
"name": "",
"description": "SetSceneItemPosition"
}
],
"categories": [
{
"name": "",
"description": "scene items"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"deprecateds": [
{
"name": "",
"description": "Since 4.3.0. Prefer the use of SetSceneItemProperties."
}
],
"heading": {
"level": 2,
"text": "SetSceneItemPosition"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Set the transform of the specified source item.",
"param": [
"{String (optional)} `scene-name` The name of the scene that the source item belongs to. Defaults to the current scene.",
"{String} `item` The name of the source item.",
"{double} `x-scale` Width scale factor.",
"{double} `y-scale` Height scale factor.",
"{double} `rotation` Source item rotation (in degrees)."
],
"api": "requests",
"name": "SetSceneItemTransform",
"category": "scene items",
"since": "4.0.0",
"deprecated": "Since 4.3.0. Prefer the use of SetSceneItemProperties.",
"params": [
{
"type": "String (optional)",
"name": "scene-name",
"description": "The name of the scene that the source item belongs to. Defaults to the current scene."
},
{
"type": "String",
"name": "item",
"description": "The name of the source item."
},
{
"type": "double",
"name": "x-scale",
"description": "Width scale factor."
},
{
"type": "double",
"name": "y-scale",
"description": "Height scale factor."
},
{
"type": "double",
"name": "rotation",
"description": "Source item rotation (in degrees)."
}
],
"names": [
{
"name": "",
"description": "SetSceneItemTransform"
}
],
"categories": [
{
"name": "",
"description": "scene items"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"deprecateds": [
{
"name": "",
"description": "Since 4.3.0. Prefer the use of SetSceneItemProperties."
}
],
"heading": {
"level": 2,
"text": "SetSceneItemTransform"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Sets the crop coordinates of the specified source item.",
"param": [
"{String (optional)} `scene-name` the name of the scene that the source item belongs to. Defaults to the current scene.",
"{String} `item` The name of the source.",
"{int} `top` Pixel position of the top of the source item.",
"{int} `bottom` Pixel position of the bottom of the source item.",
"{int} `left` Pixel position of the left of the source item.",
"{int} `right` Pixel position of the right of the source item."
],
"api": "requests",
"name": "SetSceneItemCrop",
"category": "scene items",
"since": "4.1.0",
"deprecated": "Since 4.3.0. Prefer the use of SetSceneItemProperties.",
"params": [
{
"type": "String (optional)",
"name": "scene-name",
"description": "the name of the scene that the source item belongs to. Defaults to the current scene."
},
{
"type": "String",
"name": "item",
"description": "The name of the source."
},
{
"type": "int",
"name": "top",
"description": "Pixel position of the top of the source item."
},
{
"type": "int",
"name": "bottom",
"description": "Pixel position of the bottom of the source item."
},
{
"type": "int",
"name": "left",
"description": "Pixel position of the left of the source item."
},
{
"type": "int",
"name": "right",
"description": "Pixel position of the right of the source item."
}
],
"names": [
{
"name": "",
"description": "SetSceneItemCrop"
}
],
"categories": [
{
"name": "",
"description": "scene items"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"deprecateds": [
{
"name": "",
"description": "Since 4.3.0. Prefer the use of SetSceneItemProperties."
}
],
"heading": {
"level": 2,
"text": "SetSceneItemCrop"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Deletes a scene item.",
"param": [
"{String (optional)} `scene` Name of the scene the source belongs to. Defaults to the current scene.",
"{Object} `item` item to delete (required)",
"{String} `item.name` name of the scene item (prefer `id`, including both is acceptable).",
"{int} `item.id` id of the scene item."
],
"api": "requests",
"name": "DeleteSceneItem",
"category": "scene items",
"since": "4.5.0",
"params": [
{
"type": "String (optional)",
"name": "scene",
"description": "Name of the scene the source belongs to. Defaults to the current scene."
},
{
"type": "Object",
"name": "item",
"description": "item to delete (required)"
},
{
"type": "String",
"name": "item.name",
"description": "name of the scene item (prefer `id`, including both is acceptable)."
},
{
"type": "int",
"name": "item.id",
"description": "id of the scene item."
}
],
"names": [
{
"name": "",
"description": "DeleteSceneItem"
}
],
"categories": [
{
"name": "",
"description": "scene items"
}
],
"sinces": [
{
"name": "",
"description": "4.5.0"
}
],
"heading": {
"level": 2,
"text": "DeleteSceneItem"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Duplicates a scene item.",
"param": [
"{String (optional)} `fromScene` Name of the scene to copy the item from. Defaults to the current scene.",
"{String (optional)} `toScene` Name of the scene to create the item in. Defaults to the current scene.",
"{Object} `item` item to duplicate (required)",
"{String} `item.name` name of the scene item (prefer `id`, including both is acceptable).",
"{int} `item.id` id of the scene item."
],
"return": [
"{String} `scene` Name of the scene where the new item was created",
"{Object} `item` New item info",
"{int} `item.id` New item ID",
"{String} `item.name` New item name"
],
"api": "requests",
"name": "DuplicateSceneItem",
"category": "scene items",
"since": "4.5.0",
"returns": [
{
"type": "String",
"name": "scene",
"description": "Name of the scene where the new item was created"
},
{
"type": "Object",
"name": "item",
"description": "New item info"
},
{
"type": "int",
"name": "item.id",
"description": "New item ID"
},
{
"type": "String",
"name": "item.name",
"description": "New item name"
}
],
"params": [
{
"type": "String (optional)",
"name": "fromScene",
"description": "Name of the scene to copy the item from. Defaults to the current scene."
},
{
"type": "String (optional)",
"name": "toScene",
"description": "Name of the scene to create the item in. Defaults to the current scene."
},
{
"type": "Object",
"name": "item",
"description": "item to duplicate (required)"
},
{
"type": "String",
"name": "item.name",
"description": "name of the scene item (prefer `id`, including both is acceptable)."
},
{
"type": "int",
"name": "item.id",
"description": "id of the scene item."
}
],
"names": [
{
"name": "",
"description": "DuplicateSceneItem"
}
],
"categories": [
{
"name": "",
"description": "scene items"
}
],
"sinces": [
{
"name": "",
"description": "4.5.0"
}
],
"heading": {
"level": 2,
"text": "DuplicateSceneItem"
},
"lead": "",
"type": "class",
"examples": []
}
],
"scenes": [
{
"subheads": [],
"description": "Switch to the specified scene.",
"param": "{String} `scene-name` Name of the scene to switch to.",
"api": "requests",
"name": "SetCurrentScene",
"category": "scenes",
"since": "0.3",
"params": [
{
"type": "String",
"name": "scene-name",
"description": "Name of the scene to switch to."
}
],
"names": [
{
"name": "",
"description": "SetCurrentScene"
}
],
"categories": [
{
"name": "",
"description": "scenes"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "SetCurrentScene"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get the current scene's name and source items.",
"return": [
"{String} `name` Name of the currently active scene.",
"{Array<SceneItem>} `sources` Ordered list of the current scene's source items."
],
"api": "requests",
"name": "GetCurrentScene",
"category": "scenes",
"since": "0.3",
"returns": [
{
"type": "String",
"name": "name",
"description": "Name of the currently active scene."
},
{
"type": "Array<SceneItem>",
"name": "sources",
"description": "Ordered list of the current scene's source items."
}
],
"names": [
{
"name": "",
"description": "GetCurrentScene"
}
],
"categories": [
{
"name": "",
"description": "scenes"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "GetCurrentScene"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get a list of scenes in the currently active profile.",
"return": [
"{String} `current-scene` Name of the currently active scene.",
"{Array<Scene>} `scenes` Ordered list of the current profile's scenes (See `[GetCurrentScene](#getcurrentscene)` for more information)."
],
"api": "requests",
"name": "GetSceneList",
"category": "scenes",
"since": "0.3",
"returns": [
{
"type": "String",
"name": "current-scene",
"description": "Name of the currently active scene."
},
{
"type": "Array<Scene>",
"name": "scenes",
"description": "Ordered list of the current profile's scenes (See `[GetCurrentScene](#getcurrentscene)` for more information)."
}
],
"names": [
{
"name": "",
"description": "GetSceneList"
}
],
"categories": [
{
"name": "",
"description": "scenes"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "GetSceneList"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Changes the order of scene items in the requested scene.",
"param": [
"{String (optional)} `scene` Name of the scene to reorder (defaults to current).",
"{Array<Scene>} `items` Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene",
"{int (optional)} `items[].id` Id of a specific scene item. Unique on a scene by scene basis.",
"{String (optional)} `items[].name` Name of a scene item. Sufficiently unique if no scene items share sources within the scene."
],
"api": "requests",
"name": "ReorderSceneItems",
"category": "scenes",
"since": "4.5.0",
"params": [
{
"type": "String (optional)",
"name": "scene",
"description": "Name of the scene to reorder (defaults to current)."
},
{
"type": "Array<Scene>",
"name": "items",
"description": "Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene"
},
{
"type": "int (optional)",
"name": "items[].id",
"description": "Id of a specific scene item. Unique on a scene by scene basis."
},
{
"type": "String (optional)",
"name": "items[].name",
"description": "Name of a scene item. Sufficiently unique if no scene items share sources within the scene."
}
],
"names": [
{
"name": "",
"description": "ReorderSceneItems"
}
],
"categories": [
{
"name": "",
"description": "scenes"
}
],
"sinces": [
{
"name": "",
"description": "4.5.0"
}
],
"heading": {
"level": 2,
"text": "ReorderSceneItems"
},
"lead": "",
"type": "class",
"examples": []
}
],
"sources": [
{
"subheads": [],
"description": "List all sources available in the running OBS instance",
"return": [
"{Array<Object>} `sources` Array of sources",
"{String} `sources.*.name` Unique source name",
"{String} `sources.*.typeId` Non-unique source internal type (a.k.a type id)",
"{String} `sources.*.type` Source type. Value is one of the following: \"input\", \"filter\", \"transition\", \"scene\" or \"unknown\""
],
"api": "requests",
"name": "GetSourcesList",
"category": "sources",
"since": "4.3.0",
"returns": [
{
"type": "Array<Object>",
"name": "sources",
"description": "Array of sources"
},
{
"type": "String",
"name": "sources.*.name",
"description": "Unique source name"
},
{
"type": "String",
"name": "sources.*.typeId",
"description": "Non-unique source internal type (a.k.a type id)"
},
{
"type": "String",
"name": "sources.*.type",
"description": "Source type. Value is one of the following: \"input\", \"filter\", \"transition\", \"scene\" or \"unknown\""
}
],
"names": [
{
"name": "",
"description": "GetSourcesList"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.3.0"
}
],
"heading": {
"level": 2,
"text": "GetSourcesList"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get a list of all available sources types",
"return": [
"{Array<Object>} `types` Array of source types",
"{String} `types.*.typeId` Non-unique internal source type ID",
"{String} `types.*.displayName` Display name of the source type",
"{String} `types.*.type` Type. Value is one of the following: \"input\", \"filter\", \"transition\" or \"other\"",
"{Object} `types.*.defaultSettings` Default settings of this source type",
"{Object} `types.*.caps` Source type capabilities",
"{Boolean} `types.*.caps.isAsync` True if source of this type provide frames asynchronously",
"{Boolean} `types.*.caps.hasVideo` True if sources of this type provide video",
"{Boolean} `types.*.caps.hasAudio` True if sources of this type provide audio",
"{Boolean} `types.*.caps.canInteract` True if interaction with this sources of this type is possible",
"{Boolean} `types.*.caps.isComposite` True if sources of this type composite one or more sub-sources",
"{Boolean} `types.*.caps.doNotDuplicate` True if sources of this type should not be fully duplicated",
"{Boolean} `types.*.caps.doNotSelfMonitor` True if sources of this type may cause a feedback loop if it's audio is monitored and shouldn't be"
],
"api": "requests",
"name": "GetSourceTypesList",
"category": "sources",
"since": "4.3.0",
"returns": [
{
"type": "Array<Object>",
"name": "types",
"description": "Array of source types"
},
{
"type": "String",
"name": "types.*.typeId",
"description": "Non-unique internal source type ID"
},
{
"type": "String",
"name": "types.*.displayName",
"description": "Display name of the source type"
},
{
"type": "String",
"name": "types.*.type",
"description": "Type. Value is one of the following: \"input\", \"filter\", \"transition\" or \"other\""
},
{
"type": "Object",
"name": "types.*.defaultSettings",
"description": "Default settings of this source type"
},
{
"type": "Object",
"name": "types.*.caps",
"description": "Source type capabilities"
},
{
"type": "Boolean",
"name": "types.*.caps.isAsync",
"description": "True if source of this type provide frames asynchronously"
},
{
"type": "Boolean",
"name": "types.*.caps.hasVideo",
"description": "True if sources of this type provide video"
},
{
"type": "Boolean",
"name": "types.*.caps.hasAudio",
"description": "True if sources of this type provide audio"
},
{
"type": "Boolean",
"name": "types.*.caps.canInteract",
"description": "True if interaction with this sources of this type is possible"
},
{
"type": "Boolean",
"name": "types.*.caps.isComposite",
"description": "True if sources of this type composite one or more sub-sources"
},
{
"type": "Boolean",
"name": "types.*.caps.doNotDuplicate",
"description": "True if sources of this type should not be fully duplicated"
},
{
"type": "Boolean",
"name": "types.*.caps.doNotSelfMonitor",
"description": "True if sources of this type may cause a feedback loop if it's audio is monitored and shouldn't be"
}
],
"names": [
{
"name": "",
"description": "GetSourceTypesList"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.3.0"
}
],
"heading": {
"level": 2,
"text": "GetSourceTypesList"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get the volume of the specified source.",
"param": "{String} `source` Source name.",
"return": [
"{String} `name` Source name.",
"{double} `volume` Volume of the source. Between `0.0` and `1.0`.",
"{boolean} `muted` Indicates whether the source is muted."
],
"api": "requests",
"name": "GetVolume",
"category": "sources",
"since": "4.0.0",
"returns": [
{
"type": "String",
"name": "name",
"description": "Source name."
},
{
"type": "double",
"name": "volume",
"description": "Volume of the source. Between `0.0` and `1.0`."
},
{
"type": "boolean",
"name": "muted",
"description": "Indicates whether the source is muted."
}
],
"params": [
{
"type": "String",
"name": "source",
"description": "Source name."
}
],
"names": [
{
"name": "",
"description": "GetVolume"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "GetVolume"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Set the volume of the specified source.",
"param": [
"{String} `source` Source name.",
"{double} `volume` Desired volume. Must be between `0.0` and `1.0`."
],
"api": "requests",
"name": "SetVolume",
"category": "sources",
"since": "4.0.0",
"params": [
{
"type": "String",
"name": "source",
"description": "Source name."
},
{
"type": "double",
"name": "volume",
"description": "Desired volume. Must be between `0.0` and `1.0`."
}
],
"names": [
{
"name": "",
"description": "SetVolume"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "SetVolume"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get the mute status of a specified source.",
"param": "{String} `source` Source name.",
"return": [
"{String} `name` Source name.",
"{boolean} `muted` Mute status of the source."
],
"api": "requests",
"name": "GetMute",
"category": "sources",
"since": "4.0.0",
"returns": [
{
"type": "String",
"name": "name",
"description": "Source name."
},
{
"type": "boolean",
"name": "muted",
"description": "Mute status of the source."
}
],
"params": [
{
"type": "String",
"name": "source",
"description": "Source name."
}
],
"names": [
{
"name": "",
"description": "GetMute"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "GetMute"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Sets the mute status of a specified source.",
"param": [
"{String} `source` Source name.",
"{boolean} `mute` Desired mute status."
],
"api": "requests",
"name": "SetMute",
"category": "sources",
"since": "4.0.0",
"params": [
{
"type": "String",
"name": "source",
"description": "Source name."
},
{
"type": "boolean",
"name": "mute",
"description": "Desired mute status."
}
],
"names": [
{
"name": "",
"description": "SetMute"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "SetMute"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Inverts the mute status of a specified source.",
"param": "{String} `source` Source name.",
"api": "requests",
"name": "ToggleMute",
"category": "sources",
"since": "4.0.0",
"params": [
{
"type": "String",
"name": "source",
"description": "Source name."
}
],
"names": [
{
"name": "",
"description": "ToggleMute"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "ToggleMute"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Set the audio sync offset of a specified source.",
"param": [
"{String} `source` Source name.",
"{int} `offset` The desired audio sync offset (in nanoseconds)."
],
"api": "requests",
"name": "SetSyncOffset",
"category": "sources",
"since": "4.2.0",
"params": [
{
"type": "String",
"name": "source",
"description": "Source name."
},
{
"type": "int",
"name": "offset",
"description": "The desired audio sync offset (in nanoseconds)."
}
],
"names": [
{
"name": "",
"description": "SetSyncOffset"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.2.0"
}
],
"heading": {
"level": 2,
"text": "SetSyncOffset"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get the audio sync offset of a specified source.",
"param": "{String} `source` Source name.",
"return": [
"{String} `name` Source name.",
"{int} `offset` The audio sync offset (in nanoseconds)."
],
"api": "requests",
"name": "GetSyncOffset",
"category": "sources",
"since": "4.2.0",
"returns": [
{
"type": "String",
"name": "name",
"description": "Source name."
},
{
"type": "int",
"name": "offset",
"description": "The audio sync offset (in nanoseconds)."
}
],
"params": [
{
"type": "String",
"name": "source",
"description": "Source name."
}
],
"names": [
{
"name": "",
"description": "GetSyncOffset"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.2.0"
}
],
"heading": {
"level": 2,
"text": "GetSyncOffset"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get settings of the specified source",
"param": [
"{String} `sourceName` Source name.",
"{String (optional)} `sourceType` Type of the specified source. Useful for type-checking if you expect a specific settings schema."
],
"return": [
"{String} `sourceName` Source name",
"{String} `sourceType` Type of the specified source",
"{Object} `sourceSettings` Source settings (varies between source types, may require some probing around)."
],
"api": "requests",
"name": "GetSourceSettings",
"category": "sources",
"since": "4.3.0",
"returns": [
{
"type": "String",
"name": "sourceName",
"description": "Source name"
},
{
"type": "String",
"name": "sourceType",
"description": "Type of the specified source"
},
{
"type": "Object",
"name": "sourceSettings",
"description": "Source settings (varies between source types, may require some probing around)."
}
],
"params": [
{
"type": "String",
"name": "sourceName",
"description": "Source name."
},
{
"type": "String (optional)",
"name": "sourceType",
"description": "Type of the specified source. Useful for type-checking if you expect a specific settings schema."
}
],
"names": [
{
"name": "",
"description": "GetSourceSettings"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.3.0"
}
],
"heading": {
"level": 2,
"text": "GetSourceSettings"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Set settings of the specified source.",
"param": [
"{String} `sourceName` Source name.",
"{String (optional)} `sourceType` Type of the specified source. Useful for type-checking to avoid settings a set of settings incompatible with the actual source's type.",
"{Object} `sourceSettings` Source settings (varies between source types, may require some probing around)."
],
"return": [
"{String} `sourceName` Source name",
"{String} `sourceType` Type of the specified source",
"{Object} `sourceSettings` Updated source settings"
],
"api": "requests",
"name": "SetSourceSettings",
"category": "sources",
"since": "4.3.0",
"returns": [
{
"type": "String",
"name": "sourceName",
"description": "Source name"
},
{
"type": "String",
"name": "sourceType",
"description": "Type of the specified source"
},
{
"type": "Object",
"name": "sourceSettings",
"description": "Updated source settings"
}
],
"params": [
{
"type": "String",
"name": "sourceName",
"description": "Source name."
},
{
"type": "String (optional)",
"name": "sourceType",
"description": "Type of the specified source. Useful for type-checking to avoid settings a set of settings incompatible with the actual source's type."
},
{
"type": "Object",
"name": "sourceSettings",
"description": "Source settings (varies between source types, may require some probing around)."
}
],
"names": [
{
"name": "",
"description": "SetSourceSettings"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.3.0"
}
],
"heading": {
"level": 2,
"text": "SetSourceSettings"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get the current properties of a Text GDI Plus source.",
"param": "{String} `source` Source name.",
"return": [
"{String} `source` Source name.",
"{String} `align` Text Alignment (\"left\", \"center\", \"right\").",
"{int} `bk-color` Background color.",
"{int} `bk-opacity` Background opacity (0-100).",
"{boolean} `chatlog` Chat log.",
"{int} `chatlog_lines` Chat log lines.",
"{int} `color` Text color.",
"{boolean} `extents` Extents wrap.",
"{int} `extents_cx` Extents cx.",
"{int} `extents_cy` Extents cy.",
"{String} `file` File path name.",
"{boolean} `read_from_file` Read text from the specified file.",
"{Object} `font` Holds data for the font. Ex: `\"font\": { \"face\": \"Arial\", \"flags\": 0, \"size\": 150, \"style\": \"\" }`",
"{String} `font.face` Font face.",
"{int} `font.flags` Font text styling flag. `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8`",
"{int} `font.size` Font text size.",
"{String} `font.style` Font Style (unknown function).",
"{boolean} `gradient` Gradient enabled.",
"{int} `gradient_color` Gradient color.",
"{float} `gradient_dir` Gradient direction.",
"{int} `gradient_opacity` Gradient opacity (0-100).",
"{boolean} `outline` Outline.",
"{int} `outline_color` Outline color.",
"{int} `outline_size` Outline size.",
"{int} `outline_opacity` Outline opacity (0-100).",
"{String} `text` Text content to be displayed.",
"{String} `valign` Text vertical alignment (\"top\", \"center\", \"bottom\").",
"{boolean} `vertical` Vertical text enabled."
],
"api": "requests",
"name": "GetTextGDIPlusProperties",
"category": "sources",
"since": "4.1.0",
"returns": [
{
"type": "String",
"name": "source",
"description": "Source name."
},
{
"type": "String",
"name": "align",
"description": "Text Alignment (\"left\", \"center\", \"right\")."
},
{
"type": "int",
"name": "bk-color",
"description": "Background color."
},
{
"type": "int",
"name": "bk-opacity",
"description": "Background opacity (0-100)."
},
{
"type": "boolean",
"name": "chatlog",
"description": "Chat log."
},
{
"type": "int",
"name": "chatlog_lines",
"description": "Chat log lines."
},
{
"type": "int",
"name": "color",
"description": "Text color."
},
{
"type": "boolean",
"name": "extents",
"description": "Extents wrap."
},
{
"type": "int",
"name": "extents_cx",
"description": "Extents cx."
},
{
"type": "int",
"name": "extents_cy",
"description": "Extents cy."
},
{
"type": "String",
"name": "file",
"description": "File path name."
},
{
"type": "boolean",
"name": "read_from_file",
"description": "Read text from the specified file."
},
{
"type": "Object",
"name": "font",
"description": "Holds data for the font. Ex: `\"font\": { \"face\": \"Arial\", \"flags\": 0, \"size\": 150, \"style\": \"\" }`"
},
{
"type": "String",
"name": "font.face",
"description": "Font face."
},
{
"type": "int",
"name": "font.flags",
"description": "Font text styling flag. `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8`"
},
{
"type": "int",
"name": "font.size",
"description": "Font text size."
},
{
"type": "String",
"name": "font.style",
"description": "Font Style (unknown function)."
},
{
"type": "boolean",
"name": "gradient",
"description": "Gradient enabled."
},
{
"type": "int",
"name": "gradient_color",
"description": "Gradient color."
},
{
"type": "float",
"name": "gradient_dir",
"description": "Gradient direction."
},
{
"type": "int",
"name": "gradient_opacity",
"description": "Gradient opacity (0-100)."
},
{
"type": "boolean",
"name": "outline",
"description": "Outline."
},
{
"type": "int",
"name": "outline_color",
"description": "Outline color."
},
{
"type": "int",
"name": "outline_size",
"description": "Outline size."
},
{
"type": "int",
"name": "outline_opacity",
"description": "Outline opacity (0-100)."
},
{
"type": "String",
"name": "text",
"description": "Text content to be displayed."
},
{
"type": "String",
"name": "valign",
"description": "Text vertical alignment (\"top\", \"center\", \"bottom\")."
},
{
"type": "boolean",
"name": "vertical",
"description": "Vertical text enabled."
}
],
"params": [
{
"type": "String",
"name": "source",
"description": "Source name."
}
],
"names": [
{
"name": "",
"description": "GetTextGDIPlusProperties"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "GetTextGDIPlusProperties"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Set the current properties of a Text GDI Plus source.",
"param": [
"{String} `source` Name of the source.",
"{String (optional)} `align` Text Alignment (\"left\", \"center\", \"right\").",
"{int (optional)} `bk-color` Background color.",
"{int (optional)} `bk-opacity` Background opacity (0-100).",
"{boolean (optional)} `chatlog` Chat log.",
"{int (optional)} `chatlog_lines` Chat log lines.",
"{int (optional)} `color` Text color.",
"{boolean (optional)} `extents` Extents wrap.",
"{int (optional)} `extents_cx` Extents cx.",
"{int (optional)} `extents_cy` Extents cy.",
"{String (optional)} `file` File path name.",
"{boolean (optional)} `read_from_file` Read text from the specified file.",
"{Object (optional)} `font` Holds data for the font. Ex: `\"font\": { \"face\": \"Arial\", \"flags\": 0, \"size\": 150, \"style\": \"\" }`",
"{String (optional)} `font.face` Font face.",
"{int (optional)} `font.flags` Font text styling flag. `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8`",
"{int (optional)} `font.size` Font text size.",
"{String (optional)} `font.style` Font Style (unknown function).",
"{boolean (optional)} `gradient` Gradient enabled.",
"{int (optional)} `gradient_color` Gradient color.",
"{float (optional)} `gradient_dir` Gradient direction.",
"{int (optional)} `gradient_opacity` Gradient opacity (0-100).",
"{boolean (optional)} `outline` Outline.",
"{int (optional)} `outline_color` Outline color.",
"{int (optional)} `outline_size` Outline size.",
"{int (optional)} `outline_opacity` Outline opacity (0-100).",
"{String (optional)} `text` Text content to be displayed.",
"{String (optional)} `valign` Text vertical alignment (\"top\", \"center\", \"bottom\").",
"{boolean (optional)} `vertical` Vertical text enabled.",
"{boolean (optional)} `render` Visibility of the scene item."
],
"api": "requests",
"name": "SetTextGDIPlusProperties",
"category": "sources",
"since": "4.1.0",
"params": [
{
"type": "String",
"name": "source",
"description": "Name of the source."
},
{
"type": "String (optional)",
"name": "align",
"description": "Text Alignment (\"left\", \"center\", \"right\")."
},
{
"type": "int (optional)",
"name": "bk-color",
"description": "Background color."
},
{
"type": "int (optional)",
"name": "bk-opacity",
"description": "Background opacity (0-100)."
},
{
"type": "boolean (optional)",
"name": "chatlog",
"description": "Chat log."
},
{
"type": "int (optional)",
"name": "chatlog_lines",
"description": "Chat log lines."
},
{
"type": "int (optional)",
"name": "color",
"description": "Text color."
},
{
"type": "boolean (optional)",
"name": "extents",
"description": "Extents wrap."
},
{
"type": "int (optional)",
"name": "extents_cx",
"description": "Extents cx."
},
{
"type": "int (optional)",
"name": "extents_cy",
"description": "Extents cy."
},
{
"type": "String (optional)",
"name": "file",
"description": "File path name."
},
{
"type": "boolean (optional)",
"name": "read_from_file",
"description": "Read text from the specified file."
},
{
"type": "Object (optional)",
"name": "font",
"description": "Holds data for the font. Ex: `\"font\": { \"face\": \"Arial\", \"flags\": 0, \"size\": 150, \"style\": \"\" }`"
},
{
"type": "String (optional)",
"name": "font.face",
"description": "Font face."
},
{
"type": "int (optional)",
"name": "font.flags",
"description": "Font text styling flag. `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8`"
},
{
"type": "int (optional)",
"name": "font.size",
"description": "Font text size."
},
{
"type": "String (optional)",
"name": "font.style",
"description": "Font Style (unknown function)."
},
{
"type": "boolean (optional)",
"name": "gradient",
"description": "Gradient enabled."
},
{
"type": "int (optional)",
"name": "gradient_color",
"description": "Gradient color."
},
{
"type": "float (optional)",
"name": "gradient_dir",
"description": "Gradient direction."
},
{
"type": "int (optional)",
"name": "gradient_opacity",
"description": "Gradient opacity (0-100)."
},
{
"type": "boolean (optional)",
"name": "outline",
"description": "Outline."
},
{
"type": "int (optional)",
"name": "outline_color",
"description": "Outline color."
},
{
"type": "int (optional)",
"name": "outline_size",
"description": "Outline size."
},
{
"type": "int (optional)",
"name": "outline_opacity",
"description": "Outline opacity (0-100)."
},
{
"type": "String (optional)",
"name": "text",
"description": "Text content to be displayed."
},
{
"type": "String (optional)",
"name": "valign",
"description": "Text vertical alignment (\"top\", \"center\", \"bottom\")."
},
{
"type": "boolean (optional)",
"name": "vertical",
"description": "Vertical text enabled."
},
{
"type": "boolean (optional)",
"name": "render",
"description": "Visibility of the scene item."
}
],
"names": [
{
"name": "",
"description": "SetTextGDIPlusProperties"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "SetTextGDIPlusProperties"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get the current properties of a Text Freetype 2 source.",
"param": "{String} `source` Source name.",
"return": [
"{String} `source` Source name",
"{int} `color1` Gradient top color.",
"{int} `color2` Gradient bottom color.",
"{int} `custom_width` Custom width (0 to disable).",
"{boolean} `drop_shadow` Drop shadow.",
"{Object} `font` Holds data for the font. Ex: `\"font\": { \"face\": \"Arial\", \"flags\": 0, \"size\": 150, \"style\": \"\" }`",
"{String} `font.face` Font face.",
"{int} `font.flags` Font text styling flag. `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8`",
"{int} `font.size` Font text size.",
"{String} `font.style` Font Style (unknown function).",
"{boolean} `from_file` Read text from the specified file.",
"{boolean} `log_mode` Chat log.",
"{boolean} `outline` Outline.",
"{String} `text` Text content to be displayed.",
"{String} `text_file` File path.",
"{boolean} `word_wrap` Word wrap."
],
"api": "requests",
"name": "GetTextFreetype2Properties",
"category": "sources",
"since": "4.5.0",
"returns": [
{
"type": "String",
"name": "source",
"description": "Source name"
},
{
"type": "int",
"name": "color1",
"description": "Gradient top color."
},
{
"type": "int",
"name": "color2",
"description": "Gradient bottom color."
},
{
"type": "int",
"name": "custom_width",
"description": "Custom width (0 to disable)."
},
{
"type": "boolean",
"name": "drop_shadow",
"description": "Drop shadow."
},
{
"type": "Object",
"name": "font",
"description": "Holds data for the font. Ex: `\"font\": { \"face\": \"Arial\", \"flags\": 0, \"size\": 150, \"style\": \"\" }`"
},
{
"type": "String",
"name": "font.face",
"description": "Font face."
},
{
"type": "int",
"name": "font.flags",
"description": "Font text styling flag. `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8`"
},
{
"type": "int",
"name": "font.size",
"description": "Font text size."
},
{
"type": "String",
"name": "font.style",
"description": "Font Style (unknown function)."
},
{
"type": "boolean",
"name": "from_file",
"description": "Read text from the specified file."
},
{
"type": "boolean",
"name": "log_mode",
"description": "Chat log."
},
{
"type": "boolean",
"name": "outline",
"description": "Outline."
},
{
"type": "String",
"name": "text",
"description": "Text content to be displayed."
},
{
"type": "String",
"name": "text_file",
"description": "File path."
},
{
"type": "boolean",
"name": "word_wrap",
"description": "Word wrap."
}
],
"params": [
{
"type": "String",
"name": "source",
"description": "Source name."
}
],
"names": [
{
"name": "",
"description": "GetTextFreetype2Properties"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.5.0"
}
],
"heading": {
"level": 2,
"text": "GetTextFreetype2Properties"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Set the current properties of a Text Freetype 2 source.",
"param": [
"{String} `source` Source name.",
"{int (optional)} `color1` Gradient top color.",
"{int (optional)} `color2` Gradient bottom color.",
"{int (optional)} `custom_width` Custom width (0 to disable).",
"{boolean (optional)} `drop_shadow` Drop shadow.",
"{Object (optional)} `font` Holds data for the font. Ex: `\"font\": { \"face\": \"Arial\", \"flags\": 0, \"size\": 150, \"style\": \"\" }`",
"{String (optional)} `font.face` Font face.",
"{int (optional)} `font.flags` Font text styling flag. `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8`",
"{int (optional)} `font.size` Font text size.",
"{String (optional)} `font.style` Font Style (unknown function).",
"{boolean (optional)} `from_file` Read text from the specified file.",
"{boolean (optional)} `log_mode` Chat log.",
"{boolean (optional)} `outline` Outline.",
"{String (optional)} `text` Text content to be displayed.",
"{String (optional)} `text_file` File path.",
"{boolean (optional)} `word_wrap` Word wrap."
],
"api": "requests",
"name": "SetTextFreetype2Properties",
"category": "sources",
"since": "4.5.0",
"params": [
{
"type": "String",
"name": "source",
"description": "Source name."
},
{
"type": "int (optional)",
"name": "color1",
"description": "Gradient top color."
},
{
"type": "int (optional)",
"name": "color2",
"description": "Gradient bottom color."
},
{
"type": "int (optional)",
"name": "custom_width",
"description": "Custom width (0 to disable)."
},
{
"type": "boolean (optional)",
"name": "drop_shadow",
"description": "Drop shadow."
},
{
"type": "Object (optional)",
"name": "font",
"description": "Holds data for the font. Ex: `\"font\": { \"face\": \"Arial\", \"flags\": 0, \"size\": 150, \"style\": \"\" }`"
},
{
"type": "String (optional)",
"name": "font.face",
"description": "Font face."
},
{
"type": "int (optional)",
"name": "font.flags",
"description": "Font text styling flag. `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8`"
},
{
"type": "int (optional)",
"name": "font.size",
"description": "Font text size."
},
{
"type": "String (optional)",
"name": "font.style",
"description": "Font Style (unknown function)."
},
{
"type": "boolean (optional)",
"name": "from_file",
"description": "Read text from the specified file."
},
{
"type": "boolean (optional)",
"name": "log_mode",
"description": "Chat log."
},
{
"type": "boolean (optional)",
"name": "outline",
"description": "Outline."
},
{
"type": "String (optional)",
"name": "text",
"description": "Text content to be displayed."
},
{
"type": "String (optional)",
"name": "text_file",
"description": "File path."
},
{
"type": "boolean (optional)",
"name": "word_wrap",
"description": "Word wrap."
}
],
"names": [
{
"name": "",
"description": "SetTextFreetype2Properties"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.5.0"
}
],
"heading": {
"level": 2,
"text": "SetTextFreetype2Properties"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get current properties for a Browser Source.",
"param": "{String} `source` Source name.",
"return": [
"{String} `source` Source name.",
"{boolean} `is_local_file` Indicates that a local file is in use.",
"{String} `local_file` file path.",
"{String} `url` Url.",
"{String} `css` CSS to inject.",
"{int} `width` Width.",
"{int} `height` Height.",
"{int} `fps` Framerate.",
"{boolean} `shutdown` Indicates whether the source should be shutdown when not visible."
],
"api": "requests",
"name": "GetBrowserSourceProperties",
"category": "sources",
"since": "4.1.0",
"returns": [
{
"type": "String",
"name": "source",
"description": "Source name."
},
{
"type": "boolean",
"name": "is_local_file",
"description": "Indicates that a local file is in use."
},
{
"type": "String",
"name": "local_file",
"description": "file path."
},
{
"type": "String",
"name": "url",
"description": "Url."
},
{
"type": "String",
"name": "css",
"description": "CSS to inject."
},
{
"type": "int",
"name": "width",
"description": "Width."
},
{
"type": "int",
"name": "height",
"description": "Height."
},
{
"type": "int",
"name": "fps",
"description": "Framerate."
},
{
"type": "boolean",
"name": "shutdown",
"description": "Indicates whether the source should be shutdown when not visible."
}
],
"params": [
{
"type": "String",
"name": "source",
"description": "Source name."
}
],
"names": [
{
"name": "",
"description": "GetBrowserSourceProperties"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "GetBrowserSourceProperties"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Set current properties for a Browser Source.",
"param": [
"{String} `source` Name of the source.",
"{boolean (optional)} `is_local_file` Indicates that a local file is in use.",
"{String (optional)} `local_file` file path.",
"{String (optional)} `url` Url.",
"{String (optional)} `css` CSS to inject.",
"{int (optional)} `width` Width.",
"{int (optional)} `height` Height.",
"{int (optional)} `fps` Framerate.",
"{boolean (optional)} `shutdown` Indicates whether the source should be shutdown when not visible.",
"{boolean (optional)} `render` Visibility of the scene item."
],
"api": "requests",
"name": "SetBrowserSourceProperties",
"category": "sources",
"since": "4.1.0",
"params": [
{
"type": "String",
"name": "source",
"description": "Name of the source."
},
{
"type": "boolean (optional)",
"name": "is_local_file",
"description": "Indicates that a local file is in use."
},
{
"type": "String (optional)",
"name": "local_file",
"description": "file path."
},
{
"type": "String (optional)",
"name": "url",
"description": "Url."
},
{
"type": "String (optional)",
"name": "css",
"description": "CSS to inject."
},
{
"type": "int (optional)",
"name": "width",
"description": "Width."
},
{
"type": "int (optional)",
"name": "height",
"description": "Height."
},
{
"type": "int (optional)",
"name": "fps",
"description": "Framerate."
},
{
"type": "boolean (optional)",
"name": "shutdown",
"description": "Indicates whether the source should be shutdown when not visible."
},
{
"type": "boolean (optional)",
"name": "render",
"description": "Visibility of the scene item."
}
],
"names": [
{
"name": "",
"description": "SetBrowserSourceProperties"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "SetBrowserSourceProperties"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get configured special sources like Desktop Audio and Mic/Aux sources.",
"return": [
"{String (optional)} `desktop-1` Name of the first Desktop Audio capture source.",
"{String (optional)} `desktop-2` Name of the second Desktop Audio capture source.",
"{String (optional)} `mic-1` Name of the first Mic/Aux input source.",
"{String (optional)} `mic-2` Name of the second Mic/Aux input source.",
"{String (optional)} `mic-3` NAme of the third Mic/Aux input source."
],
"api": "requests",
"name": "GetSpecialSources",
"category": "sources",
"since": "4.1.0",
"returns": [
{
"type": "String (optional)",
"name": "desktop-1",
"description": "Name of the first Desktop Audio capture source."
},
{
"type": "String (optional)",
"name": "desktop-2",
"description": "Name of the second Desktop Audio capture source."
},
{
"type": "String (optional)",
"name": "mic-1",
"description": "Name of the first Mic/Aux input source."
},
{
"type": "String (optional)",
"name": "mic-2",
"description": "Name of the second Mic/Aux input source."
},
{
"type": "String (optional)",
"name": "mic-3",
"description": "NAme of the third Mic/Aux input source."
}
],
"names": [
{
"name": "",
"description": "GetSpecialSources"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "GetSpecialSources"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "List filters applied to a source",
"param": "{String} `sourceName` Source name",
"return": [
"{Array<Object>} `filters` List of filters for the specified source",
"{Boolean} `filters.*.enabled` Filter status (enabled or not)",
"{String} `filters.*.type` Filter type",
"{String} `filters.*.name` Filter name",
"{Object} `filters.*.settings` Filter settings"
],
"api": "requests",
"name": "GetSourceFilters",
"category": "sources",
"since": "4.5.0",
"returns": [
{
"type": "Array<Object>",
"name": "filters",
"description": "List of filters for the specified source"
},
{
"type": "Boolean",
"name": "filters.*.enabled",
"description": "Filter status (enabled or not)"
},
{
"type": "String",
"name": "filters.*.type",
"description": "Filter type"
},
{
"type": "String",
"name": "filters.*.name",
"description": "Filter name"
},
{
"type": "Object",
"name": "filters.*.settings",
"description": "Filter settings"
}
],
"params": [
{
"type": "String",
"name": "sourceName",
"description": "Source name"
}
],
"names": [
{
"name": "",
"description": "GetSourceFilters"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.5.0"
}
],
"heading": {
"level": 2,
"text": "GetSourceFilters"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "List filters applied to a source",
"param": [
"{String} `sourceName` Source name",
"{String} `filterName` Source filter name"
],
"return": [
"{Boolean} `enabled` Filter status (enabled or not)",
"{String} `type` Filter type",
"{String} `name` Filter name",
"{Object} `settings` Filter settings"
],
"api": "requests",
"name": "GetSourceFilterInfo",
"category": "sources",
"since": "4.7.0",
"returns": [
{
"type": "Boolean",
"name": "enabled",
"description": "Filter status (enabled or not)"
},
{
"type": "String",
"name": "type",
"description": "Filter type"
},
{
"type": "String",
"name": "name",
"description": "Filter name"
},
{
"type": "Object",
"name": "settings",
"description": "Filter settings"
}
],
"params": [
{
"type": "String",
"name": "sourceName",
"description": "Source name"
},
{
"type": "String",
"name": "filterName",
"description": "Source filter name"
}
],
"names": [
{
"name": "",
"description": "GetSourceFilterInfo"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.7.0"
}
],
"heading": {
"level": 2,
"text": "GetSourceFilterInfo"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Add a new filter to a source. Available source types along with their settings properties are available from `GetSourceTypesList`.",
"param": [
"{String} `sourceName` Name of the source on which the filter is added",
"{String} `filterName` Name of the new filter",
"{String} `filterType` Filter type",
"{Object} `filterSettings` Filter settings"
],
"api": "requests",
"name": "AddFilterToSource",
"category": "sources",
"since": "4.5.0",
"params": [
{
"type": "String",
"name": "sourceName",
"description": "Name of the source on which the filter is added"
},
{
"type": "String",
"name": "filterName",
"description": "Name of the new filter"
},
{
"type": "String",
"name": "filterType",
"description": "Filter type"
},
{
"type": "Object",
"name": "filterSettings",
"description": "Filter settings"
}
],
"names": [
{
"name": "",
"description": "AddFilterToSource"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.5.0"
}
],
"heading": {
"level": 2,
"text": "AddFilterToSource"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Remove a filter from a source",
"param": [
"{String} `sourceName` Name of the source from which the specified filter is removed",
"{String} `filterName` Name of the filter to remove"
],
"api": "requests",
"name": "RemoveFilterFromSource",
"category": "sources",
"since": "4.5.0",
"params": [
{
"type": "String",
"name": "sourceName",
"description": "Name of the source from which the specified filter is removed"
},
{
"type": "String",
"name": "filterName",
"description": "Name of the filter to remove"
}
],
"names": [
{
"name": "",
"description": "RemoveFilterFromSource"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.5.0"
}
],
"heading": {
"level": 2,
"text": "RemoveFilterFromSource"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Move a filter in the chain (absolute index positioning)",
"param": [
"{String} `sourceName` Name of the source to which the filter belongs",
"{String} `filterName` Name of the filter to reorder",
"{Integer} `newIndex` Desired position of the filter in the chain"
],
"api": "requests",
"name": "ReorderSourceFilter",
"category": "sources",
"since": "4.5.0",
"params": [
{
"type": "String",
"name": "sourceName",
"description": "Name of the source to which the filter belongs"
},
{
"type": "String",
"name": "filterName",
"description": "Name of the filter to reorder"
},
{
"type": "Integer",
"name": "newIndex",
"description": "Desired position of the filter in the chain"
}
],
"names": [
{
"name": "",
"description": "ReorderSourceFilter"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.5.0"
}
],
"heading": {
"level": 2,
"text": "ReorderSourceFilter"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Move a filter in the chain (relative positioning)",
"param": [
"{String} `sourceName` Name of the source to which the filter belongs",
"{String} `filterName` Name of the filter to reorder",
"{String} `movementType` How to move the filter around in the source's filter chain. Either \"up\", \"down\", \"top\" or \"bottom\"."
],
"api": "requests",
"name": "MoveSourceFilter",
"category": "sources",
"since": "4.5.0",
"params": [
{
"type": "String",
"name": "sourceName",
"description": "Name of the source to which the filter belongs"
},
{
"type": "String",
"name": "filterName",
"description": "Name of the filter to reorder"
},
{
"type": "String",
"name": "movementType",
"description": "How to move the filter around in the source's filter chain. Either \"up\", \"down\", \"top\" or \"bottom\"."
}
],
"names": [
{
"name": "",
"description": "MoveSourceFilter"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.5.0"
}
],
"heading": {
"level": 2,
"text": "MoveSourceFilter"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Update settings of a filter",
"param": [
"{String} `sourceName` Name of the source to which the filter belongs",
"{String} `filterName` Name of the filter to reconfigure",
"{Object} `filterSettings` New settings. These will be merged to the current filter settings."
],
"api": "requests",
"name": "SetSourceFilterSettings",
"category": "sources",
"since": "4.5.0",
"params": [
{
"type": "String",
"name": "sourceName",
"description": "Name of the source to which the filter belongs"
},
{
"type": "String",
"name": "filterName",
"description": "Name of the filter to reconfigure"
},
{
"type": "Object",
"name": "filterSettings",
"description": "New settings. These will be merged to the current filter settings."
}
],
"names": [
{
"name": "",
"description": "SetSourceFilterSettings"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.5.0"
}
],
"heading": {
"level": 2,
"text": "SetSourceFilterSettings"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Change the visibility/enabled state of a filter",
"param": [
"{String} `sourceName` Source name",
"{String} `filterName` Source filter name",
"{Boolean} `filterEnabled` New filter state"
],
"api": "requests",
"name": "SetSourceFilterVisibility",
"category": "sources",
"since": "4.7.0",
"params": [
{
"type": "String",
"name": "sourceName",
"description": "Source name"
},
{
"type": "String",
"name": "filterName",
"description": "Source filter name"
},
{
"type": "Boolean",
"name": "filterEnabled",
"description": "New filter state"
}
],
"names": [
{
"name": "",
"description": "SetSourceFilterVisibility"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.7.0"
}
],
"heading": {
"level": 2,
"text": "SetSourceFilterVisibility"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "\n\nAt least `embedPictureFormat` or `saveToFilePath` must be specified.\n\nClients can specify `width` and `height` parameters to receive scaled pictures. Aspect ratio is\npreserved if only one of these two parameters is specified.",
"param": [
"{String} `sourceName` Source name. Note that, since scenes are also sources, you can also provide a scene name.",
"{String (optional)} `embedPictureFormat` Format of the Data URI encoded picture. Can be \"png\", \"jpg\", \"jpeg\" or \"bmp\" (or any other value supported by Qt's Image module)",
"{String (optional)} `saveToFilePath` Full file path (file extension included) where the captured image is to be saved. Can be in a format different from `pictureFormat`. Can be a relative path.",
"{int (optional)} `width` Screenshot width. Defaults to the source's base width.",
"{int (optional)} `height` Screenshot height. Defaults to the source's base height."
],
"return": [
"{String} `sourceName` Source name",
"{String} `img` Image Data URI (if `embedPictureFormat` was specified in the request)",
"{String} `imageFile` Absolute path to the saved image file (if `saveToFilePath` was specified in the request)"
],
"api": "requests",
"name": "TakeSourceScreenshot",
"category": "sources",
"since": "4.6.0",
"returns": [
{
"type": "String",
"name": "sourceName",
"description": "Source name"
},
{
"type": "String",
"name": "img",
"description": "Image Data URI (if `embedPictureFormat` was specified in the request)"
},
{
"type": "String",
"name": "imageFile",
"description": "Absolute path to the saved image file (if `saveToFilePath` was specified in the request)"
}
],
"params": [
{
"type": "String",
"name": "sourceName",
"description": "Source name. Note that, since scenes are also sources, you can also provide a scene name."
},
{
"type": "String (optional)",
"name": "embedPictureFormat",
"description": "Format of the Data URI encoded picture. Can be \"png\", \"jpg\", \"jpeg\" or \"bmp\" (or any other value supported by Qt's Image module)"
},
{
"type": "String (optional)",
"name": "saveToFilePath",
"description": "Full file path (file extension included) where the captured image is to be saved. Can be in a format different from `pictureFormat`. Can be a relative path."
},
{
"type": "int (optional)",
"name": "width",
"description": "Screenshot width. Defaults to the source's base width."
},
{
"type": "int (optional)",
"name": "height",
"description": "Screenshot height. Defaults to the source's base height."
}
],
"names": [
{
"name": "",
"description": "TakeSourceScreenshot"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.6.0"
}
],
"heading": {
"level": 2,
"text": "TakeSourceScreenshot"
},
"lead": "Takes a picture snapshot of a source and then can either or both: - Send it over as a Data URI (base64-encoded data) in the response (by specifying `embedPictureFormat` in the request) - Save it to disk (by specifying `saveToFilePath` in the request)",
"type": "class",
"examples": []
}
],
"streaming": [
{
"subheads": [],
"description": "Get current streaming and recording status.",
"return": [
"{boolean} `streaming` Current streaming status.",
"{boolean} `recording` Current recording status.",
"{String (optional)} `stream-timecode` Time elapsed since streaming started (only present if currently streaming).",
"{String (optional)} `rec-timecode` Time elapsed since recording started (only present if currently recording).",
"{boolean} `preview-only` Always false. Retrocompatibility with OBSRemote."
],
"api": "requests",
"name": "GetStreamingStatus",
"category": "streaming",
"since": "0.3",
"returns": [
{
"type": "boolean",
"name": "streaming",
"description": "Current streaming status."
},
{
"type": "boolean",
"name": "recording",
"description": "Current recording status."
},
{
"type": "String (optional)",
"name": "stream-timecode",
"description": "Time elapsed since streaming started (only present if currently streaming)."
},
{
"type": "String (optional)",
"name": "rec-timecode",
"description": "Time elapsed since recording started (only present if currently recording)."
},
{
"type": "boolean",
"name": "preview-only",
"description": "Always false. Retrocompatibility with OBSRemote."
}
],
"names": [
{
"name": "",
"description": "GetStreamingStatus"
}
],
"categories": [
{
"name": "",
"description": "streaming"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "GetStreamingStatus"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Toggle streaming on or off.",
"api": "requests",
"name": "StartStopStreaming",
"category": "streaming",
"since": "0.3",
"names": [
{
"name": "",
"description": "StartStopStreaming"
}
],
"categories": [
{
"name": "",
"description": "streaming"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "StartStopStreaming"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Start streaming.\nWill return an `error` if streaming is already active.",
"param": [
"{Object (optional)} `stream` Special stream configuration. Please note: these won't be saved to OBS' configuration.",
"{String (optional)} `stream.type` If specified ensures the type of stream matches the given type (usually 'rtmp_custom' or 'rtmp_common'). If the currently configured stream type does not match the given stream type, all settings must be specified in the `settings` object or an error will occur when starting the stream.",
"{Object (optional)} `stream.metadata` Adds the given object parameters as encoded query string parameters to the 'key' of the RTMP stream. Used to pass data to the RTMP service about the streaming. May be any String, Numeric, or Boolean field.",
"{Object (optional)} `stream.settings` Settings for the stream.",
"{String (optional)} `stream.settings.server` The publish URL.",
"{String (optional)} `stream.settings.key` The publish key of the stream.",
"{boolean (optional)} `stream.settings.use-auth` Indicates whether authentication should be used when connecting to the streaming server.",
"{String (optional)} `stream.settings.username` If authentication is enabled, the username for the streaming server. Ignored if `use-auth` is not set to `true`.",
"{String (optional)} `stream.settings.password` If authentication is enabled, the password for the streaming server. Ignored if `use-auth` is not set to `true`."
],
"api": "requests",
"name": "StartStreaming",
"category": "streaming",
"since": "4.1.0",
"params": [
{
"type": "Object (optional)",
"name": "stream",
"description": "Special stream configuration. Please note: these won't be saved to OBS' configuration."
},
{
"type": "String (optional)",
"name": "stream.type",
"description": "If specified ensures the type of stream matches the given type (usually 'rtmp_custom' or 'rtmp_common'). If the currently configured stream type does not match the given stream type, all settings must be specified in the `settings` object or an error will occur when starting the stream."
},
{
"type": "Object (optional)",
"name": "stream.metadata",
"description": "Adds the given object parameters as encoded query string parameters to the 'key' of the RTMP stream. Used to pass data to the RTMP service about the streaming. May be any String, Numeric, or Boolean field."
},
{
"type": "Object (optional)",
"name": "stream.settings",
"description": "Settings for the stream."
},
{
"type": "String (optional)",
"name": "stream.settings.server",
"description": "The publish URL."
},
{
"type": "String (optional)",
"name": "stream.settings.key",
"description": "The publish key of the stream."
},
{
"type": "boolean (optional)",
"name": "stream.settings.use-auth",
"description": "Indicates whether authentication should be used when connecting to the streaming server."
},
{
"type": "String (optional)",
"name": "stream.settings.username",
"description": "If authentication is enabled, the username for the streaming server. Ignored if `use-auth` is not set to `true`."
},
{
"type": "String (optional)",
"name": "stream.settings.password",
"description": "If authentication is enabled, the password for the streaming server. Ignored if `use-auth` is not set to `true`."
}
],
"names": [
{
"name": "",
"description": "StartStreaming"
}
],
"categories": [
{
"name": "",
"description": "streaming"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "StartStreaming"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Stop streaming.\nWill return an `error` if streaming is not active.",
"api": "requests",
"name": "StopStreaming",
"category": "streaming",
"since": "4.1.0",
"names": [
{
"name": "",
"description": "StopStreaming"
}
],
"categories": [
{
"name": "",
"description": "streaming"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "StopStreaming"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Sets one or more attributes of the current streaming server settings. Any options not passed will remain unchanged. Returns the updated settings in response. If 'type' is different than the current streaming service type, all settings are required. Returns the full settings of the stream (the same as GetStreamSettings).",
"param": [
"{String} `type` The type of streaming service configuration, usually `rtmp_custom` or `rtmp_common`.",
"{Object} `settings` The actual settings of the stream.",
"{String (optional)} `settings.server` The publish URL.",
"{String (optional)} `settings.key` The publish key.",
"{boolean (optional)} `settings.use-auth` Indicates whether authentication should be used when connecting to the streaming server.",
"{String (optional)} `settings.username` The username for the streaming service.",
"{String (optional)} `settings.password` The password for the streaming service.",
"{boolean} `save` Persist the settings to disk."
],
"api": "requests",
"name": "SetStreamSettings",
"category": "streaming",
"since": "4.1.0",
"params": [
{
"type": "String",
"name": "type",
"description": "The type of streaming service configuration, usually `rtmp_custom` or `rtmp_common`."
},
{
"type": "Object",
"name": "settings",
"description": "The actual settings of the stream."
},
{
"type": "String (optional)",
"name": "settings.server",
"description": "The publish URL."
},
{
"type": "String (optional)",
"name": "settings.key",
"description": "The publish key."
},
{
"type": "boolean (optional)",
"name": "settings.use-auth",
"description": "Indicates whether authentication should be used when connecting to the streaming server."
},
{
"type": "String (optional)",
"name": "settings.username",
"description": "The username for the streaming service."
},
{
"type": "String (optional)",
"name": "settings.password",
"description": "The password for the streaming service."
},
{
"type": "boolean",
"name": "save",
"description": "Persist the settings to disk."
}
],
"names": [
{
"name": "",
"description": "SetStreamSettings"
}
],
"categories": [
{
"name": "",
"description": "streaming"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "SetStreamSettings"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get the current streaming server settings.",
"return": [
"{String} `type` The type of streaming service configuration. Possible values: 'rtmp_custom' or 'rtmp_common'.",
"{Object} `settings` Stream settings object.",
"{String} `settings.server` The publish URL.",
"{String} `settings.key` The publish key of the stream.",
"{boolean} `settings.use-auth` Indicates whether authentication should be used when connecting to the streaming server.",
"{String} `settings.username` The username to use when accessing the streaming server. Only present if `use-auth` is `true`.",
"{String} `settings.password` The password to use when accessing the streaming server. Only present if `use-auth` is `true`."
],
"api": "requests",
"name": "GetStreamSettings",
"category": "streaming",
"since": "4.1.0",
"returns": [
{
"type": "String",
"name": "type",
"description": "The type of streaming service configuration. Possible values: 'rtmp_custom' or 'rtmp_common'."
},
{
"type": "Object",
"name": "settings",
"description": "Stream settings object."
},
{
"type": "String",
"name": "settings.server",
"description": "The publish URL."
},
{
"type": "String",
"name": "settings.key",
"description": "The publish key of the stream."
},
{
"type": "boolean",
"name": "settings.use-auth",
"description": "Indicates whether authentication should be used when connecting to the streaming server."
},
{
"type": "String",
"name": "settings.username",
"description": "The username to use when accessing the streaming server. Only present if `use-auth` is `true`."
},
{
"type": "String",
"name": "settings.password",
"description": "The password to use when accessing the streaming server. Only present if `use-auth` is `true`."
}
],
"names": [
{
"name": "",
"description": "GetStreamSettings"
}
],
"categories": [
{
"name": "",
"description": "streaming"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "GetStreamSettings"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Save the current streaming server settings to disk.",
"api": "requests",
"name": "SaveStreamSettings",
"category": "streaming",
"since": "4.1.0",
"names": [
{
"name": "",
"description": "SaveStreamSettings"
}
],
"categories": [
{
"name": "",
"description": "streaming"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "SaveStreamSettings"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Send the provided text as embedded CEA-608 caption data.\nAs of OBS Studio 23.1, captions are not yet available on Linux.",
"param": "{String} `text` Captions text",
"api": "requests",
"name": "SendCaptions",
"category": "streaming",
"since": "4.6.0",
"params": [
{
"type": "String",
"name": "text",
"description": "Captions text"
}
],
"names": [
{
"name": "",
"description": "SendCaptions"
}
],
"categories": [
{
"name": "",
"description": "streaming"
}
],
"sinces": [
{
"name": "",
"description": "4.6.0"
}
],
"heading": {
"level": 2,
"text": "SendCaptions"
},
"lead": "",
"type": "class",
"examples": []
}
],
"studio mode": [
{
"subheads": [],
"description": "Indicates if Studio Mode is currently enabled.",
"return": "{boolean} `studio-mode` Indicates if Studio Mode is enabled.",
"api": "requests",
"name": "GetStudioModeStatus",
"category": "studio mode",
"since": "4.1.0",
"returns": [
{
"type": "boolean",
"name": "studio-mode",
"description": "Indicates if Studio Mode is enabled."
}
],
"names": [
{
"name": "",
"description": "GetStudioModeStatus"
}
],
"categories": [
{
"name": "",
"description": "studio mode"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "GetStudioModeStatus"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get the name of the currently previewed scene and its list of sources.\nWill return an `error` if Studio Mode is not enabled.",
"return": [
"{String} `name` The name of the active preview scene.",
"{Array<SceneItem>} `sources`"
],
"api": "requests",
"name": "GetPreviewScene",
"category": "studio mode",
"since": "4.1.0",
"returns": [
{
"type": "String",
"name": "name",
"description": "The name of the active preview scene."
},
{
"type": "Array<SceneItem>",
"name": "sources",
"description": ""
}
],
"names": [
{
"name": "",
"description": "GetPreviewScene"
}
],
"categories": [
{
"name": "",
"description": "studio mode"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "GetPreviewScene"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Set the active preview scene.\nWill return an `error` if Studio Mode is not enabled.",
"param": "{String} `scene-name` The name of the scene to preview.",
"api": "requests",
"name": "SetPreviewScene",
"category": "studio mode",
"since": "4.1.0",
"params": [
{
"type": "String",
"name": "scene-name",
"description": "The name of the scene to preview."
}
],
"names": [
{
"name": "",
"description": "SetPreviewScene"
}
],
"categories": [
{
"name": "",
"description": "studio mode"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "SetPreviewScene"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Transitions the currently previewed scene to the main output.\nWill return an `error` if Studio Mode is not enabled.",
"param": [
"{Object (optional)} `with-transition` Change the active transition before switching scenes. Defaults to the active transition.",
"{String} `with-transition.name` Name of the transition.",
"{int (optional)} `with-transition.duration` Transition duration (in milliseconds)."
],
"api": "requests",
"name": "TransitionToProgram",
"category": "studio mode",
"since": "4.1.0",
"params": [
{
"type": "Object (optional)",
"name": "with-transition",
"description": "Change the active transition before switching scenes. Defaults to the active transition."
},
{
"type": "String",
"name": "with-transition.name",
"description": "Name of the transition."
},
{
"type": "int (optional)",
"name": "with-transition.duration",
"description": "Transition duration (in milliseconds)."
}
],
"names": [
{
"name": "",
"description": "TransitionToProgram"
}
],
"categories": [
{
"name": "",
"description": "studio mode"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "TransitionToProgram"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Enables Studio Mode.",
"api": "requests",
"name": "EnableStudioMode",
"category": "studio mode",
"since": "4.1.0",
"names": [
{
"name": "",
"description": "EnableStudioMode"
}
],
"categories": [
{
"name": "",
"description": "studio mode"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "EnableStudioMode"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Disables Studio Mode.",
"api": "requests",
"name": "DisableStudioMode",
"category": "studio mode",
"since": "4.1.0",
"names": [
{
"name": "",
"description": "DisableStudioMode"
}
],
"categories": [
{
"name": "",
"description": "studio mode"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "DisableStudioMode"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Toggles Studio Mode.",
"api": "requests",
"name": "ToggleStudioMode",
"category": "studio mode",
"since": "4.1.0",
"names": [
{
"name": "",
"description": "ToggleStudioMode"
}
],
"categories": [
{
"name": "",
"description": "studio mode"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "ToggleStudioMode"
},
"lead": "",
"type": "class",
"examples": []
}
],
"transitions": [
{
"subheads": [],
"description": "List of all transitions available in the frontend's dropdown menu.",
"return": [
"{String} `current-transition` Name of the currently active transition.",
"{Array<Object>} `transitions` List of transitions.",
"{String} `transitions.*.name` Name of the transition."
],
"api": "requests",
"name": "GetTransitionList",
"category": "transitions",
"since": "4.1.0",
"returns": [
{
"type": "String",
"name": "current-transition",
"description": "Name of the currently active transition."
},
{
"type": "Array<Object>",
"name": "transitions",
"description": "List of transitions."
},
{
"type": "String",
"name": "transitions.*.name",
"description": "Name of the transition."
}
],
"names": [
{
"name": "",
"description": "GetTransitionList"
}
],
"categories": [
{
"name": "",
"description": "transitions"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "GetTransitionList"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get the name of the currently selected transition in the frontend's dropdown menu.",
"return": [
"{String} `name` Name of the selected transition.",
"{int (optional)} `duration` Transition duration (in milliseconds) if supported by the transition."
],
"api": "requests",
"name": "GetCurrentTransition",
"category": "transitions",
"since": "0.3",
"returns": [
{
"type": "String",
"name": "name",
"description": "Name of the selected transition."
},
{
"type": "int (optional)",
"name": "duration",
"description": "Transition duration (in milliseconds) if supported by the transition."
}
],
"names": [
{
"name": "",
"description": "GetCurrentTransition"
}
],
"categories": [
{
"name": "",
"description": "transitions"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "GetCurrentTransition"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Set the active transition.",
"param": "{String} `transition-name` The name of the transition.",
"api": "requests",
"name": "SetCurrentTransition",
"category": "transitions",
"since": "0.3",
"params": [
{
"type": "String",
"name": "transition-name",
"description": "The name of the transition."
}
],
"names": [
{
"name": "",
"description": "SetCurrentTransition"
}
],
"categories": [
{
"name": "",
"description": "transitions"
}
],
"sinces": [
{
"name": "",
"description": "0.3"
}
],
"heading": {
"level": 2,
"text": "SetCurrentTransition"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Set the duration of the currently selected transition if supported.",
"param": "{int} `duration` Desired duration of the transition (in milliseconds).",
"api": "requests",
"name": "SetTransitionDuration",
"category": "transitions",
"since": "4.0.0",
"params": [
{
"type": "int",
"name": "duration",
"description": "Desired duration of the transition (in milliseconds)."
}
],
"names": [
{
"name": "",
"description": "SetTransitionDuration"
}
],
"categories": [
{
"name": "",
"description": "transitions"
}
],
"sinces": [
{
"name": "",
"description": "4.0.0"
}
],
"heading": {
"level": 2,
"text": "SetTransitionDuration"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get the duration of the currently selected transition if supported.",
"return": "{int} `transition-duration` Duration of the current transition (in milliseconds).",
"api": "requests",
"name": "GetTransitionDuration",
"category": "transitions",
"since": "4.1.0",
"returns": [
{
"type": "int",
"name": "transition-duration",
"description": "Duration of the current transition (in milliseconds)."
}
],
"names": [
{
"name": "",
"description": "GetTransitionDuration"
}
],
"categories": [
{
"name": "",
"description": "transitions"
}
],
"sinces": [
{
"name": "",
"description": "4.1.0"
}
],
"heading": {
"level": 2,
"text": "GetTransitionDuration"
},
"lead": "",
"type": "class",
"examples": []
}
]
}
}
Reference in New Issue View Git Blame Copy Permalink