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(requests): fix SetStreamSettings

Browse Source
This commit is contained in:
Palakis 2017-10-16 13:12:49 +02:00
parent a6ba7f8feb
commit 70a8533f5e
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
WSRequestHandler.cpp
View File

@ -1456,7 +1456,7 @@ void WSRequestHandler::HandleGetCurrentProfile(WSRequestHandler* req) {
* @param {boolean} `save` Persist the settings to disk.
*
* @api requests
* @name SetStreamingSettings
* @name SetStreamSettings
* @category settings
* @since 4.1.0
*/
@ -1509,8 +1509,8 @@ void WSRequestHandler::HandleSetStreamSettings(WSRequestHandler* req) {
/**
* Get the current streaming server settings.
*
* @return {String} `type` The type of streaming service configuration. Usually 'rtmp_custom' or 'rtmp_common'.
* @return {Object} `settings` Setings of the stream.
* @return {String} `type` The type of streaming service configuration. Possible values: 'rtmp_custom' or 'rtmp_common'.
* @return {Object} `settings` Stream settings object.
* @return {String} `settings.server` The publish URL.
* @return {String} `settings.key` The publish key of the stream.
* @return {boolean} `settings.use-auth` Indicates whether audentication should be used when connecting to the streaming server.