mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
docs(ci): Update protocol.md - f14379a [skip ci]
This commit is contained in:
parent
f14379af68
commit
f7616ade1f
@ -10488,7 +10488,7 @@
|
|||||||
"api": "requests",
|
"api": "requests",
|
||||||
"name": "GetTransitionPosition",
|
"name": "GetTransitionPosition",
|
||||||
"category": "transitions",
|
"category": "transitions",
|
||||||
"since": "4.8.0",
|
"since": "unreleased",
|
||||||
"returns": [
|
"returns": [
|
||||||
{
|
{
|
||||||
"type": "double",
|
"type": "double",
|
||||||
@ -10511,7 +10511,7 @@
|
|||||||
"sinces": [
|
"sinces": [
|
||||||
{
|
{
|
||||||
"name": "",
|
"name": "",
|
||||||
"description": "4.8.0"
|
"description": "unreleased"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"heading": {
|
"heading": {
|
||||||
@ -10627,6 +10627,88 @@
|
|||||||
"lead": "",
|
"lead": "",
|
||||||
"type": "class",
|
"type": "class",
|
||||||
"examples": []
|
"examples": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"subheads": [],
|
||||||
|
"description": "Release the T-Bar (like a user releasing their mouse button after moving it).\n*YOU MUST CALL THIS if you called `SetTBarPosition` with the `release` parameter set to `false`.*",
|
||||||
|
"api": "requests",
|
||||||
|
"name": "ReleaseTBar",
|
||||||
|
"category": "transitions",
|
||||||
|
"since": "unreleased",
|
||||||
|
"names": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "ReleaseTBar"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"categories": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "transitions"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"sinces": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "unreleased"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"heading": {
|
||||||
|
"level": 2,
|
||||||
|
"text": "ReleaseTBar"
|
||||||
|
},
|
||||||
|
"lead": "",
|
||||||
|
"type": "class",
|
||||||
|
"examples": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"subheads": [],
|
||||||
|
"description": "\n\nIf your code needs to perform multiple successive T-Bar moves (e.g. : in an animation, or in response to a user moving a T-Bar control in your User Interface), set `release` to false and call `ReleaseTBar` later once the animation/interaction is over.",
|
||||||
|
"param": [
|
||||||
|
"{double} `position` T-Bar position. This value must be between 0.0 and 1.0.",
|
||||||
|
"{boolean (optional)} `release` Whether or not the T-Bar gets released automatically after setting its new position (like a user releasing their mouse button after moving the T-Bar). Call `ReleaseTBar` manually if you set `release` to false. Defaults to true."
|
||||||
|
],
|
||||||
|
"api": "requests",
|
||||||
|
"name": "SetTBarPosition",
|
||||||
|
"category": "transitions",
|
||||||
|
"since": "unreleased",
|
||||||
|
"params": [
|
||||||
|
{
|
||||||
|
"type": "double",
|
||||||
|
"name": "position",
|
||||||
|
"description": "T-Bar position. This value must be between 0.0 and 1.0."
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "boolean (optional)",
|
||||||
|
"name": "release",
|
||||||
|
"description": "Whether or not the T-Bar gets released automatically after setting its new position (like a user releasing their mouse button after moving the T-Bar). Call `ReleaseTBar` manually if you set `release` to false. Defaults to true."
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"names": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "SetTBarPosition"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"categories": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "transitions"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"sinces": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "unreleased"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"heading": {
|
||||||
|
"level": 2,
|
||||||
|
"text": "SetTBarPosition"
|
||||||
|
},
|
||||||
|
"lead": "Set the manual position of the T-Bar (in Studio Mode) to the specified value. Will return an error if OBS is not in studio mode or if the current transition doesn't support T-Bar control.",
|
||||||
|
"type": "class",
|
||||||
|
"examples": []
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
@ -257,6 +257,8 @@ You can also refer to any of the client libraries listed on the [README](README.
|
|||||||
+ [GetTransitionPosition](#gettransitionposition)
|
+ [GetTransitionPosition](#gettransitionposition)
|
||||||
+ [GetTransitionSettings](#gettransitionsettings)
|
+ [GetTransitionSettings](#gettransitionsettings)
|
||||||
+ [SetTransitionSettings](#settransitionsettings)
|
+ [SetTransitionSettings](#settransitionsettings)
|
||||||
|
+ [ReleaseTBar](#releasetbar)
|
||||||
|
+ [SetTBarPosition](#settbarposition)
|
||||||
|
|
||||||
<!-- tocstop -->
|
<!-- tocstop -->
|
||||||
|
|
||||||
@ -4170,7 +4172,7 @@ _No specified parameters._
|
|||||||
### GetTransitionPosition
|
### GetTransitionPosition
|
||||||
|
|
||||||
|
|
||||||
- Added in v4.8.0
|
- Unreleased
|
||||||
|
|
||||||
Get the position of the current transition.
|
Get the position of the current transition.
|
||||||
|
|
||||||
@ -4234,3 +4236,44 @@ Change the current settings of a transition
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
### ReleaseTBar
|
||||||
|
|
||||||
|
|
||||||
|
- Unreleased
|
||||||
|
|
||||||
|
Release the T-Bar (like a user releasing their mouse button after moving it).
|
||||||
|
*YOU MUST CALL THIS if you called `SetTBarPosition` with the `release` parameter set to `false`.*
|
||||||
|
|
||||||
|
**Request Fields:**
|
||||||
|
|
||||||
|
_No specified parameters._
|
||||||
|
|
||||||
|
**Response Items:**
|
||||||
|
|
||||||
|
_No additional response items._
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### SetTBarPosition
|
||||||
|
|
||||||
|
|
||||||
|
- Unreleased
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
If your code needs to perform multiple successive T-Bar moves (e.g. : in an animation, or in response to a user moving a T-Bar control in your User Interface), set `release` to false and call `ReleaseTBar` later once the animation/interaction is over.
|
||||||
|
|
||||||
|
**Request Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ---- | :---: | ------------|
|
||||||
|
| `position` | _double_ | T-Bar position. This value must be between 0.0 and 1.0. |
|
||||||
|
| `release` | _boolean (optional)_ | Whether or not the T-Bar gets released automatically after setting its new position (like a user releasing their mouse button after moving the T-Bar). Call `ReleaseTBar` manually if you set `release` to false. Defaults to true. |
|
||||||
|
|
||||||
|
|
||||||
|
**Response Items:**
|
||||||
|
|
||||||
|
_No additional response items._
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user