obsproject / obs-websocket

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

Bug: Documentation errors (Sleep / GetOutputList) #1042

Closed nvdweem closed 2 years ago

nvdweem commented 2 years ago

Operating System Info

Windows 11

Other OS

No response

OBS Studio Version

28.0.0

OBS Studio Version (Other)

No response

obs-websocket Version

5.0.0

OBS Studio Log URL

-

OBS Studio Crash Log URL

No response

Expected Behavior

Sleep should have two optional arguments, like the OpenVideoMixProjector which also has mutually exclusive request fields.

GetOutputList should describe what it returns.

Current Behavior

The documentation (json) describes the Sleep incorrectly. I expect that the GetOutputList is also incorrect.

Sleep:

GetOutputList

Steps to Reproduce

  1. Open the protocol.md
  2. Find the mistakes

Anything else we should know?

No response