Browse Source

docs: Document a few missing obs_output_t function calls

- `obs_weak_output_references_output`
- `obs_output_get_id`
- `obs_output_output_caption_text[1/2]`
tt2468 2 years ago
parent
commit
24e9f82f87
1 changed files with 26 additions and 0 deletions
  1. 26 0
      docs/sphinx/reference-outputs.rst

+ 26 - 0
docs/sphinx/reference-outputs.rst

@@ -373,12 +373,26 @@ General Output Functions
 
 
 ---------------------
 ---------------------
 
 
+.. function:: bool obs_weak_output_references_output(obs_weak_output_t *weak, obs_output_t *output)
+
+   Compares a weak output reference with an output.
+
+   :return: Whether the weak output reference ties back to the specified output
+
+---------------------
+
 .. function:: const char *obs_output_get_name(const obs_output_t *output)
 .. function:: const char *obs_output_get_name(const obs_output_t *output)
 
 
    :return: The name of the output
    :return: The name of the output
 
 
 ---------------------
 ---------------------
 
 
+.. function:: const char *obs_output_get_id(const obs_output_t *output)
+
+   :return: The output's type identifier string
+
+---------------------
+
 .. function:: bool obs_output_start(obs_output_t *output)
 .. function:: bool obs_output_start(obs_output_t *output)
 
 
    Starts the output.
    Starts the output.
@@ -621,6 +635,18 @@ General Output Functions
 
 
 ---------------------
 ---------------------
 
 
+.. function:: void obs_output_output_caption_text1(obs_output_t *output, const char *text)
+              void obs_output_output_caption_text2(obs_output_t *output, const char *text, double display_duration)
+
+   Outputs captions from the specified text input. *text1* is the same as
+   *text2*, except that the *display_duration* is hardcoded to 2.0 seconds.
+
+   *display_duration* represents the minimum quantity of time that a given
+   caption can be displayed for before moving onto the next caption in the
+   queue.
+
+---------------------
+
 .. function:: float obs_output_get_congestion(obs_output_t *output)
 .. function:: float obs_output_get_congestion(obs_output_t *output)
 
 
    :return: The congestion value.  This value is used to visualize the
    :return: The congestion value.  This value is used to visualize the