mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
docs(ci): Update generated docs - 6483dca
[skip ci]
This commit is contained in:
parent
6483dcaef0
commit
086bf06008
@ -3472,6 +3472,37 @@
|
|||||||
"requestFields": [],
|
"requestFields": [],
|
||||||
"responseFields": []
|
"responseFields": []
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"description": "Splits the current file being recorded into a new file.",
|
||||||
|
"requestType": "SplitRecordFile",
|
||||||
|
"complexity": 2,
|
||||||
|
"rpcVersion": "1",
|
||||||
|
"deprecated": false,
|
||||||
|
"initialVersion": "5.5.0",
|
||||||
|
"category": "record",
|
||||||
|
"requestFields": [],
|
||||||
|
"responseFields": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"description": "Adds a new chapter marker to the file currently being recorded.\n\nNote: As of OBS 30.2.0, the only file format supporting this feature is Hybrid MP4.",
|
||||||
|
"requestType": "CreateRecordChapter",
|
||||||
|
"complexity": 2,
|
||||||
|
"rpcVersion": "1",
|
||||||
|
"deprecated": false,
|
||||||
|
"initialVersion": "5.5.0",
|
||||||
|
"category": "record",
|
||||||
|
"requestFields": [
|
||||||
|
{
|
||||||
|
"valueName": "chapterName",
|
||||||
|
"valueType": "String",
|
||||||
|
"valueDescription": "Name of the new chapter",
|
||||||
|
"valueRestrictions": null,
|
||||||
|
"valueOptional": true,
|
||||||
|
"valueOptionalBehavior": "Unknown"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responseFields": []
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"description": "Gets a list of all scene items in a scene.\n\nScenes only",
|
"description": "Gets a list of all scene items in a scene.\n\nScenes only",
|
||||||
"requestType": "GetSceneItemList",
|
"requestType": "GetSceneItemList",
|
||||||
@ -6046,6 +6077,23 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"description": "The record output has started writing to a new file. For example, when a file split happens.",
|
||||||
|
"eventType": "RecordFileChanged",
|
||||||
|
"eventSubscription": "Outputs",
|
||||||
|
"complexity": 2,
|
||||||
|
"rpcVersion": "1",
|
||||||
|
"deprecated": false,
|
||||||
|
"initialVersion": "5.5.0",
|
||||||
|
"category": "outputs",
|
||||||
|
"dataFields": [
|
||||||
|
{
|
||||||
|
"valueName": "newOutputPath",
|
||||||
|
"valueType": "String",
|
||||||
|
"valueDescription": "File name that the output has begun writing to"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"description": "The state of the replay buffer output has changed.",
|
"description": "The state of the replay buffer output has changed.",
|
||||||
"eventType": "ReplayBufferStateChanged",
|
"eventType": "ReplayBufferStateChanged",
|
||||||
|
@ -1548,6 +1548,7 @@ The output has been resumed (unpaused).
|
|||||||
- [Outputs Events](#outputs-events)
|
- [Outputs Events](#outputs-events)
|
||||||
- [StreamStateChanged](#streamstatechanged)
|
- [StreamStateChanged](#streamstatechanged)
|
||||||
- [RecordStateChanged](#recordstatechanged)
|
- [RecordStateChanged](#recordstatechanged)
|
||||||
|
- [RecordFileChanged](#recordfilechanged)
|
||||||
- [ReplayBufferStateChanged](#replaybufferstatechanged)
|
- [ReplayBufferStateChanged](#replaybufferstatechanged)
|
||||||
- [VirtualcamStateChanged](#virtualcamstatechanged)
|
- [VirtualcamStateChanged](#virtualcamstatechanged)
|
||||||
- [ReplayBufferSaved](#replaybuffersaved)
|
- [ReplayBufferSaved](#replaybuffersaved)
|
||||||
@ -2433,6 +2434,22 @@ The state of the record output has changed.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
### RecordFileChanged
|
||||||
|
|
||||||
|
The record output has started writing to a new file. For example, when a file split happens.
|
||||||
|
|
||||||
|
- Complexity Rating: `2/5`
|
||||||
|
- Latest Supported RPC Version: `1`
|
||||||
|
- Added in v5.5.0
|
||||||
|
|
||||||
|
**Data Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ---- | :---: | ----------- |
|
||||||
|
| newOutputPath | String | File name that the output has begun writing to |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### ReplayBufferStateChanged
|
### ReplayBufferStateChanged
|
||||||
|
|
||||||
The state of the replay buffer output has changed.
|
The state of the replay buffer output has changed.
|
||||||
@ -2712,6 +2729,8 @@ communication is desired.
|
|||||||
- [ToggleRecordPause](#togglerecordpause)
|
- [ToggleRecordPause](#togglerecordpause)
|
||||||
- [PauseRecord](#pauserecord)
|
- [PauseRecord](#pauserecord)
|
||||||
- [ResumeRecord](#resumerecord)
|
- [ResumeRecord](#resumerecord)
|
||||||
|
- [SplitRecordFile](#splitrecordfile)
|
||||||
|
- [CreateRecordChapter](#createrecordchapter)
|
||||||
- [Media Inputs Requests](#media-inputs-1-requests)
|
- [Media Inputs Requests](#media-inputs-1-requests)
|
||||||
- [GetMediaInputStatus](#getmediainputstatus)
|
- [GetMediaInputStatus](#getmediainputstatus)
|
||||||
- [SetMediaInputCursor](#setmediainputcursor)
|
- [SetMediaInputCursor](#setmediainputcursor)
|
||||||
@ -5265,6 +5284,34 @@ Resumes the record output.
|
|||||||
- Latest Supported RPC Version: `1`
|
- Latest Supported RPC Version: `1`
|
||||||
- Added in v5.0.0
|
- Added in v5.0.0
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### SplitRecordFile
|
||||||
|
|
||||||
|
Splits the current file being recorded into a new file.
|
||||||
|
|
||||||
|
- Complexity Rating: `2/5`
|
||||||
|
- Latest Supported RPC Version: `1`
|
||||||
|
- Added in v5.5.0
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### CreateRecordChapter
|
||||||
|
|
||||||
|
Adds a new chapter marker to the file currently being recorded.
|
||||||
|
|
||||||
|
Note: As of OBS 30.2.0, the only file format supporting this feature is Hybrid MP4.
|
||||||
|
|
||||||
|
- Complexity Rating: `2/5`
|
||||||
|
- Latest Supported RPC Version: `1`
|
||||||
|
- Added in v5.5.0
|
||||||
|
|
||||||
|
**Request Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description | Value Restrictions | ?Default Behavior |
|
||||||
|
| ---- | :---: | ----------- | :----------------: | ----------------- |
|
||||||
|
| ?chapterName | String | Name of the new chapter | None | Unknown |
|
||||||
|
|
||||||
## Media Inputs Requests
|
## Media Inputs Requests
|
||||||
|
|
||||||
### GetMediaInputStatus
|
### GetMediaInputStatus
|
||||||
|
Loading…
Reference in New Issue
Block a user