From f655877ea2b499648744f5fe978953b1172997a5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?IOhannes=20m=20zm=C3=B6lnig?= Date: Wed, 21 Aug 2024 11:49:51 +0200 Subject: [PATCH 1/3] Fix typos in documentation --- docs/docs/partials/introduction.md | 4 ++-- docs/generated/protocol.json | 4 ++-- docs/generated/protocol.md | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/docs/partials/introduction.md b/docs/docs/partials/introduction.md index f252024c..af915d86 100644 --- a/docs/docs/partials/introduction.md +++ b/docs/docs/partials/introduction.md @@ -32,7 +32,7 @@ obs-websocket provides a feature-rich RPC communication protocol, giving access - Abstraction of identification, events, requests, and batch requests into dedicated message types - Conformity of request naming using similar terms like `Get`, `Set`, `Get[x]List`, `Start[x]`, `Toggle[x]` - Conformity of OBS data field names like `sourceName`, `sourceKind`, `sourceType`, `sceneName`, `sceneItemName` -- Error code response system - integer corrosponds to type of error, with optional comment +- Error code response system - integer corresponds to type of error, with optional comment - Possible support for multiple message encoding options: JSON and MessagePack - PubSub system - Allow clients to specify which events they do or don't want to receive from OBS - RPC versioning - Client and server negotiate the latest version of the obs-websocket protocol to communicate with. @@ -255,7 +255,7 @@ Authentication is not required - Sent from: obs-websocket - Sent to: All subscribed and identified clients -- Description: An event coming from OBS has occured. Eg scene switched, source muted. +- Description: An event coming from OBS has occurred. Eg scene switched, source muted. **Data Keys:** diff --git a/docs/generated/protocol.json b/docs/generated/protocol.json index 67456202..9f7ee8c0 100644 --- a/docs/generated/protocol.json +++ b/docs/generated/protocol.json @@ -4,7 +4,7 @@ "enumType": "EventSubscription", "enumIdentifiers": [ { - "description": "Subcription value used to disable all events.", + "description": "Subscription value used to disable all events.", "enumIdentifier": "None", "rpcVersion": "1", "deprecated": false, @@ -6710,4 +6710,4 @@ ] } ] -} \ No newline at end of file +} diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index 52b18f1a..ce710068 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -34,7 +34,7 @@ obs-websocket provides a feature-rich RPC communication protocol, giving access - Abstraction of identification, events, requests, and batch requests into dedicated message types - Conformity of request naming using similar terms like `Get`, `Set`, `Get[x]List`, `Start[x]`, `Toggle[x]` - Conformity of OBS data field names like `sourceName`, `sourceKind`, `sourceType`, `sceneName`, `sceneItemName` -- Error code response system - integer corrosponds to type of error, with optional comment +- Error code response system - integer corresponds to type of error, with optional comment - Possible support for multiple message encoding options: JSON and MessagePack - PubSub system - Allow clients to specify which events they do or don't want to receive from OBS - RPC versioning - Client and server negotiate the latest version of the obs-websocket protocol to communicate with. @@ -257,7 +257,7 @@ Authentication is not required - Sent from: obs-websocket - Sent to: All subscribed and identified clients -- Description: An event coming from OBS has occured. Eg scene switched, source muted. +- Description: An event coming from OBS has occurred. Eg scene switched, source muted. **Data Keys:** @@ -1162,7 +1162,7 @@ The combination of request fields cannot be used to perform an action. ### EventSubscription::None -Subcription value used to disable all events. +Subscription value used to disable all events. - Identifier Value: `0` - Latest Supported RPC Version: `1` From 2c35677ed37015c4d9e5251e9cdf72c66ee43e29 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?IOhannes=20m=20zm=C3=B6lnig?= Date: Wed, 21 Aug 2024 11:50:06 +0200 Subject: [PATCH 2/3] Fix typos in comments --- src/eventhandler/EventHandler.cpp | 2 +- src/eventhandler/EventHandler_Scenes.cpp | 2 +- src/eventhandler/types/EventSubscription.h | 2 +- src/utils/Compat.h | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/eventhandler/EventHandler.cpp b/src/eventhandler/EventHandler.cpp index 05e46ab6..03f1bc6e 100644 --- a/src/eventhandler/EventHandler.cpp +++ b/src/eventhandler/EventHandler.cpp @@ -500,7 +500,7 @@ void EventHandler::SourceCreatedMultiHandler(void *param, calldata_t *data) } } -// Only called for destruction of a public sourcs +// Only called for destruction of a public source // Used as a fallback if an input/scene is not explicitly removed void EventHandler::SourceDestroyedMultiHandler(void *param, calldata_t *data) { diff --git a/src/eventhandler/EventHandler_Scenes.cpp b/src/eventhandler/EventHandler_Scenes.cpp index 9dc22110..c65bed3d 100644 --- a/src/eventhandler/EventHandler_Scenes.cpp +++ b/src/eventhandler/EventHandler_Scenes.cpp @@ -133,7 +133,7 @@ void EventHandler::HandleCurrentPreviewSceneChanged() { OBSSourceAutoRelease currentPreviewScene = obs_frontend_get_current_preview_scene(); - // This event may be called when OBS is not in studio mode, however retreiving the source while not in studio mode will return null. + // This event may be called when OBS is not in studio mode, however retrieving the source while not in studio mode will return null. if (!currentPreviewScene) return; diff --git a/src/eventhandler/types/EventSubscription.h b/src/eventhandler/types/EventSubscription.h index e996bddf..c358bdda 100644 --- a/src/eventhandler/types/EventSubscription.h +++ b/src/eventhandler/types/EventSubscription.h @@ -22,7 +22,7 @@ with this program. If not, see namespace EventSubscription { enum EventSubscription { /** - * Subcription value used to disable all events. + * Subscription value used to disable all events. * * @enumIdentifier None * @enumValue 0 diff --git a/src/utils/Compat.h b/src/utils/Compat.h index 087d76c2..d749715b 100644 --- a/src/utils/Compat.h +++ b/src/utils/Compat.h @@ -24,7 +24,7 @@ with this program. If not, see namespace Utils { namespace Compat { - // Reimplement QRunnable for std::function. Retrocompatability for Qt < 5.15 + // Reimplement QRunnable for std::function. Retrocompatibility for Qt < 5.15 class StdFunctionRunnable : public QRunnable { std::function cb; From 2b95bf34b0829bf9ad697ec1fa575c05fe73edda Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?IOhannes=20m=20zm=C3=B6lnig?= Date: Wed, 21 Aug 2024 11:50:22 +0200 Subject: [PATCH 3/3] Fix typos in log messages --- src/forms/ConnectInfo.cpp | 2 +- src/forms/SettingsDialog.cpp | 6 +++--- src/websocketserver/WebSocketServer.cpp | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/forms/ConnectInfo.cpp b/src/forms/ConnectInfo.cpp index 06507a6f..5e6add9e 100644 --- a/src/forms/ConnectInfo.cpp +++ b/src/forms/ConnectInfo.cpp @@ -51,7 +51,7 @@ void ConnectInfo::RefreshData() { auto conf = GetConfig(); if (!conf) { - blog(LOG_ERROR, "[ConnectInfo::showEvent] Unable to retreive config!"); + blog(LOG_ERROR, "[ConnectInfo::showEvent] Unable to retrieve config!"); return; } diff --git a/src/forms/SettingsDialog.cpp b/src/forms/SettingsDialog.cpp index c59d5fb9..c5216e04 100644 --- a/src/forms/SettingsDialog.cpp +++ b/src/forms/SettingsDialog.cpp @@ -74,7 +74,7 @@ void SettingsDialog::showEvent(QShowEvent *) { auto conf = GetConfig(); if (!conf) { - blog(LOG_ERROR, "[SettingsDialog::showEvent] Unable to retreive config!"); + blog(LOG_ERROR, "[SettingsDialog::showEvent] Unable to retrieve config!"); return; } @@ -114,7 +114,7 @@ void SettingsDialog::RefreshData() { auto conf = GetConfig(); if (!conf) { - blog(LOG_ERROR, "[SettingsDialog::RefreshData] Unable to retreive config!"); + blog(LOG_ERROR, "[SettingsDialog::RefreshData] Unable to retrieve config!"); return; } @@ -144,7 +144,7 @@ void SettingsDialog::SaveFormData() { auto conf = GetConfig(); if (!conf) { - blog(LOG_ERROR, "[SettingsDialog::SaveFormData] Unable to retreive config!"); + blog(LOG_ERROR, "[SettingsDialog::SaveFormData] Unable to retrieve config!"); return; } diff --git a/src/websocketserver/WebSocketServer.cpp b/src/websocketserver/WebSocketServer.cpp index bd1bc3c6..dff52537 100644 --- a/src/websocketserver/WebSocketServer.cpp +++ b/src/websocketserver/WebSocketServer.cpp @@ -78,7 +78,7 @@ void WebSocketServer::Start() auto conf = GetConfig(); if (!conf) { - blog(LOG_ERROR, "[WebSocketServer::Start] Unable to retreive config!"); + blog(LOG_ERROR, "[WebSocketServer::Start] Unable to retrieve config!"); return; } @@ -222,7 +222,7 @@ void WebSocketServer::onOpen(websocketpp::connection_hdl hdl) auto conf = GetConfig(); if (!conf) { - blog(LOG_ERROR, "[WebSocketServer::onOpen] Unable to retreive config!"); + blog(LOG_ERROR, "[WebSocketServer::onOpen] Unable to retrieve config!"); return; } @@ -330,7 +330,7 @@ void WebSocketServer::onClose(websocketpp::connection_hdl hdl) // Get config for tray notification auto conf = GetConfig(); if (!conf) { - blog(LOG_ERROR, "[WebSocketServer::onClose] Unable to retreive config!"); + blog(LOG_ERROR, "[WebSocketServer::onClose] Unable to retrieve config!"); return; }