mirror of
https://github.com/obsproject/obs-studio.git
synced 2024-07-15 07:44:10 +00:00
docs: Add links to python functions
This commit is contained in:
parent
8779f052fd
commit
81233c6dd4
|
@ -278,6 +278,8 @@ Libobs Objects
|
||||||
:c:func:`obs_source_get_weak_source()` if you want to retain a
|
:c:func:`obs_source_get_weak_source()` if you want to retain a
|
||||||
reference after obs_enum_sources finishes.
|
reference after obs_enum_sources finishes.
|
||||||
|
|
||||||
|
For scripting, use :py:func:`obs_enum_sources`.
|
||||||
|
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
.. function:: void obs_enum_scenes(bool (*enum_proc)(void*, obs_source_t*), void *param)
|
.. function:: void obs_enum_scenes(bool (*enum_proc)(void*, obs_source_t*), void *param)
|
||||||
|
@ -522,6 +524,9 @@ Video, Audio, and Graphics
|
||||||
Adds/removes a main rendering callback. Allows custom rendering to
|
Adds/removes a main rendering callback. Allows custom rendering to
|
||||||
the main stream/recording output.
|
the main stream/recording output.
|
||||||
|
|
||||||
|
For scripting (**Lua only**), use :py:func:`obs_add_main_render_callback`
|
||||||
|
and :py:func:`obs_remove_main_render_callback`.
|
||||||
|
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
.. function:: void obs_add_raw_video_callback(const struct video_scale_info *conversion, void (*callback)(void *param, struct video_data *frame), void *param)
|
.. function:: void obs_add_raw_video_callback(const struct video_scale_info *conversion, void (*callback)(void *param, struct video_data *frame), void *param)
|
||||||
|
|
|
@ -194,6 +194,8 @@ Signals are used for all event-based callbacks.
|
||||||
:param callback: Signal callback
|
:param callback: Signal callback
|
||||||
:param data: Private data passed the callback
|
:param data: Private data passed the callback
|
||||||
|
|
||||||
|
For scripting, use :py:func:`signal_handler_connect`.
|
||||||
|
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
.. function:: void signal_handler_connect_ref(signal_handler_t *handler, const char *signal, signal_callback_t callback, void *data)
|
.. function:: void signal_handler_connect_ref(signal_handler_t *handler, const char *signal, signal_callback_t callback, void *data)
|
||||||
|
@ -216,6 +218,8 @@ Signals are used for all event-based callbacks.
|
||||||
:param callback: Signal callback
|
:param callback: Signal callback
|
||||||
:param data: Private data passed the callback
|
:param data: Private data passed the callback
|
||||||
|
|
||||||
|
For scripting, use :py:func:`signal_handler_disconnect`.
|
||||||
|
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
.. function:: void signal_handler_signal(signal_handler_t *handler, const char *signal, calldata_t *params)
|
.. function:: void signal_handler_signal(signal_handler_t *handler, const char *signal, calldata_t *params)
|
||||||
|
|
|
@ -253,6 +253,8 @@ Property Object Functions
|
||||||
- :c:func:`obs_property_button_set_type`
|
- :c:func:`obs_property_button_set_type`
|
||||||
- :c:func:`obs_property_button_set_url`
|
- :c:func:`obs_property_button_set_url`
|
||||||
|
|
||||||
|
For scripting, use :py:func:`obs_properties_add_button`.
|
||||||
|
|
||||||
Relevant data types used with this function:
|
Relevant data types used with this function:
|
||||||
|
|
||||||
.. code:: cpp
|
.. code:: cpp
|
||||||
|
|
|
@ -266,6 +266,8 @@ General Scene Functions
|
||||||
|
|
||||||
Enumerates scene items within a scene.
|
Enumerates scene items within a scene.
|
||||||
|
|
||||||
|
For scripting, use :py:func:`obs_scene_enum_items`.
|
||||||
|
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
.. function:: bool obs_scene_reorder_items(obs_scene_t *scene, obs_sceneitem_t * const *item_order, size_t item_order_size)
|
.. function:: bool obs_scene_reorder_items(obs_scene_t *scene, obs_sceneitem_t * const *item_order, size_t item_order_size)
|
||||||
|
|
Loading…
Reference in a new issue