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: realign comments

Browse Source
This commit is contained in:
Palakis 2017-10-27 15:51:23 +02:00
parent 2d49bcc437
commit e2b70fd795
1 changed files with 40 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
WSRequestHandler.cpp
View File

@ -2702,17 +2702,17 @@ void WSRequestHandler::HandleResetSceneItem(WSRequestHandler* req) {
} }
/** /**
* List all sources available in the running OBS instance * List all sources available in the running OBS instance
* *
* @return {Array of Objects} `sources` Array of sources as objects * @return {Array of Objects} `sources` Array of sources as objects
* @return {String} `sources.*.name` Source name * @return {String} `sources.*.name` Source name
* @return {String} `sources.*.type` Source type * @return {String} `sources.*.type` Source type
* *
* @api requests * @api requests
* @name GetSourcesList * @name GetSourcesList
* @category sources * @category sources
* @since unreleased * @since unreleased
*/ */
void WSRequestHandler::HandleGetSourcesList(WSRequestHandler* req) { void WSRequestHandler::HandleGetSourcesList(WSRequestHandler* req) {
obs_data_array_t* sourcesArray = obs_data_array_create(); obs_data_array_t* sourcesArray = obs_data_array_create();
@ -2744,20 +2744,20 @@ void WSRequestHandler::HandleGetSourcesList(WSRequestHandler* req) {
} }
/** /**
* Get settings of the specified source * Get settings of the specified source
* *
* @param {String} `sourceName` Name of the source item. * @param {String} `sourceName` Name of the source item.
* @param {String (optional) `sourceType` Type of the specified source. Useful for type-checking if you expect a specific settings schema. * @param {String (optional) `sourceType` Type of the specified source. Useful for type-checking if you expect a specific settings schema.
* *
* @return {String} `sourceName` Source name * @return {String} `sourceName` Source name
* @return {String} `sourceType` Type of the specified source * @return {String} `sourceType` Type of the specified source
* @return {Object} `sourceSettings` Source settings. Varying between source types. * @return {Object} `sourceSettings` Source settings. Varying between source types.
* *
* @api requests * @api requests
* @name GetSourceSettings * @name GetSourceSettings
* @category sources * @category sources
* @since unreleased * @since unreleased
*/ */
void WSRequestHandler::HandleGetSourceSettings(WSRequestHandler* req) { void WSRequestHandler::HandleGetSourceSettings(WSRequestHandler* req) {
if (!req->hasField("sourceName")) { if (!req->hasField("sourceName")) {
req->SendErrorResponse("missing request parameters"); req->SendErrorResponse("missing request parameters");
@ -2796,21 +2796,21 @@ void WSRequestHandler::HandleGetSourceSettings(WSRequestHandler* req) {
} }
/** /**
* Set settings of the specified source. * Set settings of the specified source.
* *
* @param {String} `sourceName` Name of the source item. * @param {String} `sourceName` Name of the source item.
* @param {String (optional)} `sourceType` Type of the specified source. Useful for type-checking to avoid settings a set of settings incompatible with the actual source's type. * @param {String (optional)} `sourceType` Type of the specified source. Useful for type-checking to avoid settings a set of settings incompatible with the actual source's type.
* @param {Object} `sourceSettings` Source settings. Varying between source types. * @param {Object} `sourceSettings` Source settings. Varying between source types.
* *
* @return {String} `sourceName` Source name * @return {String} `sourceName` Source name
* @return {String} `sourceType` Type of the specified source * @return {String} `sourceType` Type of the specified source
* @return {Object} `sourceSettings` Source settings. Varying between source types. * @return {Object} `sourceSettings` Source settings. Varying between source types.
* *
* @api requests * @api requests
* @name SetSourceSettings * @name SetSourceSettings
* @category sources * @category sources
* @since unreleased * @since unreleased
*/ */
void WSRequestHandler::HandleSetSourceSettings(WSRequestHandler* req) { void WSRequestHandler::HandleSetSourceSettings(WSRequestHandler* req) {
if (!req->hasField("sourceName") || !req->hasField("sourceSettings")) { if (!req->hasField("sourceName") || !req->hasField("sourceSettings")) {
req->SendErrorResponse("missing request parameters"); req->SendErrorResponse("missing request parameters");