docs(travis): Update protocol.md - 43d38a2 [skip ci]

docs/generated/comments.json

@@ -216,39 +216,6 @@
       },
       "examples": []
     },
-    {
-      "subheads": [],
-      "typedef": "{Object} `Scene`",
-      "property": [
-        "{String} `name` Name of the currently active scene.",
-        "{Array<Source>} `sources` Ordered list of the current scene's source items."
-      ],
-      "properties": [
-        {
-          "type": "String",
-          "name": "name",
-          "description": "Name of the currently active scene."
-        },
-        {
-          "type": "Array<Source>",
-          "name": "sources",
-          "description": "Ordered list of the current scene's source items."
-        }
-      ],
-      "typedefs": [
-        {
-          "type": "Object",
-          "name": "Scene",
-          "description": ""
-        }
-      ],
-      "name": "",
-      "heading": {
-        "level": 2,
-        "text": ""
-      },
-      "examples": []
-    },
     {
       "subheads": [],
       "typedef": "{Object} `Source` An OBS Scene Item.",
@@ -256,7 +223,9 @@
         "{Number} `cy`",
         "{Number} `cx`",
         "{String} `name` The name of this Scene Item.",
+        "{int} `id` Scene item ID",
         "{Boolean} `render` Whether or not this Scene Item is set to \"visible\".",
+        "{Boolean} `locked` Whether or not this Scene Item is locked and can't be moved around",
         "{Number} `source_cx`",
         "{Number} `source_cy`",
         "{String} `type` Source type. Value is one of the following: \"input\", \"filter\", \"transition\", \"scene\" or \"unknown\"",
@@ -280,11 +249,21 @@
           "name": "name",
           "description": "The name of this Scene Item."
         },
+        {
+          "type": "int",
+          "name": "id",
+          "description": "Scene item ID"
+        },
         {
           "type": "Boolean",
           "name": "render",
           "description": "Whether or not this Scene Item is set to \"visible\"."
         },
+        {
+          "type": "Boolean",
+          "name": "locked",
+          "description": "Whether or not this Scene Item is locked and can't be moved around"
+        },
         {
           "type": "Number",
           "name": "source_cx",
@@ -329,6 +308,39 @@
         "text": ""
       },
       "examples": []
+    },
+    {
+      "subheads": [],
+      "typedef": "{Object} `Scene`",
+      "property": [
+        "{String} `name` Name of the currently active scene.",
+        "{Array<Source>} `sources` Ordered list of the current scene's source items."
+      ],
+      "properties": [
+        {
+          "type": "String",
+          "name": "name",
+          "description": "Name of the currently active scene."
+        },
+        {
+          "type": "Array<Source>",
+          "name": "sources",
+          "description": "Ordered list of the current scene's source items."
+        }
+      ],
+      "typedefs": [
+        {
+          "type": "Object",
+          "name": "Scene",
+          "description": ""
+        }
+      ],
+      "name": "",
+      "heading": {
+        "level": 2,
+        "text": ""
+      },
+      "examples": []
     }
   ],
   "events": {
@@ -2059,7 +2071,8 @@
         "description": "An item has been added to the current scene.",
         "return": [
           "{String} `scene-name` Name of the scene.",
-          "{String} `item-name` Name of the item added to the scene."
+          "{String} `item-name` Name of the item added to the scene.",
+          "{int} `item-id` Scene item ID"
         ],
         "api": "events",
         "name": "SceneItemAdded",
@@ -2075,6 +2088,11 @@
             "type": "String",
             "name": "item-name",
             "description": "Name of the item added to the scene."
+          },
+          {
+            "type": "int",
+            "name": "item-id",
+            "description": "Scene item ID"
           }
         ],
         "names": [
@@ -2108,7 +2126,8 @@
         "description": "An item has been removed from the current scene.",
         "return": [
           "{String} `scene-name` Name of the scene.",
-          "{String} `item-name` Name of the item removed from the scene."
+          "{String} `item-name` Name of the item removed from the scene.",
+          "{int} `item-id` Scene item ID"
         ],
         "api": "events",
         "name": "SceneItemRemoved",
@@ -2124,6 +2143,11 @@
             "type": "String",
             "name": "item-name",
             "description": "Name of the item removed from the scene."
+          },
+          {
+            "type": "int",
+            "name": "item-id",
+            "description": "Scene item ID"
           }
         ],
         "names": [
@@ -2158,6 +2182,7 @@
         "return": [
           "{String} `scene-name` Name of the scene.",
           "{String} `item-name` Name of the item in the scene.",
+          "{int} `item-id` Scene item ID",
           "{boolean} `item-visible` New visibility state of the item."
         ],
         "api": "events",
@@ -2175,6 +2200,11 @@
             "name": "item-name",
             "description": "Name of the item in the scene."
           },
+          {
+            "type": "int",
+            "name": "item-id",
+            "description": "Scene item ID"
+          },
           {
             "type": "boolean",
             "name": "item-visible",
@@ -2213,6 +2243,7 @@
         "return": [
           "{String} `scene-name` Name of the scene.",
           "{String} `item-name` Name of the item in the scene.",
+          "{int} `item-id` Scene item ID",
           "{SceneItemProperties} `transform` Scene item transform properties"
         ],
         "api": "events",
@@ -2230,6 +2261,11 @@
             "name": "item-name",
             "description": "Name of the item in the scene."
           },
+          {
+            "type": "int",
+            "name": "item-id",
+            "description": "Scene item ID"
+          },
           {
             "type": "SceneItemProperties",
             "name": "transform",
@@ -2266,9 +2302,9 @@
         "subheads": [],
         "description": "A scene item is selected.",
         "return": [
-          "{String} `sceneName` Name of the scene.",
+          "{String} `scene-name` Name of the scene.",
-          "{String} `itemName` Name of the item in the scene.",
+          "{String} `item-name` Name of the item in the scene.",
-          "{int} `itemId` Name of the item in the scene."
+          "{int} `item-id` Name of the item in the scene."
         ],
         "api": "events",
         "name": "SceneItemSelected",
@@ -2277,17 +2313,17 @@
         "returns": [
           {
             "type": "String",
-            "name": "sceneName",
+            "name": "scene-name",
             "description": "Name of the scene."
           },
           {
             "type": "String",
-            "name": "itemName",
+            "name": "item-name",
             "description": "Name of the item in the scene."
           },
           {
             "type": "int",
-            "name": "itemId",
+            "name": "item-id",
             "description": "Name of the item in the scene."
           }
         ],
@@ -2321,9 +2357,9 @@
         "subheads": [],
         "description": "A scene item is deselected.",
         "return": [
-          "{String} `sceneName` Name of the scene.",
+          "{String} `scene-name` Name of the scene.",
-          "{String} `itemName` Name of the item in the scene.",
+          "{String} `item-name` Name of the item in the scene.",
-          "{int} `itemId` Name of the item in the scene."
+          "{int} `item-id` Name of the item in the scene."
         ],
         "api": "events",
         "name": "SceneItemDeselected",
@@ -2332,17 +2368,17 @@
         "returns": [
           {
             "type": "String",
-            "name": "sceneName",
+            "name": "scene-name",
             "description": "Name of the scene."
           },
           {
             "type": "String",
-            "name": "itemName",
+            "name": "item-name",
             "description": "Name of the item in the scene."
           },
           {
             "type": "int",
-            "name": "itemId",
+            "name": "item-id",
             "description": "Name of the item in the scene."
           }
         ],

docs/generated/protocol.md

@@ -45,8 +45,8 @@ auth_response = base64_encode(auth_response_hash)
 - [Typedefs](#typedefs)
   * [SceneItemTransform](#sceneitemtransform)
   * [OBSStats](#obsstats)
-  * [Scene](#scene)
   * [Source](#source)
+  * [Scene](#scene)
 - [Events](#events)
   * [Scenes](#scenes)
     + [SwitchScenes](#switchscenes)
@@ -235,24 +235,26 @@ These are complex types, such as `Source` and `Scene`, which are used as argumen
 | `cpu-usage` | _double_ | Current CPU usage (percentage) |
 | `memory-usage` | _double_ | Current RAM usage (in megabytes) |
 | `free-disk-space` | _double_ | Free recording disk space (in megabytes) |
-## Scene
-| Name | Type  | Description |
-| ---- | :---: | ------------|
-| `name` | _String_ | Name of the currently active scene. |
-| `sources` | _Array<Source>_ | Ordered list of the current scene's source items. |
 ## Source
 | Name | Type  | Description |
 | ---- | :---: | ------------|
 | `cy` | _Number_ |  |
 | `cx` | _Number_ |  |
 | `name` | _String_ | The name of this Scene Item. |
+| `id` | _int_ | Scene item ID |
 | `render` | _Boolean_ | Whether or not this Scene Item is set to "visible". |
+| `locked` | _Boolean_ | Whether or not this Scene Item is locked and can't be moved around |
 | `source_cx` | _Number_ |  |
 | `source_cy` | _Number_ |  |
 | `type` | _String_ | Source type. Value is one of the following: "input", "filter", "transition", "scene" or "unknown" |
 | `volume` | _Number_ |  |
 | `x` | _Number_ |  |
 | `y` | _Number_ |  |
+## Scene
+| Name | Type  | Description |
+| ---- | :---: | ------------|
+| `name` | _String_ | Name of the currently active scene. |
+| `sources` | _Array<Source>_ | Ordered list of the current scene's source items. |
 
 
 
@@ -884,6 +886,7 @@ An item has been added to the current scene.
 | ---- | :---: | ------------|
 | `scene-name` | _String_ | Name of the scene. |
 | `item-name` | _String_ | Name of the item added to the scene. |
+| `item-id` | _int_ | Scene item ID |
 
 
 ---
@@ -901,6 +904,7 @@ An item has been removed from the current scene.
 | ---- | :---: | ------------|
 | `scene-name` | _String_ | Name of the scene. |
 | `item-name` | _String_ | Name of the item removed from the scene. |
+| `item-id` | _int_ | Scene item ID |
 
 
 ---
@@ -918,6 +922,7 @@ An item's visibility has been toggled.
 | ---- | :---: | ------------|
 | `scene-name` | _String_ | Name of the scene. |
 | `item-name` | _String_ | Name of the item in the scene. |
+| `item-id` | _int_ | Scene item ID |
 | `item-visible` | _boolean_ | New visibility state of the item. |
 
 
@@ -936,6 +941,7 @@ An item's transform has been changed.
 | ---- | :---: | ------------|
 | `scene-name` | _String_ | Name of the scene. |
 | `item-name` | _String_ | Name of the item in the scene. |
+| `item-id` | _int_ | Scene item ID |
 | `transform` | _SceneItemProperties_ | Scene item transform properties |
 
 
@@ -952,9 +958,9 @@ A scene item is selected.
 
 | Name | Type  | Description |
 | ---- | :---: | ------------|
-| `sceneName` | _String_ | Name of the scene. |
+| `scene-name` | _String_ | Name of the scene. |
-| `itemName` | _String_ | Name of the item in the scene. |
+| `item-name` | _String_ | Name of the item in the scene. |
-| `itemId` | _int_ | Name of the item in the scene. |
+| `item-id` | _int_ | Name of the item in the scene. |
 
 
 ---
@@ -970,9 +976,9 @@ A scene item is deselected.
 
 | Name | Type  | Description |
 | ---- | :---: | ------------|
-| `sceneName` | _String_ | Name of the scene. |
+| `scene-name` | _String_ | Name of the scene. |
-| `itemName` | _String_ | Name of the item in the scene. |
+| `item-name` | _String_ | Name of the item in the scene. |
-| `itemId` | _int_ | Name of the item in the scene. |
+| `item-id` | _int_ | Name of the item in the scene. |
 
 
 ---