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

Merge pull request #308 from Palakis/bugfix/285-item-id

Browse Source 
Provide scene item id in events data and request responses
This commit is contained in:
Stéphane Lepin 2019-04-22 19:56:08 +02:00 committed by GitHub
commit 43d38a2e63
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 41 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/Utils.cpp
View File

@ -115,11 +115,13 @@ obs_data_t* Utils::GetSceneItemData(obs_sceneitem_t* item) {
obs_data_t* data = obs_data_create();
obs_data_set_string(data, "name",
obs_source_get_name(obs_sceneitem_get_source(item)));
obs_source_get_name(itemSource));
obs_data_set_int(data, "id",
obs_sceneitem_get_id(item));
obs_data_set_string(data, "type",
obs_source_get_id(obs_sceneitem_get_source(item)));
obs_source_get_id(itemSource));
obs_data_set_double(data, "volume",
obs_source_get_volume(obs_sceneitem_get_source(item)));
obs_source_get_volume(itemSource));
obs_data_set_double(data, "x", pos.x);
obs_data_set_double(data, "y", pos.y);
obs_data_set_int(data, "source_cx", (int)item_width);

36
src/WSEvents.cpp
View File

@ -1169,6 +1169,7 @@ void WSEvents::OnSceneReordered(void* param, calldata_t* data) {
*
* @return {String} `scene-name` Name of the scene.
* @return {String} `item-name` Name of the item added to the scene.
* @return {int} `item-id` Scene item ID
*
* @api events
* @name SceneItemAdded
@ -1192,7 +1193,7 @@ void WSEvents::OnSceneItemAdd(void* param, calldata_t* data) {
OBSDataAutoRelease fields = obs_data_create();
obs_data_set_string(fields, "scene-name", sceneName);
obs_data_set_string(fields, "item-name", sceneItemName);
obs_data_set_int(fields, "item-id", obs_sceneitem_get_id(sceneItem));
instance->broadcastUpdate("SceneItemAdded", fields);
}
@ -1201,6 +1202,7 @@ void WSEvents::OnSceneItemAdd(void* param, calldata_t* data) {
*
* @return {String} `scene-name` Name of the scene.
* @return {String} `item-name` Name of the item removed from the scene.
* @return {int} `item-id` Scene item ID
*
* @api events
* @name SceneItemRemoved
@ -1224,7 +1226,7 @@ void WSEvents::OnSceneItemDelete(void* param, calldata_t* data) {
OBSDataAutoRelease fields = obs_data_create();
obs_data_set_string(fields, "scene-name", sceneName);
obs_data_set_string(fields, "item-name", sceneItemName);
obs_data_set_int(fields, "item-id", obs_sceneitem_get_id(sceneItem));
instance->broadcastUpdate("SceneItemRemoved", fields);
}
@ -1233,6 +1235,7 @@ void WSEvents::OnSceneItemDelete(void* param, calldata_t* data) {
*
* @return {String} `scene-name` Name of the scene.
* @return {String} `item-name` Name of the item in the scene.
* @return {int} `item-id` Scene item ID
* @return {boolean} `item-visible` New visibility state of the item.
*
* @api events
@ -1260,8 +1263,8 @@ void WSEvents::OnSceneItemVisibilityChanged(void* param, calldata_t* data) {
OBSDataAutoRelease fields = obs_data_create();
obs_data_set_string(fields, "scene-name", sceneName);
obs_data_set_string(fields, "item-name", sceneItemName);
obs_data_set_int(fields, "item-id", obs_sceneitem_get_id(sceneItem));
obs_data_set_bool(fields, "item-visible", visible);
instance->broadcastUpdate("SceneItemVisibilityChanged", fields);
}
@ -1270,6 +1273,7 @@ void WSEvents::OnSceneItemVisibilityChanged(void* param, calldata_t* data) {
*
* @return {String} `scene-name` Name of the scene.
* @return {String} `item-name` Name of the item in the scene.
* @return {int} `item-id` Scene item ID
* @return {SceneItemProperties} `transform` Scene item transform properties
*
* @api events
@ -1296,17 +1300,17 @@ void WSEvents::OnSceneItemTransform(void* param, calldata_t* data) {
OBSDataAutoRelease fields = obs_data_create();
obs_data_set_string(fields, "scene-name", sceneName);
obs_data_set_string(fields, "item-name", sceneItemName);
obs_data_set_int(fields, "item-id", obs_sceneitem_get_id(sceneItem));
obs_data_set_obj(fields, "transform", transform);
instance->broadcastUpdate("SceneItemTransformChanged", fields);
}
/**
* A scene item is selected.
*
* @return {String} `sceneName` Name of the scene.
* @return {String} `itemName` Name of the item in the scene.
* @return {int} `itemId` Name of the item in the scene.
* @return {String} `scene-name` Name of the scene.
* @return {String} `item-name` Name of the item in the scene.
* @return {int} `item-id` Name of the item in the scene.
*
* @api events
* @name SceneItemSelected
@ -1330,18 +1334,18 @@ void WSEvents::OnSceneItemSelected(void* param, calldata_t* data) {
OBSSource itemSource = obs_sceneitem_get_source(item);
OBSDataAutoRelease fields = obs_data_create();
obs_data_set_string(fields, "sceneName", obs_source_get_name(sceneSource));
obs_data_set_string(fields, "itemName", obs_source_get_name(itemSource));
obs_data_set_int(fields, "itemId", obs_sceneitem_get_id(item));
obs_data_set_string(fields, "scene-name", obs_source_get_name(sceneSource));
obs_data_set_string(fields, "item-name", obs_source_get_name(itemSource));
obs_data_set_int(fields, "item-id", obs_sceneitem_get_id(item));
self->broadcastUpdate("SceneItemSelected", fields);
}
/**
* A scene item is deselected.
*
* @return {String} `sceneName` Name of the scene.
* @return {String} `itemName` Name of the item in the scene.
* @return {int} `itemId` Name of the item in the scene.
* @return {String} `scene-name` Name of the scene.
* @return {String} `item-name` Name of the item in the scene.
* @return {int} `item-id` Name of the item in the scene.
*
* @api events
* @name SceneItemDeselected
@ -1365,9 +1369,9 @@ void WSEvents::OnSceneItemDeselected(void* param, calldata_t* data) {
OBSSource itemSource = obs_sceneitem_get_source(item);
OBSDataAutoRelease fields = obs_data_create();
obs_data_set_string(fields, "sceneName", obs_source_get_name(sceneSource));
obs_data_set_string(fields, "itemName", obs_source_get_name(itemSource));
obs_data_set_int(fields, "itemId", obs_sceneitem_get_id(item));
obs_data_set_string(fields, "scene-name", obs_source_get_name(sceneSource));
obs_data_set_string(fields, "item-name", obs_source_get_name(itemSource));
obs_data_set_int(fields, "item-id", obs_sceneitem_get_id(item));
self->broadcastUpdate("SceneItemDeselected", fields);
}

16
src/WSRequestHandler_SceneItems.cpp
View File

@ -2,6 +2,22 @@
#include "WSRequestHandler.h"
/**
* @typedef {Object} `Source` 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 {Number} `source_cx`
* @property {Number} `source_cy`
* @property {String} `type` Source type. Value is one of the following: "input", "filter", "transition", "scene" or "unknown"
* @property {Number} `volume`
* @property {Number} `x`
* @property {Number} `y`
*/
/**
* Gets the scene specific properties of the specified source item.
*

14
src/WSRequestHandler_Sources.cpp
View File

@ -2,20 +2,6 @@
#include "WSRequestHandler.h"
/**
* @typedef {Object} `Source` An OBS Scene Item.
* @property {Number} `cy`
* @property {Number} `cx`
* @property {String} `name` The name of this Scene Item.
* @property {Boolean} `render` Whether or not this Scene Item is set to "visible".
* @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"
* @property {Number} `volume`
* @property {Number} `x`
* @property {Number} `y`
*/
/**
* List all sources available in the running OBS instance
*