search

obsproject / obs-websocket

Remote-control of OBS Studio through WebSocket
GNU General Public License v2.0
3.8k stars 701 forks source link

Feature Request: Documentation on using GroupNames as SceneNames #1125

Open MichiShyGuy opened 1 year ago

MichiShyGuy commented 1 year ago

Feature Request Type

Other

Feature Request Type (Other)

Documentation

Requested Feature

You should clarify in your documentation, that you can supply a GroupName as a SceneName.

The sourcecode points this out already: https://github.com/obsproject/obs-websocket/blob/265899f76f88a5be74747308fff3d35347ce43c5/src/requesthandler/RequestHandler_SceneItems.cpp#L89

But in the description of the variable "sceneName" there is no reference to groups. https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#setsceneitemenabled

This would help clarifying potential misconceptions about how to handle SceneItems that are within a group.

Requested Feature Usage Scenario

Clarified handling of requests that concern Items within Groups.

tt2468 commented 1 year ago

The documentation of these requests literally says Groups only, Scenes only, or Scenes and Groups

MichiShyGuy commented 1 year ago

I know that it refences that in the main description, but its not clear that the parameter "sceneName" then should be used for the Group name. I think it wouldn't hurt to add it to the variable description. And since the soourcecode documentation does in fact mention it on parameter level it propably isn't too far fetched to mention it.

tt2468 @.***> schrieb am Do., 13. Apr. 2023, 13:06:

The documentation of these requests literally says Groups only, Scenes only, or Scenes and Groups

— Reply to this email directly, view it on GitHub https://github.com/obsproject/obs-websocket/issues/1125#issuecomment-1506773472, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAYF535HZFOZJ4TYOY5K6DLXA7M3VANCNFSM6AAAAAAW45DPJA . You are receiving this because you authored the thread.Message ID: @.***>