From 99fad5bc83706eab4328e6dfed73ad91624f7531 Mon Sep 17 00:00:00 2001 From: Travis CI <> Date: Thu, 9 May 2019 13:54:08 +0000 Subject: [PATCH] docs(travis): Update protocol.md - a54171e [skip ci] --- docs/generated/comments.json | 64 ++++++++++++++++++------------------ docs/generated/protocol.md | 32 +++++++++--------- 2 files changed, 48 insertions(+), 48 deletions(-) diff --git a/docs/generated/comments.json b/docs/generated/comments.json index cda71eec..ea1702fa 100644 --- a/docs/generated/comments.json +++ b/docs/generated/comments.json @@ -3579,22 +3579,22 @@ "param": [ "{String (optional)} `scene-name` the name of the scene that the source item belongs to. Defaults to the current scene.", "{String} `item` The name of the source.", - "{int} `position.x` The new x position of the source.", - "{int} `position.y` The new y position of the source.", - "{int} `position.alignment` The new alignment of the source.", - "{double} `rotation` The new clockwise rotation of the item in degrees.", - "{double} `scale.x` The new x scale of the item.", - "{double} `scale.y` The new y scale of the item.", - "{int} `crop.top` The new amount of pixels cropped off the top of the source before scaling.", - "{int} `crop.bottom` The new amount of pixels cropped off the bottom of the source before scaling.", - "{int} `crop.left` The new amount of pixels cropped off the left of the source before scaling.", - "{int} `crop.right` The new amount of pixels cropped off the right of the source before scaling.", - "{bool} `visible` The new visibility of the source. 'true' shows source, 'false' hides source.", - "{bool} `locked` The new locked status of the source. 'true' keeps it in its current position, 'false' allows movement.", - "{String} `bounds.type` The new bounds type of the source. Can be \"OBS_BOUNDS_STRETCH\", \"OBS_BOUNDS_SCALE_INNER\", \"OBS_BOUNDS_SCALE_OUTER\", \"OBS_BOUNDS_SCALE_TO_WIDTH\", \"OBS_BOUNDS_SCALE_TO_HEIGHT\", \"OBS_BOUNDS_MAX_ONLY\" or \"OBS_BOUNDS_NONE\".", - "{int} `bounds.alignment` The new alignment of the bounding box. (0-2, 4-6, 8-10)", - "{double} `bounds.x` The new width of the bounding box.", - "{double} `bounds.y` The new height of the bounding box." + "{int (optional)} `position.x` The new x position of the source.", + "{int (optional)} `position.y` The new y position of the source.", + "{int (optional)} `position.alignment` The new alignment of the source.", + "{double (optional)} `rotation` The new clockwise rotation of the item in degrees.", + "{double (optional)} `scale.x` The new x scale of the item.", + "{double (optional)} `scale.y` The new y scale of the item.", + "{int (optional)} `crop.top` The new amount of pixels cropped off the top of the source before scaling.", + "{int (optional)} `crop.bottom` The new amount of pixels cropped off the bottom of the source before scaling.", + "{int (optional)} `crop.left` The new amount of pixels cropped off the left of the source before scaling.", + "{int (optional)} `crop.right` The new amount of pixels cropped off the right of the source before scaling.", + "{bool (optional)} `visible` The new visibility of the source. 'true' shows source, 'false' hides source.", + "{bool (optional)} `locked` The new locked status of the source. 'true' keeps it in its current position, 'false' allows movement.", + "{String (optional)} `bounds.type` The new bounds type of the source. Can be \"OBS_BOUNDS_STRETCH\", \"OBS_BOUNDS_SCALE_INNER\", \"OBS_BOUNDS_SCALE_OUTER\", \"OBS_BOUNDS_SCALE_TO_WIDTH\", \"OBS_BOUNDS_SCALE_TO_HEIGHT\", \"OBS_BOUNDS_MAX_ONLY\" or \"OBS_BOUNDS_NONE\".", + "{int (optional)} `bounds.alignment` The new alignment of the bounding box. (0-2, 4-6, 8-10)", + "{double (optional)} `bounds.x` The new width of the bounding box.", + "{double (optional)} `bounds.y` The new height of the bounding box." ], "api": "requests", "name": "SetSceneItemProperties", @@ -3612,82 +3612,82 @@ "description": "The name of the source." }, { - "type": "int", + "type": "int (optional)", "name": "position.x", "description": "The new x position of the source." }, { - "type": "int", + "type": "int (optional)", "name": "position.y", "description": "The new y position of the source." }, { - "type": "int", + "type": "int (optional)", "name": "position.alignment", "description": "The new alignment of the source." }, { - "type": "double", + "type": "double (optional)", "name": "rotation", "description": "The new clockwise rotation of the item in degrees." }, { - "type": "double", + "type": "double (optional)", "name": "scale.x", "description": "The new x scale of the item." }, { - "type": "double", + "type": "double (optional)", "name": "scale.y", "description": "The new y scale of the item." }, { - "type": "int", + "type": "int (optional)", "name": "crop.top", "description": "The new amount of pixels cropped off the top of the source before scaling." }, { - "type": "int", + "type": "int (optional)", "name": "crop.bottom", "description": "The new amount of pixels cropped off the bottom of the source before scaling." }, { - "type": "int", + "type": "int (optional)", "name": "crop.left", "description": "The new amount of pixels cropped off the left of the source before scaling." }, { - "type": "int", + "type": "int (optional)", "name": "crop.right", "description": "The new amount of pixels cropped off the right of the source before scaling." }, { - "type": "bool", + "type": "bool (optional)", "name": "visible", "description": "The new visibility of the source. 'true' shows source, 'false' hides source." }, { - "type": "bool", + "type": "bool (optional)", "name": "locked", "description": "The new locked status of the source. 'true' keeps it in its current position, 'false' allows movement." }, { - "type": "String", + "type": "String (optional)", "name": "bounds.type", "description": "The new bounds type of the source. Can be \"OBS_BOUNDS_STRETCH\", \"OBS_BOUNDS_SCALE_INNER\", \"OBS_BOUNDS_SCALE_OUTER\", \"OBS_BOUNDS_SCALE_TO_WIDTH\", \"OBS_BOUNDS_SCALE_TO_HEIGHT\", \"OBS_BOUNDS_MAX_ONLY\" or \"OBS_BOUNDS_NONE\"." }, { - "type": "int", + "type": "int (optional)", "name": "bounds.alignment", "description": "The new alignment of the bounding box. (0-2, 4-6, 8-10)" }, { - "type": "double", + "type": "double (optional)", "name": "bounds.x", "description": "The new width of the bounding box." }, { - "type": "double", + "type": "double (optional)", "name": "bounds.y", "description": "The new height of the bounding box." } diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index 24484f53..9ced7940 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -1542,22 +1542,22 @@ Sets the scene specific properties of a source. Unspecified properties will rema | ---- | :---: | ------------| | `scene-name` | _String (optional)_ | the name of the scene that the source item belongs to. Defaults to the current scene. | | `item` | _String_ | The name of the source. | -| `position.x` | _int_ | The new x position of the source. | -| `position.y` | _int_ | The new y position of the source. | -| `position.alignment` | _int_ | The new alignment of the source. | -| `rotation` | _double_ | The new clockwise rotation of the item in degrees. | -| `scale.x` | _double_ | The new x scale of the item. | -| `scale.y` | _double_ | The new y scale of the item. | -| `crop.top` | _int_ | The new amount of pixels cropped off the top of the source before scaling. | -| `crop.bottom` | _int_ | The new amount of pixels cropped off the bottom of the source before scaling. | -| `crop.left` | _int_ | The new amount of pixels cropped off the left of the source before scaling. | -| `crop.right` | _int_ | The new amount of pixels cropped off the right of the source before scaling. | -| `visible` | _bool_ | The new visibility of the source. 'true' shows source, 'false' hides source. | -| `locked` | _bool_ | The new locked status of the source. 'true' keeps it in its current position, 'false' allows movement. | -| `bounds.type` | _String_ | The new bounds type of the source. Can be "OBS_BOUNDS_STRETCH", "OBS_BOUNDS_SCALE_INNER", "OBS_BOUNDS_SCALE_OUTER", "OBS_BOUNDS_SCALE_TO_WIDTH", "OBS_BOUNDS_SCALE_TO_HEIGHT", "OBS_BOUNDS_MAX_ONLY" or "OBS_BOUNDS_NONE". | -| `bounds.alignment` | _int_ | The new alignment of the bounding box. (0-2, 4-6, 8-10) | -| `bounds.x` | _double_ | The new width of the bounding box. | -| `bounds.y` | _double_ | The new height of the bounding box. | +| `position.x` | _int (optional)_ | The new x position of the source. | +| `position.y` | _int (optional)_ | The new y position of the source. | +| `position.alignment` | _int (optional)_ | The new alignment of the source. | +| `rotation` | _double (optional)_ | The new clockwise rotation of the item in degrees. | +| `scale.x` | _double (optional)_ | The new x scale of the item. | +| `scale.y` | _double (optional)_ | The new y scale of the item. | +| `crop.top` | _int (optional)_ | The new amount of pixels cropped off the top of the source before scaling. | +| `crop.bottom` | _int (optional)_ | The new amount of pixels cropped off the bottom of the source before scaling. | +| `crop.left` | _int (optional)_ | The new amount of pixels cropped off the left of the source before scaling. | +| `crop.right` | _int (optional)_ | The new amount of pixels cropped off the right of the source before scaling. | +| `visible` | _bool (optional)_ | The new visibility of the source. 'true' shows source, 'false' hides source. | +| `locked` | _bool (optional)_ | The new locked status of the source. 'true' keeps it in its current position, 'false' allows movement. | +| `bounds.type` | _String (optional)_ | The new bounds type of the source. Can be "OBS_BOUNDS_STRETCH", "OBS_BOUNDS_SCALE_INNER", "OBS_BOUNDS_SCALE_OUTER", "OBS_BOUNDS_SCALE_TO_WIDTH", "OBS_BOUNDS_SCALE_TO_HEIGHT", "OBS_BOUNDS_MAX_ONLY" or "OBS_BOUNDS_NONE". | +| `bounds.alignment` | _int (optional)_ | The new alignment of the bounding box. (0-2, 4-6, 8-10) | +| `bounds.x` | _double (optional)_ | The new width of the bounding box. | +| `bounds.y` | _double (optional)_ | The new height of the bounding box. | **Response Items:**