docs(travis): Update protocol.md - 98656b5 [skip ci]

This commit is contained in:
Travis CI 2018-12-30 17:41:58 +00:00
parent 98656b5d2f
commit db2b1e2dc7
2 changed files with 85 additions and 0 deletions

View File

@ -3101,6 +3101,67 @@
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Changes the order of scene items in the requested scene.",
"param": [
"{String (optional)} `scene` Name of the scene to reorder (defaults to current).",
"{Scene|Array} `items` Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene",
"{int (optional)} `items[].id` Id of a specific scene item. Unique on a scene by scene basis.",
"{String (optional)} `items[].name` Name of a scene item. Sufficiently unique if no scene items share sources within the scene."
],
"api": "requests",
"name": "ReorderSceneItems",
"category": "scenes",
"since": "4.5.0",
"params": [
{
"type": "String (optional)",
"name": "scene",
"description": "Name of the scene to reorder (defaults to current)."
},
{
"type": "Scene|Array",
"name": "items",
"description": "Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene"
},
{
"type": "int (optional)",
"name": "items[].id",
"description": "Id of a specific scene item. Unique on a scene by scene basis."
},
{
"type": "String (optional)",
"name": "items[].name",
"description": "Name of a scene item. Sufficiently unique if no scene items share sources within the scene."
}
],
"names": [
{
"name": "",
"description": "ReorderSceneItems"
}
],
"categories": [
{
"name": "",
"description": "scenes"
}
],
"sinces": [
{
"name": "",
"description": "4.5.0"
}
],
"heading": {
"level": 2,
"text": "ReorderSceneItems"
},
"lead": "",
"type": "class",
"examples": []
}
],
"sources": [

View File

@ -128,6 +128,7 @@ auth_response = base64_encode(auth_response_hash)
+ [SetCurrentScene](#setcurrentscene)
+ [GetCurrentScene](#getcurrentscene)
+ [GetSceneList](#getscenelist)
+ [ReorderSceneItems](#reordersceneitems)
* [Sources](#sources-1)
+ [GetSourcesList](#getsourceslist)
+ [GetSourcesTypesList](#getsourcestypeslist)
@ -1462,6 +1463,29 @@ _No specified parameters._
| `scenes` | _Array<Scene>_ | Ordered list of the current profile's scenes (See `[GetCurrentScene](#getcurrentscene)` for more information). |
---
### ReorderSceneItems
- Added in v4.5.0
Changes the order of scene items in the requested scene.
**Request Fields:**
| Name | Type | Description |
| ---- | :---: | ------------|
| `scene` | _String (optional)_ | Name of the scene to reorder (defaults to current). |
| `items` | _Scene\|Array_ | Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene |
| `items[].id` | _int (optional)_ | Id of a specific scene item. Unique on a scene by scene basis. |
| `items[].name` | _String (optional)_ | Name of a scene item. Sufficiently unique if no scene items share sources within the scene. |
**Response Items:**
_No additional response items._
---
## Sources