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

RequestBatchExecutionType: Change executionType values

Browse Source 
Fits better for the front-facing API.
This commit is contained in:
tt2468 2021-12-10 22:00:02 -08:00
parent b66d2284b3
commit c9c5da6837
3 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/generated/protocol.json
View File

@ -142,7 +142,7 @@
"rpcVersion": "1", "rpcVersion": "1",
"deprecated": false, "deprecated": false,
"initialVersion": "5.0.0", "initialVersion": "5.0.0",
"enumValue": 0 "enumValue": "-1"
}, },
{ {
"description": "A request batch which processes all requests serially, as fast as possible.\n\nNote: To introduce artificial delay, use the `Sleep` request and the `sleepMillis` request field.", "description": "A request batch which processes all requests serially, as fast as possible.\n\nNote: To introduce artificial delay, use the `Sleep` request and the `sleepMillis` request field.",
@ -150,7 +150,7 @@
"rpcVersion": "1", "rpcVersion": "1",
"deprecated": false, "deprecated": false,
"initialVersion": "5.0.0", "initialVersion": "5.0.0",
"enumValue": 1 "enumValue": 0
}, },
{ {
"description": "A request batch type which processes all requests serially, in sync with the graphics thread. Designed to provide high accuracy for animations.\n\nNote: To introduce artificial delay, use the `Sleep` request and the `sleepFrames` request field.", "description": "A request batch type which processes all requests serially, in sync with the graphics thread. Designed to provide high accuracy for animations.\n\nNote: To introduce artificial delay, use the `Sleep` request and the `sleepFrames` request field.",
@ -158,7 +158,7 @@
"rpcVersion": "1", "rpcVersion": "1",
"deprecated": false, "deprecated": false,
"initialVersion": "5.0.0", "initialVersion": "5.0.0",
"enumValue": 2 "enumValue": 1
}, },
{ {
"description": "A request batch type which processes all requests using all available threads in the thread pool.\n\nNote: This is mainly experimental, and only really shows its colors during requests which require lots of\nactive processing, like `GetSourceScreenshot`.", "description": "A request batch type which processes all requests using all available threads in the thread pool.\n\nNote: This is mainly experimental, and only really shows its colors during requests which require lots of\nactive processing, like `GetSourceScreenshot`.",
@ -166,7 +166,7 @@
"rpcVersion": "1", "rpcVersion": "1",
"deprecated": false, "deprecated": false,
"initialVersion": "5.0.0", "initialVersion": "5.0.0",
"enumValue": 3 "enumValue": 2
} }
] ]
}, },

8
docs/generated/protocol.md
View File

@ -696,7 +696,7 @@ A requested feature is not supported due to hardware/software limitations.
Not a request batch. Not a request batch.
- Identifier Value: `0` - Identifier Value: `-1`
- Latest Supported RPC Version: `1` - Latest Supported RPC Version: `1`
- Added in v5.0.0 - Added in v5.0.0
@ -708,7 +708,7 @@ A request batch which processes all requests serially, as fast as possible.
Note: To introduce artificial delay, use the `Sleep` request and the `sleepMillis` request field. Note: To introduce artificial delay, use the `Sleep` request and the `sleepMillis` request field.
- Identifier Value: `1` - Identifier Value: `0`
- Latest Supported RPC Version: `1` - Latest Supported RPC Version: `1`
- Added in v5.0.0 - Added in v5.0.0
@ -720,7 +720,7 @@ A request batch type which processes all requests serially, in sync with the gra
Note: To introduce artificial delay, use the `Sleep` request and the `sleepFrames` request field. Note: To introduce artificial delay, use the `Sleep` request and the `sleepFrames` request field.
- Identifier Value: `2` - Identifier Value: `1`
- Latest Supported RPC Version: `1` - Latest Supported RPC Version: `1`
- Added in v5.0.0 - Added in v5.0.0
@ -733,7 +733,7 @@ A request batch type which processes all requests using all available threads in
Note: This is mainly experimental, and only really shows its colors during requests which require lots of Note: This is mainly experimental, and only really shows its colors during requests which require lots of
active processing, like `GetSourceScreenshot`. active processing, like `GetSourceScreenshot`.
- Identifier Value: `3` - Identifier Value: `2`
- Latest Supported RPC Version: `1` - Latest Supported RPC Version: `1`
- Added in v5.0.0 - Added in v5.0.0
## RequestStatus ## RequestStatus

16
src/requesthandler/types/RequestBatchExecutionType.h
View File

@ -27,26 +27,26 @@ namespace RequestBatchExecutionType {
* Not a request batch. * Not a request batch.
* *
* @enumIdentifier None * @enumIdentifier None
* @enumValue 0 * @enumValue -1
* @enumType RequestBatchExecutionType * @enumType RequestBatchExecutionType
* @rpcVersion -1 * @rpcVersion -1
* @initialVersion 5.0.0 * @initialVersion 5.0.0
* @api enums * @api enums
*/ */
None = 0, None = -1,
/** /**
* A request batch which processes all requests serially, as fast as possible. * A request batch which processes all requests serially, as fast as possible.
* *
* Note: To introduce artificial delay, use the `Sleep` request and the `sleepMillis` request field. * Note: To introduce artificial delay, use the `Sleep` request and the `sleepMillis` request field.
* *
* @enumIdentifier SerialRealtime * @enumIdentifier SerialRealtime
* @enumValue 1 * @enumValue 0
* @enumType RequestBatchExecutionType * @enumType RequestBatchExecutionType
* @rpcVersion -1 * @rpcVersion -1
* @initialVersion 5.0.0 * @initialVersion 5.0.0
* @api enums * @api enums
*/ */
SerialRealtime = 1, SerialRealtime = 0,
/** /**
* A request batch type which processes all requests serially, in sync with the graphics thread. Designed to * A request batch type which processes all requests serially, in sync with the graphics thread. Designed to
* provide high accuracy for animations. * provide high accuracy for animations.
@ -54,13 +54,13 @@ namespace RequestBatchExecutionType {
* Note: To introduce artificial delay, use the `Sleep` request and the `sleepFrames` request field. * Note: To introduce artificial delay, use the `Sleep` request and the `sleepFrames` request field.
* *
* @enumIdentifier SerialFrame * @enumIdentifier SerialFrame
* @enumValue 2 * @enumValue 1
* @enumType RequestBatchExecutionType * @enumType RequestBatchExecutionType
* @rpcVersion -1 * @rpcVersion -1
* @initialVersion 5.0.0 * @initialVersion 5.0.0
* @api enums * @api enums
*/ */
SerialFrame = 2, SerialFrame = 1,
/** /**
* A request batch type which processes all requests using all available threads in the thread pool. * A request batch type which processes all requests using all available threads in the thread pool.
* *
@ -68,13 +68,13 @@ namespace RequestBatchExecutionType {
* active processing, like `GetSourceScreenshot`. * active processing, like `GetSourceScreenshot`.
* *
* @enumIdentifier Parallel * @enumIdentifier Parallel
* @enumValue 3 * @enumValue 2
* @enumType RequestBatchExecutionType * @enumType RequestBatchExecutionType
* @rpcVersion -1 * @rpcVersion -1
* @initialVersion 5.0.0 * @initialVersion 5.0.0
* @api enums * @api enums
*/ */
Parallel = 3, Parallel = 2,
}; };
inline bool IsValid(uint8_t executionType) inline bool IsValid(uint8_t executionType)