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

docs: rename typedef Source to SceneItem

Browse Source
This commit is contained in:
Stéphane Lepin 2019-05-16 13:12:18 +02:00
parent 033a6929c3
commit ae0ffdc4d5
4 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/Utils.cpp
View File

@ -28,14 +28,14 @@ with this program. If not, see <https://www.gnu.org/licenses/>
#include "Config.h" #include "Config.h"
/** /**
* @typedef {Object} `Source` An OBS Scene Item. * @typedef {Object} `SceneItem` An OBS Scene Item.
* @property {Number} `cy` * @property {Number} `cy`
* @property {Number} `cx` * @property {Number} `cx`
* @property {String} `name` The name of this Scene Item. * @property {String} `name` The name of this Scene Item.
* @property {int} `id` Scene item ID * @property {int} `id` Scene item ID
* @property {Boolean} `render` Whether or not this Scene Item is set to "visible". * @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} `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_cx`
* @property {Number} `source_cy` * @property {Number} `source_cy`
* @property {String} `type` Source type. Value is one of the following: "input", "filter", "transition", "scene" or "unknown" * @property {String} `type` Source type. Value is one of the following: "input", "filter", "transition", "scene" or "unknown"

4
src/WSEvents.cpp
View File

@ -344,7 +344,7 @@ const char* WSEvents::GetRecordingTimecode() {
* Indicates a scene change. * Indicates a scene change.
* *
* @return {String} `scene-name` The new scene. * @return {String} `scene-name` The new scene.
* @return {Array<Source>} `sources` List of sources in the new scene. Same specification as [`GetCurrentScene`](#getcurrentscene). * @return {Array<SceneItem>} `sources` List of scene items in the new scene. Same specification as [`GetCurrentScene`](#getcurrentscene).
* *
* @api events * @api events
* @name SwitchScenes * @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). * The selected preview scene has changed (only available in Studio Mode).
* *
* @return {String} `scene-name` Name of the scene being previewed. * @return {String} `scene-name` Name of the scene being previewed.
* @return {Array<Source>} `sources` List of sources composing the scene. Same specification as [`GetCurrentScene`](#getcurrentscene). * @return {Array<SceneItem>} `sources` List of sources composing the scene. Same specification as [`GetCurrentScene`](#getcurrentscene).
* *
* @api events * @api events
* @name PreviewSceneChanged * @name PreviewSceneChanged

4
src/WSRequestHandler_Scenes.cpp
View File

@ -5,7 +5,7 @@
/** /**
* @typedef {Object} `Scene` * @typedef {Object} `Scene`
* @property {String} `name` Name of the currently active scene. * @property {String} `name` Name of the currently active scene.
* @property {Array<Source>} `sources` Ordered list of the current scene's source items. * @property {Array<SceneItem>} `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. * Get the current scene's name and source items.
* *
* @return {String} `name` Name of the currently active scene. * @return {String} `name` Name of the currently active scene.
* @return {Array<Source>} `sources` Ordered list of the current scene's source items. * @return {Array<SceneItem>} `sources` Ordered list of the current scene's source items.
* *
* @api requests * @api requests
* @name GetCurrentScene * @name GetCurrentScene

2
src/WSRequestHandler_StudioMode.cpp
View File

@ -26,7 +26,7 @@ HandlerResponse WSRequestHandler::HandleGetStudioModeStatus(WSRequestHandler* re
* Will return an `error` if Studio Mode is not enabled. * Will return an `error` if Studio Mode is not enabled.
* *
* @return {String} `name` The name of the active preview scene. * @return {String} `name` The name of the active preview scene.
* @return {Array<Source>} `sources` * @return {Array<SceneItem>} `sources`
* *
* @api requests * @api requests
* @name GetPreviewScene * @name GetPreviewScene