Skip to content

Commit 086bf06

Browse files
author
Github Actions
committed
docs(ci): Update generated docs - 6483dca [skip ci]
1 parent 6483dca commit 086bf06

File tree

2 files changed

+95
-0
lines changed

2 files changed

+95
-0
lines changed

docs/generated/protocol.json

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3472,6 +3472,37 @@
34723472
"requestFields": [],
34733473
"responseFields": []
34743474
},
3475+
{
3476+
"description": "Splits the current file being recorded into a new file.",
3477+
"requestType": "SplitRecordFile",
3478+
"complexity": 2,
3479+
"rpcVersion": "1",
3480+
"deprecated": false,
3481+
"initialVersion": "5.5.0",
3482+
"category": "record",
3483+
"requestFields": [],
3484+
"responseFields": []
3485+
},
3486+
{
3487+
"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.",
3488+
"requestType": "CreateRecordChapter",
3489+
"complexity": 2,
3490+
"rpcVersion": "1",
3491+
"deprecated": false,
3492+
"initialVersion": "5.5.0",
3493+
"category": "record",
3494+
"requestFields": [
3495+
{
3496+
"valueName": "chapterName",
3497+
"valueType": "String",
3498+
"valueDescription": "Name of the new chapter",
3499+
"valueRestrictions": null,
3500+
"valueOptional": true,
3501+
"valueOptionalBehavior": "Unknown"
3502+
}
3503+
],
3504+
"responseFields": []
3505+
},
34753506
{
34763507
"description": "Gets a list of all scene items in a scene.\n\nScenes only",
34773508
"requestType": "GetSceneItemList",
@@ -6046,6 +6077,23 @@
60466077
}
60476078
]
60486079
},
6080+
{
6081+
"description": "The record output has started writing to a new file. For example, when a file split happens.",
6082+
"eventType": "RecordFileChanged",
6083+
"eventSubscription": "Outputs",
6084+
"complexity": 2,
6085+
"rpcVersion": "1",
6086+
"deprecated": false,
6087+
"initialVersion": "5.5.0",
6088+
"category": "outputs",
6089+
"dataFields": [
6090+
{
6091+
"valueName": "newOutputPath",
6092+
"valueType": "String",
6093+
"valueDescription": "File name that the output has begun writing to"
6094+
}
6095+
]
6096+
},
60496097
{
60506098
"description": "The state of the replay buffer output has changed.",
60516099
"eventType": "ReplayBufferStateChanged",

docs/generated/protocol.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1548,6 +1548,7 @@ The output has been resumed (unpaused).
15481548
- [Outputs Events](#outputs-events)
15491549
- [StreamStateChanged](#streamstatechanged)
15501550
- [RecordStateChanged](#recordstatechanged)
1551+
- [RecordFileChanged](#recordfilechanged)
15511552
- [ReplayBufferStateChanged](#replaybufferstatechanged)
15521553
- [VirtualcamStateChanged](#virtualcamstatechanged)
15531554
- [ReplayBufferSaved](#replaybuffersaved)
@@ -2433,6 +2434,22 @@ The state of the record output has changed.
24332434

24342435
---
24352436

2437+
### RecordFileChanged
2438+
2439+
The record output has started writing to a new file. For example, when a file split happens.
2440+
2441+
- Complexity Rating: `2/5`
2442+
- Latest Supported RPC Version: `1`
2443+
- Added in v5.5.0
2444+
2445+
**Data Fields:**
2446+
2447+
| Name | Type | Description |
2448+
| ---- | :---: | ----------- |
2449+
| newOutputPath | String | File name that the output has begun writing to |
2450+
2451+
---
2452+
24362453
### ReplayBufferStateChanged
24372454

24382455
The state of the replay buffer output has changed.
@@ -2712,6 +2729,8 @@ communication is desired.
27122729
- [ToggleRecordPause](#togglerecordpause)
27132730
- [PauseRecord](#pauserecord)
27142731
- [ResumeRecord](#resumerecord)
2732+
- [SplitRecordFile](#splitrecordfile)
2733+
- [CreateRecordChapter](#createrecordchapter)
27152734
- [Media Inputs Requests](#media-inputs-1-requests)
27162735
- [GetMediaInputStatus](#getmediainputstatus)
27172736
- [SetMediaInputCursor](#setmediainputcursor)
@@ -5265,6 +5284,34 @@ Resumes the record output.
52655284
- Latest Supported RPC Version: `1`
52665285
- Added in v5.0.0
52675286

5287+
---
5288+
5289+
### SplitRecordFile
5290+
5291+
Splits the current file being recorded into a new file.
5292+
5293+
- Complexity Rating: `2/5`
5294+
- Latest Supported RPC Version: `1`
5295+
- Added in v5.5.0
5296+
5297+
---
5298+
5299+
### CreateRecordChapter
5300+
5301+
Adds a new chapter marker to the file currently being recorded.
5302+
5303+
Note: As of OBS 30.2.0, the only file format supporting this feature is Hybrid MP4.
5304+
5305+
- Complexity Rating: `2/5`
5306+
- Latest Supported RPC Version: `1`
5307+
- Added in v5.5.0
5308+
5309+
**Request Fields:**
5310+
5311+
| Name | Type | Description | Value Restrictions | ?Default Behavior |
5312+
| ---- | :---: | ----------- | :----------------: | ----------------- |
5313+
| ?chapterName | String | Name of the new chapter | None | Unknown |
5314+
52685315
## Media Inputs Requests
52695316

52705317
### GetMediaInputStatus

0 commit comments

Comments
 (0)