New upstream version 24.0.1+dfsg1

docs/sphinx/reference-frontend-api.rst

@@ -124,6 +124,18 @@ Structures/Enumerations
      the program is either about to load a new scene collection, or the
      program is about to exit.
 
+   - **OBS_FRONTEND_FINISHED_LOADING**
+
+     Triggered when the program has finished loading.
+
+   - **OBS_FRONTEND_EVENT_RECORDING_PAUSED**
+
+     Triggered when the recording has been paused.
+
+   - **OBS_FRONTEND_EVENT_RECORDING_UNPAUSED**
+
+     Triggered when the recording has been unpaused.
+
 .. type:: struct obs_frontend_source_list
 
    - DARRAY(obs_source_t*) **sources**
@@ -402,6 +414,18 @@ Functions
 
 ---------------------------------------
 
+.. function:: void obs_frontend_recording_pause(bool pause)
+
+   :pause: *true* to pause recording, *false* to unpause.
+
+---------------------------------------
+
+.. function:: bool obs_frontend_recording_paused(void)
+
+   :return: *true* if recording paused, *false* otherwise.
+
+---------------------------------------
+
 .. function:: void obs_frontend_replay_buffer_start(void)
 
    Starts replay buffer.

docs/sphinx/reference-outputs.rst

@@ -66,6 +66,14 @@ Output Definition Structure (obs_output_info)
      When this capability flag is used, specifies that this output
      supports multiple encoded audio tracks simultaneously.
 
+   - **OBS_OUTPUT_CAN_PAUSE** - Output supports pausing.
+
+     When this capability flag is used, the output supports pausing.
+     When an output is paused, raw or encoded audio/video data will be
+     halted when paused down to the exact point to the closest video
+     frame.  Audio data will be correctly truncated down to the exact
+     audio sample according to that video frame timing.
+
 .. member:: const char *(*obs_output_info.get_name)(void *type_data)
 
    Get the translated name of the output type.
@@ -170,13 +178,9 @@ Output Definition Structure (obs_output_info)
 
    :return: The properties of the output
 
-.. member:: void (*obs_output_info.pause)(void *data)
+.. member:: void (*obs_output_info.unused1)(void *data)
 
-   Pauses the output (if the output supports pausing).
-
-   (Author's note: This is currently unimplemented)
-
-   (Optional)
+   This callback is no longer used.
 
 .. member:: uint64_t (*obs_output_info.get_total_bytes)(void *data)
 
@@ -257,6 +261,14 @@ Output Signals
                   | OBS_OUTPUT_NO_SPACE       - Ran out of disk space
                   | OBS_OUTPUT_ENCODE_ERROR   - Encoder error
 
+**pause** (ptr output)
+
+   Called when the output has been paused.
+
+**unpause** (ptr output)
+
+   Called when the output has been unpaused.
+
 **starting** (ptr output)
 
    Called when the output is starting.
@@ -444,11 +456,18 @@ General Output Functions
 
 ---------------------
 
-.. function:: void obs_output_pause(obs_output_t *output)
+.. function:: bool obs_output_pause(obs_output_t *output, bool pause)
 
    Pause an output (if supported by the output).
 
-   (Author's Note: Not yet implemented)
+   :return: *true* if the output was paused successfuly, *false*
+            otherwise
+
+---------------------
+
+.. function:: bool obs_output_paused(const obs_output_t *output)
+
+   :return: *true* if the output is paused, *false* otherwise
 
 ---------------------
 
@@ -808,6 +827,14 @@ Functions used by outputs
                 | OBS_OUTPUT_UNSUPPORTED    - The settings, video/audio format, or codecs are unsupported by this output
                 | OBS_OUTPUT_NO_SPACE       - Ran out of disk space
 
+---------------------
+
+.. function:: uint64_t obs_output_get_pause_offset(obs_output_t *output)
+
+   Returns the current pause offset of the output.  Used with raw
+   outputs to calculate system timestamps when using calculated
+   timestamps (see FFmpeg output for an example).
+
 .. ---------------------------------------------------------------------------
 
 .. _libobs/obs-output.h: https://github.com/jp9000/obs-studio/blob/master/libobs/obs-output.h

docs/sphinx/reference-scenes.rst

@@ -139,6 +139,10 @@ Scene Signals
 
    Called when a scene item's visibility state changes.
 
+**item_locked** (ptr scene, ptr item, bool locked)
+
+   Called when a scene item has been locked or unlocked.
+
 **item_select** (ptr scene, ptr item)
 **item_deselect** (ptr scene, ptr item)
 
@@ -406,6 +410,13 @@ Scene Item Functions
 
 ---------------------
 
+.. function:: bool obs_sceneitem_set_locked(obs_sceneitem_t *item, bool locked)
+              bool obs_sceneitem_locked(const obs_sceneitem_t *item)
+
+   Sets/gets the locked/unlocked state of the scene item.
+
+---------------------
+
 .. function:: void obs_sceneitem_set_crop(obs_sceneitem_t *item, const struct obs_sceneitem_crop *crop)
               void obs_sceneitem_get_crop(const obs_sceneitem_t *item, struct obs_sceneitem_crop *crop)