From c3dafe07030748e7471463b982959350141a46ce Mon Sep 17 00:00:00 2001 From: CodeYan01 <65320293+CodeYan01@users.noreply.github.com> Date: Wed, 21 Jun 2023 01:53:46 +0800 Subject: [PATCH] docs: Add versionadded directives for 29.1 --- docs/sphinx/reference-core.rst | 6 ++++++ docs/sphinx/reference-frontend-api.rst | 4 ++++ .../sphinx/reference-libobs-util-platform.rst | 2 ++ docs/sphinx/reference-outputs.rst | 19 ++++++++++++++++++- docs/sphinx/reference-services.rst | 18 ++++++++++++++++++ docs/sphinx/reference-sources.rst | 2 ++ 6 files changed, 50 insertions(+), 1 deletion(-) diff --git a/docs/sphinx/reference-core.rst b/docs/sphinx/reference-core.rst index 82802ab81..969dcab70 100644 --- a/docs/sphinx/reference-core.rst +++ b/docs/sphinx/reference-core.rst @@ -340,6 +340,8 @@ Libobs Objects Increments the source reference counter, use :c:func:`obs_source_release()` to release it when complete. + .. versionadded:: 29.1 + --------------------- .. function:: obs_source_t *obs_get_transition_by_name(const char *name) @@ -358,6 +360,8 @@ Libobs Objects Increments the source reference counter, use :c:func:`obs_source_release()` to release it when complete. + .. versionadded:: 29.1 + --------------------- .. function:: obs_scene_t *obs_get_scene_by_name(const char *name) @@ -580,6 +584,8 @@ Video, Audio, and Graphics Adds/removes a main rendered callback. Allows using the result of the main stream/recording output. + .. versionadded:: 29.1 + --------------------- .. function:: void obs_add_raw_video_callback(const struct video_scale_info *conversion, void (*callback)(void *param, struct video_data *frame), void *param) diff --git a/docs/sphinx/reference-frontend-api.rst b/docs/sphinx/reference-frontend-api.rst index a5ee4ec03..bf723c078 100644 --- a/docs/sphinx/reference-frontend-api.rst +++ b/docs/sphinx/reference-frontend-api.rst @@ -848,6 +848,8 @@ Functions :param item: The sceneitem to open the edit transform window of + .. versionadded:: 29.1 + --------------------------------------- .. function:: char *obs_frontend_get_current_record_output_path(void) @@ -906,3 +908,5 @@ Functions :param redo_data: String with data for the redo callback :param repeatable: Allow multiple actions with the same name to be merged to 1 undo redo action. This uses the undo action from the first and the redo action from the last action. + + .. versionadded:: 29.1 diff --git a/docs/sphinx/reference-libobs-util-platform.rst b/docs/sphinx/reference-libobs-util-platform.rst index 8547521c2..3584e282e 100644 --- a/docs/sphinx/reference-libobs-util-platform.rst +++ b/docs/sphinx/reference-libobs-util-platform.rst @@ -503,3 +503,5 @@ Other Functions Creates a version 4 UUID and returns a NULL-terminated 36-character string. Must be freed with :c:func:`bfree()`. + + .. versionadded:: 29.1 diff --git a/docs/sphinx/reference-outputs.rst b/docs/sphinx/reference-outputs.rst index 4e854e0bb..da53c285a 100644 --- a/docs/sphinx/reference-outputs.rst +++ b/docs/sphinx/reference-outputs.rst @@ -244,6 +244,8 @@ Output Definition Structure (obs_output_info) Required only if **OBS_OUTPUT_SERVICE** flag is set. + .. versionadded:: 29.1 + .. _output_signal_handler_reference: Output Signals @@ -681,11 +683,15 @@ General Output Functions .. function:: const char *obs_output_get_supported_video_codecs(const obs_output_t *output) const char *obs_get_output_supported_video_codecs(const char *id) const char *obs_output_get_supported_audio_codecs(const obs_output_t *output) - const char *obs_get_output_supported_video_codecs(const char *id) + const char *obs_get_output_supported_audio_codecs(const char *id) :return: Supported video/audio codecs of an encoded output, separated by semicolon + .. versionadded:: 29.1 + :c:func:`obs_get_output_supported_video_codecs` and + :c:func:`obs_get_output_supported_audio_codecs` + --------------------- .. function:: uint32_t obs_output_get_flags(const obs_output_t *output) @@ -700,6 +706,8 @@ General Output Functions :return: Supported protocols, separated by semicolon. Always NULL if the output is not **OBS_OUTPUT_SERVICE**. + .. versionadded:: 29.1 + --------------------- .. function:: bool obs_is_output_protocol_registered(const char *protocol) @@ -709,12 +717,16 @@ General Output Functions :return: A boolean showing if an output with the given protocol is registered + .. versionadded:: 29.1 + --------------------- .. function:: bool obs_enum_output_protocols(size_t idx, char **protocol) Enumerates all registered protocol. + .. versionadded:: 29.1 + --------------------- .. function:: void obs_enum_output_types_with_protocol(const char *protocol, void *data, bool (*enum_cb)(void *data, const char *id)) @@ -727,6 +739,8 @@ General Output Functions of the output is passed to the callback :return: When all outputs are enumerated or if the callback return *false* + .. versionadded:: 29.1 + --------------------- Functions used by outputs @@ -746,6 +760,9 @@ Functions used by outputs Optionally sets/gets the video conversion information. Only used by raw outputs. + .. versionadded:: 29.1 + :c:func:`obs_output_get_video_conversion` + Relevant data types used with this function: .. code:: cpp diff --git a/docs/sphinx/reference-services.rst b/docs/sphinx/reference-services.rst index 7085742cb..d35a919ec 100644 --- a/docs/sphinx/reference-services.rst +++ b/docs/sphinx/reference-services.rst @@ -157,10 +157,14 @@ Service Definition Structure the data manually (typically best to use strlist_split to generate this) + .. versionadded:: 29.1 + .. member:: const char *(*obs_service_info.get_protocol)(void *data) :return: The protocol used by the service + .. versionadded:: 29.1 + .. member:: const char *(*obs_service_info.get_connect_info)(void *data, uint32_t type) Output a service connection info related to a given type value: @@ -184,6 +188,8 @@ Service Definition Structure Irrelevant or unused types can return `NULL`. + .. versionadded:: 29.1 + .. member:: bool (*obs_service_info.can_try_to_connect)(void *data) (Optional) @@ -194,6 +200,8 @@ Service Definition Structure NOTE: If not set, :c:func:`obs_service_can_try_to_connect()` returns *true* by default. + .. versionadded:: 29.1 + General Service Functions ------------------------- @@ -370,18 +378,24 @@ General Service Functions codecs for the service, terminated with a *NULL* pointer. Does not need to be freed + .. versionadded:: 29.1 + --------------------- .. function:: const char *obs_service_get_protocol(const obs_service_t *service) :return: Protocol currently used for this service + .. versionadded:: 29.1 + --------------------- .. function:: const char *obs_service_get_preferred_output_type(const obs_service_t *service) :return: The output type that should be preferred with this service + .. versionadded:: 29.1 + --------------------- .. function:: const char *obs_service_get_connect_info(const obs_service_t *service, uint32_t type) @@ -390,6 +404,8 @@ General Service Functions type values. :return: Connection info related to the type value. + .. versionadded:: 29.1 + --------------------- .. function:: bool obs_service_can_try_to_connect(const obs_service_t *service) @@ -398,6 +414,8 @@ General Service Functions able to connect. Returns `true` if :c:member:`obs_service_info.can_try_to_connect` is not set. + .. versionadded:: 29.1 + .. --------------------------------------------------------------------------- .. _libobs/obs-service.h: https://github.com/obsproject/obs-studio/blob/master/libobs/obs-service.h diff --git a/docs/sphinx/reference-sources.rst b/docs/sphinx/reference-sources.rst index c58e81935..960ecffa6 100644 --- a/docs/sphinx/reference-sources.rst +++ b/docs/sphinx/reference-sources.rst @@ -954,6 +954,8 @@ General Source Functions :return: The UUID of the source + .. versionadded:: 29.1 + --------------------- .. function:: void obs_source_set_name(obs_source_t *source, const char *name)