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

docs: Add missing elements in Services API

Browse source
This commit is contained in:
tytan652 2023-05-03 12:34:49 +02:00 committed by Jim
parent be42d97315
commit 3a16a6c836
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/sphinx/reference-services.rst
View file

@ -186,6 +186,8 @@ Service Definition Structure
.. member:: bool (*obs_service_info.can_try_to_connect)(void *data)
(Optional)
:return: If the service has all the needed connection info to be
able to connect.
@ -380,12 +382,16 @@ General Service Functions
:return: The output type that should be preferred with this service
---------------------
.. function:: const char *obs_service_get_connect_info(const obs_service_t *service, uint32_t type)
:param type: Check :c:member:`obs_service_info.get_connect_info` for
type values.
:return: Connection info related to the type value.
---------------------
.. function:: bool obs_service_can_try_to_connect(const obs_service_t *service)
:return: If the service has all the needed connection info to be