mirror/obs-studio
0
0
Fork 0
mirror of https://github.com/obsproject/obs-studio.git synced 2024-09-20 04:42:18 +02:00
Code

docs: Fix frontend API docs for preview_scene functions

Browse Source
This commit is contained in:
gxalpha 2022-01-01 13:09:18 +01:00 committed by Jim
parent 47d8f2e497
commit 3fb2e27825
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/sphinx/reference-frontend-api.rst
View File

@ -659,15 +659,14 @@ Functions
.. function:: obs_source_t *obs_frontend_get_current_preview_scene(void) .. function:: obs_source_t *obs_frontend_get_current_preview_scene(void)
:return: A new reference to the current preview scene if studio mode :return: A new reference to the current preview scene if studio mode
is active, or the current scene if studio mode is not is active, or *NULL* if studio mode is not active.
active
--------------------------------------- ---------------------------------------
.. function:: void obs_frontend_set_current_preview_scene(obs_source_t *scene) .. function:: void obs_frontend_set_current_preview_scene(obs_source_t *scene)
Sets the current preview scene in studio mode, or the currently Sets the current preview scene in studio mode. Does nothing if studio
active scene if not in studio mode. mode is disabled.
:param scene: The scene to set as the current preview :param scene: The scene to set as the current preview