Skip to content

Commit

Permalink
docs: Document obs_frontend_recording_add_chapter()
Browse files Browse the repository at this point in the history
  • Loading branch information
derrod authored and RytoEX committed May 29, 2024
1 parent e92010c commit cf4681a
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/sphinx/reference-frontend-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -647,6 +647,17 @@ Functions

---------------------------------------

.. function:: bool obs_frontend_recording_add_chapter(const char *name)

Asks OBS to insert a chapter marker at the current output time into the recording.

:param name: The name for the chapter, may be *NULL* to use an automatically generated name ("Unnamed <Chapter number>" or localized equivalent).
:return: *true* if insertion was successful, *false* if recording is inactive, paused, or if chapter insertion is not supported by the current output.

.. versionadded:: 30.2

---------------------------------------

.. function:: void obs_frontend_replay_buffer_start(void)

Starts the replay buffer.
Expand Down

0 comments on commit cf4681a

Please sign in to comment.