Merge pull request #2329 from exeldro/docs

docs/sphinx: Add obs_group_from_source and obs_enum_scenes
master
Jim 2020-01-19 12:13:25 -08:00 committed by GitHub
commit 500111e230
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 0 deletions

View File

@ -228,6 +228,19 @@ Libobs Objects
---------------------
.. function:: void obs_enum_scenes(bool (*enum_proc)(void*, obs_source_t*), void *param)
Enumerates all scenes.
Callback function returns true to continue enumeration, or false to end
enumeration.
Use :c:func:`obs_source_get_ref()` or
:c:func:`obs_source_get_weak_source()` if you want to retain a
reference after obs_enum_scenes finishes.
---------------------
.. function:: void obs_enum_outputs(bool (*enum_proc)(void*, obs_output_t*), void *param)
Enumerates outputs.

View File

@ -494,6 +494,13 @@ Scene Item Group Functions
---------------------
.. function:: obs_scene_t *obs_group_from_source(const obs_source_t *source)
:return: The group context, or *NULL* if not a group. Does not
increase the reference
---------------------
.. function:: bool obs_sceneitem_is_group(obs_sceneitem_t *item)
:param item: Scene item