mirror of
https://github.com/obsproject/obs-studio.git
synced 2024-06-27 23:23:32 +00:00
docs: Add versionadded for 30.x functions
This commit is contained in:
CodeYan01
Ryan Foster
parent
acd4854ced
commit
9c427c5f93
|
|
@ -544,6 +544,8 @@ Video, Audio, and Graphics
|
|||
|
||||
Resets all audio monitoring devices.
|
||||
|
||||
.. versionadded:: 30.1
|
||||
|
||||
---------------------
|
||||
|
||||
.. function:: void obs_enum_audio_monitoring_devices(obs_enum_audio_device_cb cb, void *data)
|
||||
|
|
@ -922,3 +924,5 @@ Views
|
|||
.. function:: void obs_view_enum_video_info(obs_view_t *view, bool (*enum_proc)(void *, struct obs_video_info *), void *param)
|
||||
|
||||
Enumerates all the video info of all mixes that use the specified mix.
|
||||
|
||||
.. versionadded:: 30.1
|
||||
|
|
|
|||
|
|
@ -165,6 +165,7 @@ Encoder Definition Structure (obs_encoder_info)
|
|||
- **OBS_ENCODER_CAP_DEPRECATED** - Encoder is deprecated
|
||||
- **OBS_ENCODER_CAP_ROI** - Encoder supports region of interest feature
|
||||
|
||||
.. versionadded:: 30.1
|
||||
|
||||
Encoder Packet Structure (encoder_packet)
|
||||
-----------------------------------------
|
||||
|
|
@ -273,6 +274,8 @@ Encoder Region of Interest Structure (obs_encoder_roi)
|
|||
|
||||
Encoder region of interest structure.
|
||||
|
||||
.. versionadded:: 30.1
|
||||
|
||||
.. member:: uint32_t top
|
||||
uint32_t bottom
|
||||
uint32_t left
|
||||
|
|
@ -549,18 +552,24 @@ General Encoder Functions
|
|||
|
||||
:return: *true* if adding succeeded, *false* otherwise.
|
||||
|
||||
.. versionadded:: 30.1
|
||||
|
||||
---------------------
|
||||
|
||||
.. function:: bool obs_encoder_has_roi(obs_encoder_t *encoder)
|
||||
|
||||
:return: *true* if encoder has ROI regions set, *false* otherwise.
|
||||
|
||||
.. versionadded:: 30.1
|
||||
|
||||
---------------------
|
||||
|
||||
.. function:: void obs_encoder_clear_roi(obs_encoder_t *encoder)
|
||||
|
||||
Clear region of interest list, if any.
|
||||
|
||||
.. versionadded:: 30.1
|
||||
|
||||
---------------------
|
||||
|
||||
.. function:: void obs_encoder_enum_roi(obs_encoder_t *encoder, void (*enum_proc)(void *, struct obs_encoder_roi *), void *param)
|
||||
|
|
@ -569,6 +578,8 @@ General Encoder Functions
|
|||
|
||||
**Note:** If the encoder has scaling enabled the struct passed to the callback will be scaled accordingly.
|
||||
|
||||
.. versionadded:: 30.1
|
||||
|
||||
---------------------
|
||||
|
||||
.. function:: uint32_t obs_encoder_get_roi_increment(const obs_encoder_t *encoder)
|
||||
|
|
@ -577,6 +588,8 @@ General Encoder Functions
|
|||
|
||||
:return: Increment/revision of ROI list
|
||||
|
||||
.. versionadded:: 30.1
|
||||
|
||||
---------------------
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -489,6 +489,8 @@ Functions
|
|||
:return: *true* if the dock was added, *false* if the id was already
|
||||
used
|
||||
|
||||
.. versionadded:: 30.0
|
||||
|
||||
---------------------------------------
|
||||
|
||||
.. function:: void obs_frontend_remove_dock(const char *id)
|
||||
|
|
@ -497,6 +499,8 @@ Functions
|
|||
|
||||
:param id: Unique identifier of the dock to remove.
|
||||
|
||||
.. versionadded:: 30.0
|
||||
|
||||
---------------------------------------
|
||||
|
||||
.. function:: bool obs_frontend_add_custom_qdock(const char *id, void *dock)
|
||||
|
|
@ -511,6 +515,8 @@ Functions
|
|||
:return: *true* if the dock was added, *false* if the id was already
|
||||
used
|
||||
|
||||
.. versionadded:: 30.0
|
||||
|
||||
---------------------------------------
|
||||
|
||||
.. function:: void obs_frontend_add_event_callback(obs_frontend_event_cb callback, void *private_data)
|
||||
|
|
|
|||
|
|
@ -8,6 +8,8 @@ as data is pushed to the front or back.
|
|||
|
||||
#include <util/deque.h>
|
||||
|
||||
.. versionadded:: 30.1
|
||||
|
||||
|
||||
Deque Structure (struct deque)
|
||||
--------------------------------------------
|
||||
|
|
|
|||
|
|
@ -271,13 +271,15 @@ plugin modules.
|
|||
|
||||
---------------------
|
||||
|
||||
.. function:: void *obs_add_safe_module(const char *name)
|
||||
.. function:: void obs_add_safe_module(const char *name)
|
||||
|
||||
Adds a *name* to the list of modules allowed to load in Safe Mode.
|
||||
If the list is empty, all modules are allowed.
|
||||
|
||||
:param name: The name of the module (filename sans extension).
|
||||
|
||||
.. versionadded:: 30.0
|
||||
|
||||
---------------------
|
||||
|
||||
.. function:: void obs_module_failure_info_free(struct obs_module_failure_info *mfi)
|
||||
|
|
|
|||
|
|
@ -209,6 +209,8 @@ Property Object Functions
|
|||
- **OBS_COMBO_TYPE_LIST** - Not editable. Displayed as combo box.
|
||||
- **OBS_COMBO_TYPE_RADIO** - Not editable. Displayed as radio buttons.
|
||||
|
||||
.. versionadded:: 30.0
|
||||
|
||||
:param format: Can be one of the following values:
|
||||
|
||||
- **OBS_COMBO_FORMAT_INT** - Integer list
|
||||
|
|
@ -217,6 +219,8 @@ Property Object Functions
|
|||
- **OBS_COMBO_FORMAT_STRING** - String list
|
||||
- **OBS_COMBO_FORMAT_BOOL** - Boolean list
|
||||
|
||||
.. versionadded:: 30.0
|
||||
|
||||
:return: The property
|
||||
|
||||
Important Related Functions:
|
||||
|
|
|
|||
|
|
@ -304,6 +304,8 @@ inappropriate or invalid.
|
|||
:return: An incremented reference to a data array object. Release
|
||||
with :c:func:`obs_data_array_release()`.
|
||||
|
||||
.. versionadded:: 30.1
|
||||
|
||||
---------------------
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -661,6 +661,8 @@ The following signals are defined for every source type:
|
|||
|
||||
Called when a filter has been added to the source.
|
||||
|
||||
.. versionadded:: 30.0
|
||||
|
||||
**filter_remove** (ptr source, ptr filter)
|
||||
|
||||
Called when a filter has been removed from the source.
|
||||
|
|
|
|||
Loading…
Reference in a new issue