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

general: Fix several typos throughout

Browse Source
This commit is contained in:
Ryan Foster
2018-11-01 00:42:02 -04:00
parent feaeef5a70
commit 37ea7073d5
4 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/WSEvents.cpp
View File

@ -657,7 +657,7 @@ void WSEvents::StreamStatus() {
/** /**
* Emitted every 2 seconds after enabling it by calling SetHeartbeat. * Emitted every 2 seconds after enabling it by calling SetHeartbeat.
* *
* @return {boolean} `pulse` Toggles between every JSON meassage as an "I am alive" indicator. * @return {boolean} `pulse` Toggles between every JSON message as an "I am alive" indicator.
* @return {string (optional)} `current-profile` Current active profile. * @return {string (optional)} `current-profile` Current active profile.
* @return {string (optional)} `current-scene` Current active scene. * @return {string (optional)} `current-scene` Current active scene.
* @return {boolean (optional)} `streaming` Current streaming state. * @return {boolean (optional)} `streaming` Current streaming state.

2
src/WSRequestHandler_SceneItems.cpp
View File

@ -322,7 +322,7 @@ void WSRequestHandler::HandleSetSceneItemProperties(WSRequestHandler* req) {
/** /**
* Reset a scene item. * Reset a scene item.
* *
* @param {String (optional)} `scene-name` Name of the scene the source belogns to. Defaults to the current scene. * @param {String (optional)} `scene-name` Name of the scene the source belongs to. Defaults to the current scene.
* @param {String} `item` Name of the source item. * @param {String} `item` Name of the source item.
* *
* @api requests * @api requests

8
src/WSRequestHandler_Sources.cpp
View File

@ -227,7 +227,7 @@ void WSRequestHandler::HandleGetVolume(WSRequestHandler* req) {
*/ */
void WSRequestHandler::HandleGetMute(WSRequestHandler* req) { void WSRequestHandler::HandleGetMute(WSRequestHandler* req) {
if (!req->hasField("source")) { if (!req->hasField("source")) {
req->SendErrorResponse("mssing request parameters"); req->SendErrorResponse("missing request parameters");
return; return;
} }
@ -264,7 +264,7 @@ void WSRequestHandler::HandleGetMute(WSRequestHandler* req) {
void WSRequestHandler::HandleSetMute(WSRequestHandler* req) { void WSRequestHandler::HandleSetMute(WSRequestHandler* req) {
if (!req->hasField("source") || if (!req->hasField("source") ||
!req->hasField("mute")) { !req->hasField("mute")) {
req->SendErrorResponse("mssing request parameters"); req->SendErrorResponse("missing request parameters");
return; return;
} }
@ -967,7 +967,7 @@ void WSRequestHandler::HandleSetBrowserSourceProperties(WSRequestHandler* req) {
/** /**
* Deletes a scene item. * Deletes a scene item.
* *
* @param {String (optional)} `scene` Name of the scene the source belogns to. Defaults to the current scene. * @param {String (optional)} `scene` Name of the scene the source belongs to. Defaults to the current scene.
* @param {Object} `item` item to delete (required) * @param {Object} `item` item to delete (required)
* @param {String} `item.name` name of the scene item (prefer `id`, including both is acceptable). * @param {String} `item.name` name of the scene item (prefer `id`, including both is acceptable).
* @param {int} `item.id` id of the scene item. * @param {int} `item.id` id of the scene item.
@ -1065,7 +1065,7 @@ void WSRequestHandler::HandleDuplicateSceneItem(WSRequestHandler* req) {
obs_sceneitem_t *newItem = data.newItem; obs_sceneitem_t *newItem = data.newItem;
if (!newItem) { if (!newItem) {
req->SendErrorResponse("Error duplicating scenee item"); req->SendErrorResponse("Error duplicating scene item");
} }
OBSDataAutoRelease responseData = obs_data_create(); OBSDataAutoRelease responseData = obs_data_create();
OBSDataAutoRelease itemData = obs_data_create(); OBSDataAutoRelease itemData = obs_data_create();

2
src/WSRequestHandler_Streaming.cpp
View File

@ -252,7 +252,7 @@ void WSRequestHandler::HandleStopStreaming(WSRequestHandler* req) {
* @return {Object} `settings` Stream settings object. * @return {Object} `settings` Stream settings object.
* @return {String} `settings.server` The publish URL. * @return {String} `settings.server` The publish URL.
* @return {String} `settings.key` The publish key of the stream. * @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. * @return {boolean} `settings.use-auth` Indicates whether authentication should be used when connecting to the streaming server.
* @return {String} `settings.username` The username to use when accessing the streaming server. Only present if `use-auth` is `true`. * @return {String} `settings.username` The username to use when accessing the streaming server. Only present if `use-auth` is `true`.
* @return {String} `settings.password` The password to use when accessing the streaming server. Only present if `use-auth` is `true`. * @return {String} `settings.password` The password to use when accessing the streaming server. Only present if `use-auth` is `true`.
* *