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

docs(ci): Update protocol.md - aceb437 [skip ci]

Browse Source
This commit is contained in:
Azure CI 2020-11-29 11:40:39 +00:00
parent aceb437c5f
commit a93c4dfbbd
2 changed files with 50 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/generated/comments.json
View File

@ -1415,7 +1415,7 @@
"recording": [
{
"subheads": [],
"description": "A request to start recording has been issued.",
"description": "\n\nNote: `recordingFilename` is not provided in this event because this information\nis not available at the time this event is emitted.",
"api": "events",
"name": "RecordingStarting",
"category": "recording",
@ -1442,17 +1442,25 @@
"level": 2,
"text": "RecordingStarting"
},
"lead": "",
"lead": "A request to start recording has been issued.",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Recording started successfully.",
"return": "{String} `recordingFilename` Absolute path to the file of the current recording.",
"api": "events",
"name": "RecordingStarted",
"category": "recording",
"since": "0.3",
"returns": [
{
"type": "String",
"name": "recordingFilename",
"description": "Absolute path to the file of the current recording."
}
],
"names": [
{
"name": "",
@ -1482,10 +1490,18 @@
{
"subheads": [],
"description": "A request to stop recording has been issued.",
"return": "{String} `recordingFilename` Absolute path to the file of the current recording.",
"api": "events",
"name": "RecordingStopping",
"category": "recording",
"since": "0.3",
"returns": [
{
"type": "String",
"name": "recordingFilename",
"description": "Absolute path to the file of the current recording."
}
],
"names": [
{
"name": "",
@ -1515,10 +1531,18 @@
{
"subheads": [],
"description": "Recording stopped successfully.",
"return": "{String} `recordingFilename` Absolute path to the file of the current recording.",
"api": "events",
"name": "RecordingStopped",
"category": "recording",
"since": "0.3",
"returns": [
{
"type": "String",
"name": "recordingFilename",
"description": "Absolute path to the file of the current recording."
}
],
"names": [
{
"name": "",
@ -7630,7 +7654,8 @@
"return": [
"{boolean} `isRecording` Current recording status.",
"{boolean} `isRecordingPaused` Whether the recording is paused or not.",
"{String (optional)} `recordTimecode` Time elapsed since recording started (only present if currently recording)."
"{String (optional)} `recordTimecode` Time elapsed since recording started (only present if currently recording).",
"{String (optional)} `recordingFilename` Absolute path to the recording file (only present if currently recording)."
],
"api": "requests",
"name": "GetRecordingStatus",
@ -7651,6 +7676,11 @@
"type": "String (optional)",
"name": "recordTimecode",
"description": "Time elapsed since recording started (only present if currently recording)."
},
{
"type": "String (optional)",
"name": "recordingFilename",
"description": "Absolute path to the recording file (only present if currently recording)."
}
],
"names": [

21
docs/generated/protocol.md
View File

@ -683,7 +683,10 @@ Emitted every 2 seconds when stream is active.
- Added in v0.3
A request to start recording has been issued.
Note: `recordingFilename` is not provided in this event because this information
is not available at the time this event is emitted.
**Response Items:**
@ -700,7 +703,10 @@ Recording started successfully.
**Response Items:**
_No additional response items._
| Name | Type | Description |
| ---- | :---: | ------------|
| `recordingFilename` | _String_ | Absolute path to the file of the current recording. |
---
@ -713,7 +719,10 @@ A request to stop recording has been issued.
**Response Items:**
_No additional response items._
| Name | Type | Description |
| ---- | :---: | ------------|
| `recordingFilename` | _String_ | Absolute path to the file of the current recording. |
---
@ -726,7 +735,10 @@ Recording stopped successfully.
**Response Items:**
_No additional response items._
| Name | Type | Description |
| ---- | :---: | ------------|
| `recordingFilename` | _String_ | Absolute path to the file of the current recording. |
---
@ -3004,6 +3016,7 @@ _No specified parameters._
| `isRecording` | _boolean_ | Current recording status. |
| `isRecordingPaused` | _boolean_ | Whether the recording is paused or not. |
| `recordTimecode` | _String (optional)_ | Time elapsed since recording started (only present if currently recording). |
| `recordingFilename` | _String (optional)_ | Absolute path to the recording file (only present if currently recording). |
---