New upstream version 23.2.1+dfsg1

docs/sphinx/reference-frontend-api.rst

@@ -235,6 +235,18 @@ Functions
 
 ---------------------------------------
 
+.. function:: int obs_frontend_get_transition_duration(void)
+
+   :return: The transition duration (in milliseconds) currently set in the UI.
+
+---------------------------------------
+
+.. function:: void obs_frontend_set_transition_duration(int duration)
+
+   :param duration: Desired transition duration (in milliseconds)
+
+---------------------------------------
+
 .. function:: char **obs_frontend_get_scene_collections(void)
 
    :return: The list of profile names, ending with NULL.  The list is
@@ -473,6 +485,12 @@ Functions
 
 ---------------------------------------
 
+.. function:: void obs_frontend_preview_program_trigger_transition(void)
+
+   Triggers a preview-to-program transition if studio mode is active.
+
+---------------------------------------
+
 .. function:: obs_source_t *obs_frontend_get_current_preview_scene(void)
 
    :return: A new reference to the current preview scene if studio mode

docs/sphinx/reference-libobs-graphics-effects.rst

@@ -154,6 +154,36 @@ HLSL format.
 
 ---------------------
 
+.. function:: size_t gs_param_get_num_annotations(const gs_eparam_t *param)
+
+   Gets the number of annotations associated with the parameter.
+
+   :param param:  Param object
+   :return:       Number of annotations the param has
+
+---------------------
+
+.. function:: gs_eparam_t *gs_param_get_annotation_by_idx(const gs_eparam_t *param, size_t annotation)
+
+   Gets an annotation of a param by its index.
+
+   :param param:  Param object
+   :param param:  Annotation index
+   :return:       The effect parameter object (annotation), or *NULL* if index
+                  invalid
+
+---------------------
+
+.. function:: gs_eparam_t *gs_param_get_annotation_by_name(const gs_eparam_t *pardam, const char *annotation)
+
+   Gets parameter of an effect by its name.
+
+   :param param:  Param object
+   :param name:   Name of the annotation
+   :return:       The effect parameter object (annotation), or *NULL* if not found
+
+---------------------
+
 .. function:: bool gs_effect_loop(gs_effect_t *effect, const char *name)
 
    Helper function that automatically begins techniques/passes.
@@ -332,3 +362,39 @@ HLSL format.
 
    :param param:   Effect parameter
    :param sampler: Sampler state object
+
+---------------------
+
+.. function:: void *gs_effect_get_val(gs_eparam_t *param)
+
+   Returns a copy of the param's current value.
+
+   :param param:   Effect parameter
+   :return:        A pointer to the copied byte value of the param's current value. Freed with :c:func:`bfree()`.
+
+---------------------
+
+.. function:: void gs_effect_get_default_val(gs_eparam_t *param)
+
+   Returns a copy of the param's default value.
+
+   :param param:   Effect parameter
+   :return:        A pointer to the copied byte value of the param's default value. Freed with :c:func:`bfree()`.
+
+---------------------
+
+.. function:: size_t gs_effect_get_val_size(gs_eparam_t *param)
+
+   Returns the size in bytes of the param's current value.
+
+   :param param:   Effect parameter
+   :return:        The size in bytes of the param's current value.
+
+---------------------
+
+.. function:: size_t gs_effect_get_default_val_size(gs_eparam_t *param)
+
+   Returns the size in bytes of the param's default value.
+
+   :param param:   Effect parameter
+   :return:        The size in bytes of the param's default value.

docs/sphinx/reference-outputs.rst

@@ -117,6 +117,18 @@ Output Definition Structure (obs_output_info)
    This is called when the output recieves raw audio data.  Only applies
    to outputs that are not encoded.
 
+   **This callback must be used with single-track raw outputs.**
+
+   :param frames: The raw audio frames
+
+.. member:: void (*obs_output_info.raw_audio2)(void *data, size_t idx, struct audio_data *frames)
+
+   This is called when the output recieves raw audio data.  Only applies
+   to outputs that are not encoded.
+
+   **This callback must be used with multi-track raw outputs.**
+
+   :param idx:    The audio track index
    :param frames: The raw audio frames
 
 .. member:: void (*obs_output_info.encoded_packet)(void *data, struct encoder_packet *packet)
@@ -125,7 +137,10 @@ Output Definition Structure (obs_output_info)
    Only applies to outputs that are encoded.  Packets will always be
    given in monotonic timestamp order.
 
-   :param packet: The video or audio packet
+   :param packet: The video or audio packet.  If NULL, an encoder error
+                  occurred, and the output should call
+                  :c:func:`obs_output_signal_stop()` with the error code
+                  **OBS_OUTPUT_ENCODE_ERROR**.
 
 .. member:: void (*obs_output_info.update)(void *data, obs_data_t *settings)
 
@@ -240,6 +255,7 @@ Output Signals
                   | OBS_OUTPUT_DISCONNECTED   - Unexpectedly disconnected
                   | OBS_OUTPUT_UNSUPPORTED    - The settings, video/audio format, or codecs are unsupported by this output
                   | OBS_OUTPUT_NO_SPACE       - Ran out of disk space
+                  | OBS_OUTPUT_ENCODE_ERROR   - Encoder error
 
 **starting** (ptr output)
 
@@ -472,7 +488,19 @@ General Output Functions
 .. function:: void obs_output_set_mixer(obs_output_t *output, size_t mixer_idx)
               size_t obs_output_get_mixer(const obs_output_t *output)
 
-   Sets/gets the current audio mixer for non-encoded outputs.
+   Sets/gets the current audio mixer for non-encoded outputs.  For
+   multi-track outputs, this would be the equivalent of setting the mask
+   only for the specified mixer index.
+
+---------------------
+
+.. function:: void obs_output_set_mixers(obs_output_t *output, size_t mixers)
+              size_t obs_output_get_mixers(const obs_output_t *output)
+
+   Sets/gets the current audio mixers (via mask) for non-encoded
+   multi-track outputs.  If used with single-track outputs, the
+   single-track output will use either the first set mixer track in the
+   bitmask, or the first track if none is set in the bitmask.
 
 ---------------------
 

docs/sphinx/reference-scenes.rst

@@ -279,6 +279,12 @@ Scene Item Functions
 
 ---------------------
 
+.. function:: int64_t obs_sceneitem_get_id(const obs_sceneitem_t *item)
+
+   :return: The unique numeric identifier of the scene item.
+
+---------------------
+
 .. function:: void obs_sceneitem_set_pos(obs_sceneitem_t *item, const struct vec2 *pos)
               void obs_sceneitem_get_pos(const obs_sceneitem_t *item, struct vec2 *pos)