diff --git a/docs/generated/comments.json b/docs/generated/comments.json index a2c65054..7c9c9df6 100644 --- a/docs/generated/comments.json +++ b/docs/generated/comments.json @@ -632,6 +632,112 @@ "examples": [] } ], + "replay buffer": [ + { + "subheads": [], + "description": "A request to start the replay buffer has been issued.", + "api": "events", + "name": "ReplayStarting", + "category": "replay buffer", + "names": [ + { + "name": "", + "description": "ReplayStarting" + } + ], + "categories": [ + { + "name": "", + "description": "replay buffer" + } + ], + "heading": { + "level": 2, + "text": "ReplayStarting" + }, + "lead": "", + "type": "class", + "examples": [] + }, + { + "subheads": [], + "description": "Replay Buffer started successfully", + "api": "events", + "name": "ReplayStarted", + "category": "replay buffer", + "names": [ + { + "name": "", + "description": "ReplayStarted" + } + ], + "categories": [ + { + "name": "", + "description": "replay buffer" + } + ], + "heading": { + "level": 2, + "text": "ReplayStarted" + }, + "lead": "", + "type": "class", + "examples": [] + }, + { + "subheads": [], + "description": "A request to start the replay buffer has been issued.", + "api": "events", + "name": "ReplayStopping", + "category": "replay buffer", + "names": [ + { + "name": "", + "description": "ReplayStopping" + } + ], + "categories": [ + { + "name": "", + "description": "replay buffer" + } + ], + "heading": { + "level": 2, + "text": "ReplayStopping" + }, + "lead": "", + "type": "class", + "examples": [] + }, + { + "subheads": [], + "description": "Replay Buffer stopped successfully", + "api": "events", + "name": "ReplayStopped", + "category": "replay buffer", + "names": [ + { + "name": "", + "description": "ReplayStopped" + } + ], + "categories": [ + { + "name": "", + "description": "replay buffer" + } + ], + "heading": { + "level": 2, + "text": "ReplayStopped" + }, + "lead": "", + "type": "class", + "examples": [] + } + ], "other": [ { "subheads": [], @@ -2676,13 +2782,13 @@ { "subheads": [], "description": "Get the path of the current recording folder.", - "return": "{Stsring} `rec-folder` Path of the recording folder.", + "return": "{String} `rec-folder` Path of the recording folder.", "api": "requests", "name": "GetRecordingFolder", "category": "recording", "returns": [ { - "type": "Stsring", + "type": "String", "name": "rec-folder", "description": "Path of the recording folder." } @@ -2708,6 +2814,112 @@ "examples": [] } ], + "replay buffer": [ + { + "subheads": [], + "description": "Toggle the Replay Buffer on/off.", + "api": "requests", + "name": "StartStopReplayBuffer", + "category": "replay buffer", + "names": [ + { + "name": "", + "description": "StartStopReplayBuffer" + } + ], + "categories": [ + { + "name": "", + "description": "replay buffer" + } + ], + "heading": { + "level": 2, + "text": "StartStopReplayBuffer" + }, + "lead": "", + "type": "class", + "examples": [] + }, + { + "subheads": [], + "description": "Start recording into the Replay Buffer.\nWill return an `error` if the Replay Buffer is already active or if the\n\"Save Replay Buffer\" hotkey is not set in OBS' settings.\nSetting this hotkey is mandatory, even when triggering saves only\nthrough obs-websocket.", + "api": "requests", + "name": "StartReplayBuffer", + "category": "replay buffer", + "names": [ + { + "name": "", + "description": "StartReplayBuffer" + } + ], + "categories": [ + { + "name": "", + "description": "replay buffer" + } + ], + "heading": { + "level": 2, + "text": "StartReplayBuffer" + }, + "lead": "", + "type": "class", + "examples": [] + }, + { + "subheads": [], + "description": "Stop recording into the Replay Buffer.\nWill return an `error` if the Replay Buffer is not active.", + "api": "requests", + "name": "StopReplayBuffer", + "category": "replay buffer", + "names": [ + { + "name": "", + "description": "StopReplayBuffer" + } + ], + "categories": [ + { + "name": "", + "description": "replay buffer" + } + ], + "heading": { + "level": 2, + "text": "StopReplayBuffer" + }, + "lead": "", + "type": "class", + "examples": [] + }, + { + "subheads": [], + "description": "Save and flush the contents of the Replay Buffer to disk. This is\nbasically the same as triggering the \"Save Replay Buffer\" hotkey.\nWill return an `error` if the Replay Buffer is not active.", + "api": "requests", + "name": "SaveReplayBuffer", + "category": "replay buffer", + "names": [ + { + "name": "", + "description": "SaveReplayBuffer" + } + ], + "categories": [ + { + "name": "", + "description": "replay buffer" + } + ], + "heading": { + "level": 2, + "text": "SaveReplayBuffer" + }, + "lead": "", + "type": "class", + "examples": [] + } + ], "transitions": [ { "subheads": [], diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index 2b90b54a..84f080e0 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -72,6 +72,11 @@ auth_response = base64_encode(auth_response_hash) + [RecordingStarted](#recordingstarted) + [RecordingStopping](#recordingstopping) + [RecordingStopped](#recordingstopped) + * [Replay Buffer](#replay-buffer) + + [ReplayStarting](#replaystarting) + + [ReplayStarted](#replaystarted) + + [ReplayStopping](#replaystopping) + + [ReplayStopped](#replaystopped) * [Other](#other) + [Exiting](#exiting) * [Sources](#sources) @@ -119,6 +124,11 @@ auth_response = base64_encode(auth_response_hash) + [StopRecording](#stoprecording) + [SetRecordingFolder](#setrecordingfolder) + [GetRecordingFolder](#getrecordingfolder) + * [Replay Buffer](#replay-buffer-1) + + [StartStopReplayBuffer](#startstopreplaybuffer) + + [StartReplayBuffer](#startreplaybuffer) + + [StopReplayBuffer](#stopreplaybuffer) + + [SaveReplayBuffer](#savereplaybuffer) * [Transitions](#transitions-1) + [GetTransitionList](#gettransitionlist) + [GetCurrentTransition](#getcurrenttransition) @@ -395,6 +405,48 @@ _No additional response items._ --- +## Replay Buffer + +### ReplayStarting + +A request to start the replay buffer has been issued. + +**Response Items:** + +_No additional response items._ + +--- + +### ReplayStarted + +Replay Buffer started successfully + +**Response Items:** + +_No additional response items._ + +--- + +### ReplayStopping + +A request to start the replay buffer has been issued. + +**Response Items:** + +_No additional response items._ + +--- + +### ReplayStopped + +Replay Buffer stopped successfully + +**Response Items:** + +_No additional response items._ + +--- + ## Other ### Exiting @@ -1162,9 +1214,74 @@ _No specified parameters._ | Name | Type | Description | | ---- | :---: | ------------| -| `rec-folder` | _Stsring_ | Path of the recording folder. | +| `rec-folder` | _String_ | Path of the recording folder. | +--- + +## Replay Buffer + +### StartStopReplayBuffer + +Toggle the Replay Buffer on/off. + +**Request Fields:** + +_No specified parameters._ + +**Response Items:** + +_No additional response items._ + +--- + +### StartReplayBuffer + +Start recording into the Replay Buffer. +Will return an `error` if the Replay Buffer is already active or if the +"Save Replay Buffer" hotkey is not set in OBS' settings. +Setting this hotkey is mandatory, even when triggering saves only +through obs-websocket. + +**Request Fields:** + +_No specified parameters._ + +**Response Items:** + +_No additional response items._ + +--- + +### StopReplayBuffer + +Stop recording into the Replay Buffer. +Will return an `error` if the Replay Buffer is not active. + +**Request Fields:** + +_No specified parameters._ + +**Response Items:** + +_No additional response items._ + +--- + +### SaveReplayBuffer + +Save and flush the contents of the Replay Buffer to disk. This is +basically the same as triggering the "Save Replay Buffer" hotkey. +Will return an `error` if the Replay Buffer is not active. + +**Request Fields:** + +_No specified parameters._ + +**Response Items:** + +_No additional response items._ + --- ## Transitions