obs-websocket
obs-websocket copied to clipboard
obsproject
Feature Request: Improve Documentation about Data Field Description
Feature Request Type
Other
Feature Request Type (Other)
Documentation Improvement
Requested Feature
Hi all,
first of all, I'd really like thank everyone who contributed to this excellent library, especially version 5.
I'm just missing a few points in the documentation. For example:
The description of the InputVolumeMeters is not very clear. It just says:
But what do the actual numbers in the array represent?
I didn't get an answer on Discord.
The levels I get are a two-dimensional array in the form of
[
[ number, number, number ],
[ number, number, number ],
]
for each input. I suspect that those are the channels L and R, but why three numeric values for each channel?
Another example for unsufficient docs would be GetSceneList.
It does not explain the type scene, it just says Object which is obvious, but not that helpful....
Requested Feature Usage Scenario
With all those information included in the docs, people would not have to try out the commands and manually see what is returned by obs (see example with GetSceneList).
It would also help to understand other things which cannot be "reverse engineered" easily like the InputVolumeMeters.
Hi @hrueger !
I was also a little confused by the InputVolumeMeters event format so I did a little digging through the commit history and found the following commit message. Hope it helps you too!
https://github.com/obsproject/obs-websocket/commit/d48ddef0318af1e370a4d0b77751afc14ac6b140
Very excited for all of the changes in version 5, but documenting all of the new features is definitely not a small task. I've not contributed to this repo before, but I might try giving it a go as/when I find more info!
