UI: Add replay buffer saved event to the frontend api (obsproject#3592)

* obs-frontend-api: add the event of saving replay buffer Add OBS_FRONTEND_EVENT_REPLAY_BUFFER_SAVED as given by RFC 33 * UI: Emit the replay buffer saved event to the api Send the OBS_FRONTEND_EVENT_REPLAY_BUFFER_SAVED to api (as in rfc33) * docs/sphinx: Add replay buffer saved event Documentation provided for OBS_FRONTEND_EVENT_REPLAY_BUFFER_SAVED (RFC33)
Fenrirthviti · Oct 11, 2020 · d3ec3e9 · d3ec3e9
1 parent a94c0e0
commit d3ec3e9
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/UI/obs-frontend-api/obs-frontend-api.h b/UI/obs-frontend-api/obs-frontend-api.h
@@ -37,6 +37,7 @@ enum obs_frontend_event {
 	OBS_FRONTEND_EVENT_REPLAY_BUFFER_STARTED,
 	OBS_FRONTEND_EVENT_REPLAY_BUFFER_STOPPING,
 	OBS_FRONTEND_EVENT_REPLAY_BUFFER_STOPPED,
+	OBS_FRONTEND_EVENT_REPLAY_BUFFER_SAVED,
 
 	OBS_FRONTEND_EVENT_STUDIO_MODE_ENABLED,
 	OBS_FRONTEND_EVENT_STUDIO_MODE_DISABLED,

diff --git a/UI/window-basic-main.cpp b/UI/window-basic-main.cpp
@@ -6141,6 +6141,8 @@ void OBSBasic::ReplayBufferSave()
 		obs_output_get_proc_handler(outputHandler->replayBuffer);
 	proc_handler_call(ph, "save", &cd);
 	calldata_free(&cd);
+	if (api)
+		api->on_event(OBS_FRONTEND_EVENT_REPLAY_BUFFER_SAVED);
 }
 
 void OBSBasic::ReplayBufferStop(int code)

diff --git a/docs/sphinx/reference-frontend-api.rst b/docs/sphinx/reference-frontend-api.rst
@@ -105,6 +105,10 @@ Structures/Enumerations
 
      Triggered when the replay buffer has fully stopped.
 
+   - **OBS_FRONTEND_EVENT_REPLAY_BUFFER_SAVED**
+
+     Triggered when the replay buffer has been saved.
+
    - **OBS_FRONTEND_EVENT_STUDIO_MODE_ENABLED**
 
      Triggered when the user has turned on studio mode.