From c31ec077f588922951c2d5ea321188e69a948f89 Mon Sep 17 00:00:00 2001 From: Travis CI <> Date: Thu, 1 Nov 2018 12:15:56 +0000 Subject: [PATCH] docs(travis): Update protocol.md - afc6a60 [skip ci] --- docs/generated/comments.json | 16 ++++++++-------- docs/generated/protocol.md | 8 ++++---- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/generated/comments.json b/docs/generated/comments.json index ecf6aa67..3a3f98e2 100644 --- a/docs/generated/comments.json +++ b/docs/generated/comments.json @@ -951,7 +951,7 @@ "subheads": [], "description": "Emitted every 2 seconds after enabling it by calling SetHeartbeat.", "return": [ - "{boolean} `pulse` Toggles between every JSON meassage as an \"I am alive\" indicator.", + "{boolean} `pulse` Toggles between every JSON message as an \"I am alive\" indicator.", "{string (optional)} `current-profile` Current active profile.", "{string (optional)} `current-scene` Current active scene.", "{boolean (optional)} `streaming` Current streaming state.", @@ -970,7 +970,7 @@ { "type": "boolean", "name": "pulse", - "description": "Toggles between every JSON meassage as an \"I am alive\" indicator." + "description": "Toggles between every JSON message as an \"I am alive\" indicator." }, { "type": "string (optional)", @@ -2484,7 +2484,7 @@ "subheads": [], "description": "Reset a scene item.", "param": [ - "{String (optional)} `scene-name` Name of the scene the source belogns to. Defaults to the current scene.", + "{String (optional)} `scene-name` Name of the scene the source belongs to. Defaults to the current scene.", "{String} `item` Name of the source item." ], "api": "requests", @@ -2495,7 +2495,7 @@ { "type": "String (optional)", "name": "scene-name", - "description": "Name of the scene the source belogns to. Defaults to the current scene." + "description": "Name of the scene the source belongs to. Defaults to the current scene." }, { "type": "String", @@ -4297,7 +4297,7 @@ "subheads": [], "description": "Deletes a scene item.", "param": [ - "{String (optional)} `scene` Name of the scene the source belogns to. Defaults to the current scene.", + "{String (optional)} `scene` Name of the scene the source belongs to. Defaults to the current scene.", "{Object} `item` item to delete (required)", "{String} `item.name` name of the scene item (prefer `id`, including both is acceptable).", "{int} `item.id` id of the scene item." @@ -4310,7 +4310,7 @@ { "type": "String (optional)", "name": "scene", - "description": "Name of the scene the source belogns to. Defaults to the current scene." + "description": "Name of the scene the source belongs to. Defaults to the current scene." }, { "type": "Object", @@ -5151,7 +5151,7 @@ "{Object} `settings` Stream settings object.", "{String} `settings.server` The publish URL.", "{String} `settings.key` The publish key of the stream.", - "{boolean} `settings.use-auth` Indicates whether audentication should be used when connecting to the streaming server.", + "{boolean} `settings.use-auth` Indicates whether authentication should be used when connecting to the streaming server.", "{String} `settings.username` The username to use when accessing the streaming server. Only present if `use-auth` is `true`.", "{String} `settings.password` The password to use when accessing the streaming server. Only present if `use-auth` is `true`." ], @@ -5183,7 +5183,7 @@ { "type": "boolean", "name": "settings.use-auth", - "description": "Indicates whether audentication should be used when connecting to the streaming server." + "description": "Indicates whether authentication should be used when connecting to the streaming server." }, { "type": "String", diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index 532904d6..f1aa6c00 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -562,7 +562,7 @@ Emitted every 2 seconds after enabling it by calling SetHeartbeat. | Name | Type | Description | | ---- | :---: | ------------| -| `pulse` | _boolean_ | Toggles between every JSON meassage as an "I am alive" indicator. | +| `pulse` | _boolean_ | Toggles between every JSON message as an "I am alive" indicator. | | `current-profile` | _string (optional)_ | Current active profile. | | `current-scene` | _string (optional)_ | Current active scene. | | `streaming` | _boolean (optional)_ | Current streaming state. | @@ -1211,7 +1211,7 @@ Reset a scene item. | Name | Type | Description | | ---- | :---: | ------------| -| `scene-name` | _String (optional)_ | Name of the scene the source belogns to. Defaults to the current scene. | +| `scene-name` | _String (optional)_ | Name of the scene the source belongs to. Defaults to the current scene. | | `item` | _String_ | Name of the source item. | @@ -1822,7 +1822,7 @@ Deletes a scene item. | Name | Type | Description | | ---- | :---: | ------------| -| `scene` | _String (optional)_ | Name of the scene the source belogns to. Defaults to the current scene. | +| `scene` | _String (optional)_ | Name of the scene the source belongs to. Defaults to the current scene. | | `item` | _Object_ | item to delete (required) | | `item.name` | _String_ | name of the scene item (prefer `id`, including both is acceptable). | | `item.id` | _int_ | id of the scene item. | @@ -2154,7 +2154,7 @@ _No specified parameters._ | `settings` | _Object_ | Stream settings object. | | `settings.server` | _String_ | The publish URL. | | `settings.key` | _String_ | The publish key of the stream. | -| `settings.use-auth` | _boolean_ | Indicates whether audentication should be used when connecting to the streaming server. | +| `settings.use-auth` | _boolean_ | Indicates whether authentication should be used when connecting to the streaming server. | | `settings.username` | _String_ | The username to use when accessing the streaming server. Only present if `use-auth` is `true`. | | `settings.password` | _String_ | The password to use when accessing the streaming server. Only present if `use-auth` is `true`. |