opensource/obs-studio
3
0
Fork 0
mirror of https://github.com/obsproject/obs-studio.git synced 2026-09-24 23:31:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

libobs,docs: Add connect infos to the Services API

Browse Source 
This replace and deprecate url, key, username and password functions.
This commit is contained in:
tytan652
2023-03-19 17:38:02 +01:00
parent 5fe417bce1
commit ea4ac2d08d
4 changed files with 75 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sphinx/reference-services.rst
+40
View File
@@ -161,6 +161,28 @@ Service Definition Structure
:return: The protocol used by the service
.. member:: const char *(*obs_service_info.get_connect_info)(void *data, uint32_t type)
Output a service connection info related to a given type value:
- **OBS_SERVICE_CONNECT_INFO_SERVER_URL** - Server URL (0)
- **OBS_SERVICE_CONNECT_INFO_STREAM_ID** - Stream ID (2)
- **OBS_SERVICE_CONNECT_INFO_STREAM_KEY** - Stream key (alias of **OBS_SERVICE_CONNECT_INFO_STREAM_ID**)
- **OBS_SERVICE_CONNECT_INFO_USERNAME** - Username (4)
- **OBS_SERVICE_CONNECT_INFO_PASSWORD** - Password (6)
- **OBS_SERVICE_CONNECT_INFO_ENCRYPT_PASSPHRASE** - Encryption passphrase (8)
- Odd values as types are reserved for third-party protocols
Depending on the protocol, the service will have to provide information
to the output to be able to connect.
Irrelevant or unused types can return `NULL`.
General Service Functions
-------------------------
@@ -283,24 +305,36 @@ General Service Functions
:return: The URL currently used for this service
.. deprecated:: 29.1.0
Use :c:func:`obs_service_get_connect_info()` instead.
---------------------
.. function:: const char *obs_service_get_key(const obs_service_t *service)
:return: Stream key (if any) currently used for this service
.. deprecated:: 29.1.0
Use :c:func:`obs_service_get_connect_info()` instead.
---------------------
.. function:: const char *obs_service_get_username(const obs_service_t *service)
:return: User name (if any) currently used for this service
.. deprecated:: 29.1.0
Use :c:func:`obs_service_get_connect_info()` instead.
---------------------
.. function:: const char *obs_service_get_password(const obs_service_t *service)
:return: Password (if any) currently used for this service
.. deprecated:: 29.1.0
Use :c:func:`obs_service_get_connect_info()` instead.
---------------------
.. function:: void obs_service_apply_encoder_settings(obs_service_t *service, obs_data_t *video_encoder_settings, obs_data_t *audio_encoder_settings)
@@ -338,6 +372,12 @@ 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.
.. ---------------------------------------------------------------------------
.. _libobs/obs-service.h: https://github.com/obsproject/obs-studio/blob/master/libobs/obs-service.h