OBS/obs-studio
OBS/obs-studio
1
0
Fork 0
mirror of https://github.com/obsproject/obs-studio.git synced 2024-07-15 07:44:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Document a few missing obs_output_t function calls

Browse source 
- `obs_weak_output_references_output`
- `obs_output_get_id`
- `obs_output_output_caption_text[1/2]`
This commit is contained in:
tt2468 2023-01-15 22:09:23 -08:00
parent eb35b07f44
commit 24e9f82f87
1 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
docs/sphinx/reference-outputs.rst
View file

@ -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)
: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)
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)
:return: The congestion value. This value is used to visualize the