Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix spelling #1248

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/docs/partials/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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:**

Expand Down
4 changes: 2 additions & 2 deletions docs/generated/protocol.json
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -6710,4 +6710,4 @@
]
}
]
}
}
6 changes: 3 additions & 3 deletions docs/generated/protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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:**

Expand Down Expand Up @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion src/eventhandler/EventHandler.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
2 changes: 1 addition & 1 deletion src/eventhandler/EventHandler_Scenes.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
2 changes: 1 addition & 1 deletion src/eventhandler/types/EventSubscription.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ with this program. If not, see <https://www.gnu.org/licenses/>
namespace EventSubscription {
enum EventSubscription {
/**
* Subcription value used to disable all events.
* Subscription value used to disable all events.
*
* @enumIdentifier None
* @enumValue 0
Expand Down
2 changes: 1 addition & 1 deletion src/forms/ConnectInfo.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down
6 changes: 3 additions & 3 deletions src/forms/SettingsDialog.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down Expand Up @@ -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;
}

Expand Down Expand Up @@ -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;
}

Expand Down
2 changes: 1 addition & 1 deletion src/utils/Compat.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ with this program. If not, see <https://www.gnu.org/licenses/>

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<void()> cb;

Expand Down
6 changes: 3 additions & 3 deletions src/websocketserver/WebSocketServer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

Expand Down Expand Up @@ -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;
}

Expand Down Expand Up @@ -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;
}

Expand Down