Mirrored_Repos/obs-websocket
1
0
Fork 0
mirror of https://github.com/Palakis/obs-websocket.git synced 2024-08-30 18:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'origin/master'

Browse Source
This commit is contained in:
Palakis 2017-10-27 14:19:33 +02:00
commit 047e6e11bf
2 changed files with 365 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

288
docs/generated/comments.json
View File

@ -2306,6 +2306,294 @@
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Gets the scene specific properties of the specified source item.",
"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."
],
"return": [
"{String} `name` The name of the source.",
"{int} `position.x` The x position of the source from the left.",
"{int} `position.y` The y position of the source from the top.",
"{int} `position.alignment` The point on the source that the item is manipulated from.",
"{double} `rotation` The clockwise rotation of the item in degrees around the point of alignment.",
"{double} `scale.x` The x-scale factor of the source.",
"{double} `scale.y` The y-scale factor of the source.",
"{int} `crop.top` The number of pixels cropped off the top of the source before scaling.",
"{int} `crop.right` The number of pixels cropped off the right of the source before scaling.",
"{int} `crop.bottom` The number of pixels cropped off the bottom of the source before scaling.",
"{int} `crop.left` The number of pixels cropped off the left of the source before scaling.",
"{bool} `visible` If the source is visible.",
"{String} `bounds.type` Type of bounding box.",
"{int} `bounds.alignment` Alignment of the bounding box.",
"{double} `bounds.x` Width of the bounding box.",
"{double} `bounds.y` Height of the bounding box."
],
"api": "requests",
"name": "GetSceneItemSceneProperties",
"category": "sources",
"since": "unreleased",
"returns": [
{
"type": "String",
"name": "name",
"description": "The name of the source."
},
{
"type": "int",
"name": "position.x",
"description": "The x position of the source from the left."
},
{
"type": "int",
"name": "position.y",
"description": "The y position of the source from the top."
},
{
"type": "int",
"name": "position.alignment",
"description": "The point on the source that the item is manipulated from."
},
{
"type": "double",
"name": "rotation",
"description": "The clockwise rotation of the item in degrees around the point of alignment."
},
{
"type": "double",
"name": "scale.x",
"description": "The x-scale factor of the source."
},
{
"type": "double",
"name": "scale.y",
"description": "The y-scale factor of the source."
},
{
"type": "int",
"name": "crop.top",
"description": "The number of pixels cropped off the top of the source before scaling."
},
{
"type": "int",
"name": "crop.right",
"description": "The number of pixels cropped off the right of the source before scaling."
},
{
"type": "int",
"name": "crop.bottom",
"description": "The number of pixels cropped off the bottom of the source before scaling."
},
{
"type": "int",
"name": "crop.left",
"description": "The number of pixels cropped off the left of the source before scaling."
},
{
"type": "bool",
"name": "visible",
"description": "If the source is visible."
},
{
"type": "String",
"name": "bounds.type",
"description": "Type of bounding box."
},
{
"type": "int",
"name": "bounds.alignment",
"description": "Alignment of the bounding box."
},
{
"type": "double",
"name": "bounds.x",
"description": "Width of the bounding box."
},
{
"type": "double",
"name": "bounds.y",
"description": "Height of the bounding box."
}
],
"params": [
{
"type": "String (optional)",
"name": "scene-name",
"description": "the name of the scene that the source item belongs to. Defaults to the current scene."
},
{
"type": "String",
"name": "item",
"description": "The name of the source."
}
],
"names": [
{
"name": "",
"description": "GetSceneItemSceneProperties"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "unreleased"
}
],
"heading": {
"level": 2,
"text": "GetSceneItemSceneProperties"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Sets the scene specific properties of a source. Unspecified properties will remain unchanged.",
"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.",
"{String} `bounds.type` The new bounds type of the source.",
"{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."
],
"api": "requests",
"name": "SetSceneItemProperties",
"category": "sources",
"since": "unreleased",
"params": [
{
"type": "String (optional)",
"name": "scene-name",
"description": "the name of the scene that the source item belongs to. Defaults to the current scene."
},
{
"type": "String",
"name": "item",
"description": "The name of the source."
},
{
"type": "int",
"name": "position.x",
"description": "The new x position of the source."
},
{
"type": "int",
"name": "position.y",
"description": "The new y position of the source."
},
{
"type": "int",
"name": "position.alignment",
"description": "The new alignment of the source."
},
{
"type": "double",
"name": "rotation",
"description": "The new clockwise rotation of the item in degrees."
},
{
"type": "double",
"name": "scale.x",
"description": "The new x scale of the item."
},
{
"type": "double",
"name": "scale.y",
"description": "The new y scale of the item."
},
{
"type": "int",
"name": "crop.top",
"description": "The new amount of pixels cropped off the top of the source before scaling."
},
{
"type": "int",
"name": "crop.bottom",
"description": "The new amount of pixels cropped off the bottom of the source before scaling."
},
{
"type": "int",
"name": "crop.left",
"description": "The new amount of pixels cropped off the left of the source before scaling."
},
{
"type": "int",
"name": "crop.right",
"description": "The new amount of pixels cropped off the right of the source before scaling."
},
{
"type": "bool",
"name": "visible",
"description": "The new visibility of the source. 'true' shows source, 'false' hides source."
},
{
"type": "String",
"name": "bounds.type",
"description": "The new bounds type of the source."
},
{
"type": "int",
"name": "bounds.alignment",
"description": "The new alignment of the bounding box. (0-2, 4-6, 8-10)"
},
{
"type": "double",
"name": "bounds.x",
"description": "The new width of the bounding box."
},
{
"type": "double",
"name": "",
"description": "`bounds.y' The new height of the bounding box."
}
],
"names": [
{
"name": "",
"description": "SetSceneItemProperties"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "unreleased"
}
],
"heading": {
"level": 2,
"text": "SetSceneItemProperties"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get the current properties of a Text GDI Plus source.",

77
docs/generated/protocol.md
View File

@ -112,6 +112,8 @@ auth_response = base64_encode(auth_response_hash)
+ [SetSceneItemPosition](#setsceneitemposition)
+ [SetSceneItemTransform](#setsceneitemtransform)
+ [SetSceneItemCrop](#setsceneitemcrop)
+ [GetSceneItemSceneProperties](#getsceneitemsceneproperties)
+ [SetSceneItemProperties](#setsceneitemproperties)
+ [GetTextGDIPlusProperties](#gettextgdiplusproperties)
+ [SetTextGDIPlusProperties](#settextgdiplusproperties)
+ [GetBrowserSourceProperties](#getbrowsersourceproperties)
@ -1086,6 +1088,81 @@ Sets the crop coordinates of the specified source item.
| `right` | _int_ | Pixel position of the right of the source item. |
**Response Items:**
_No additional response items._
---
### GetSceneItemSceneProperties
- Unreleased
Gets the scene specific properties of the specified source item.
**Request Fields:**
| Name | Type | Description |
| ---- | :---: | ------------|
| `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. |
**Response Items:**
| Name | Type | Description |
| ---- | :---: | ------------|
| `name` | _String_ | The name of the source. |
| `position.x` | _int_ | The x position of the source from the left. |
| `position.y` | _int_ | The y position of the source from the top. |
| `position.alignment` | _int_ | The point on the source that the item is manipulated from. |
| `rotation` | _double_ | The clockwise rotation of the item in degrees around the point of alignment. |
| `scale.x` | _double_ | The x-scale factor of the source. |
| `scale.y` | _double_ | The y-scale factor of the source. |
| `crop.top` | _int_ | The number of pixels cropped off the top of the source before scaling. |
| `crop.right` | _int_ | The number of pixels cropped off the right of the source before scaling. |
| `crop.bottom` | _int_ | The number of pixels cropped off the bottom of the source before scaling. |
| `crop.left` | _int_ | The number of pixels cropped off the left of the source before scaling. |
| `visible` | _bool_ | If the source is visible. |
| `bounds.type` | _String_ | Type of bounding box. |
| `bounds.alignment` | _int_ | Alignment of the bounding box. |
| `bounds.x` | _double_ | Width of the bounding box. |
| `bounds.y` | _double_ | Height of the bounding box. |
---
### SetSceneItemProperties
- Unreleased
Sets the scene specific properties of a source. Unspecified properties will remain unchanged.
**Request Fields:**
| Name | Type | Description |
| ---- | :---: | ------------|
| `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. |
| `bounds.type` | _String_ | The new bounds type of the source. |
| `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. |
| `` | _double_ | `bounds.y' The new height of the bounding box. |
**Response Items:**
_No additional response items._