diff --git a/src/Utils.cpp b/src/Utils.cpp index b1b656e0..38b457c2 100644 --- a/src/Utils.cpp +++ b/src/Utils.cpp @@ -28,14 +28,14 @@ with this program. If not, see #include "Config.h" /** -* @typedef {Object} `Source` An OBS Scene Item. +* @typedef {Object} `SceneItem` An OBS Scene Item. * @property {Number} `cy` * @property {Number} `cx` * @property {String} `name` The name of this Scene Item. * @property {int} `id` Scene item ID * @property {Boolean} `render` Whether or not this Scene Item is set to "visible". * @property {Boolean} `locked` Whether or not this Scene Item is locked and can't be moved around -* @property {Boolean} `isGroup` Whether or not this Scene Item is a group +* @property {Boolean} `isGroup` Whether or not this Scene Item is a group * @property {Number} `source_cx` * @property {Number} `source_cy` * @property {String} `type` Source type. Value is one of the following: "input", "filter", "transition", "scene" or "unknown" diff --git a/src/WSEvents.cpp b/src/WSEvents.cpp index 98169f2c..30cb99e0 100644 --- a/src/WSEvents.cpp +++ b/src/WSEvents.cpp @@ -344,7 +344,7 @@ const char* WSEvents::GetRecordingTimecode() { * Indicates a scene change. * * @return {String} `scene-name` The new scene. - * @return {Array} `sources` List of sources in the new scene. Same specification as [`GetCurrentScene`](#getcurrentscene). + * @return {Array} `sources` List of scene items in the new scene. Same specification as [`GetCurrentScene`](#getcurrentscene). * * @api events * @name SwitchScenes @@ -1435,7 +1435,7 @@ void WSEvents::OnSceneItemDeselected(void* param, calldata_t* data) { * The selected preview scene has changed (only available in Studio Mode). * * @return {String} `scene-name` Name of the scene being previewed. - * @return {Array} `sources` List of sources composing the scene. Same specification as [`GetCurrentScene`](#getcurrentscene). + * @return {Array} `sources` List of sources composing the scene. Same specification as [`GetCurrentScene`](#getcurrentscene). * * @api events * @name PreviewSceneChanged diff --git a/src/WSRequestHandler_Scenes.cpp b/src/WSRequestHandler_Scenes.cpp index 6b63d71d..6e8429c8 100644 --- a/src/WSRequestHandler_Scenes.cpp +++ b/src/WSRequestHandler_Scenes.cpp @@ -5,7 +5,7 @@ /** * @typedef {Object} `Scene` * @property {String} `name` Name of the currently active scene. -* @property {Array} `sources` Ordered list of the current scene's source items. +* @property {Array} `sources` Ordered list of the current scene's source items. */ /** @@ -38,7 +38,7 @@ HandlerResponse WSRequestHandler::HandleSetCurrentScene(WSRequestHandler* req) { * Get the current scene's name and source items. * * @return {String} `name` Name of the currently active scene. - * @return {Array} `sources` Ordered list of the current scene's source items. + * @return {Array} `sources` Ordered list of the current scene's source items. * * @api requests * @name GetCurrentScene diff --git a/src/WSRequestHandler_StudioMode.cpp b/src/WSRequestHandler_StudioMode.cpp index 57f54e4b..de64fc97 100644 --- a/src/WSRequestHandler_StudioMode.cpp +++ b/src/WSRequestHandler_StudioMode.cpp @@ -26,7 +26,7 @@ HandlerResponse WSRequestHandler::HandleGetStudioModeStatus(WSRequestHandler* re * Will return an `error` if Studio Mode is not enabled. * * @return {String} `name` The name of the active preview scene. - * @return {Array} `sources` + * @return {Array} `sources` * * @api requests * @name GetPreviewScene