OBS/obs-studio
OBS/obs-studio
1
0
Fork 0
mirror of https://github.com/obsproject/obs-studio.git synced 2024-07-04 10:33:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Document obs_frontend_recording_add_chapter()

Browse source
This commit is contained in:
derrod 2024-05-29 08:19:59 +02:00 committed by Ryan Foster
parent e92010cc11
commit cf4681a9c3
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/sphinx/reference-frontend-api.rst
View file

@ -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.