prefix webrtc_instance by type, unify naming

This commit is contained in:
B. Petersen
2020-07-22 17:24:40 +02:00
parent f3b9f671ba
commit 39364d1f6c
8 changed files with 32 additions and 23 deletions

View File

@@ -318,9 +318,11 @@ char* dc_get_blobdir (const dc_context_t* context);
* The library uses the `media_quality` setting to use different defaults
* for recoding images sent with type DC_MSG_IMAGE.
* If needed, recoding other file types is up to the UI.
* - `webrtc_instance` = address to webrtc instance to use for videochats,
* eg. a server as of https://github.com/cracker0dks/basicwebrtc.
* Format: https://example.com/subdir#roomname=$ROOM
* - `webrtc_instance` = webrtc instance to use for videochats in the form
* `[basicwebrtc:]https://example.com/subdir#roomname=$ROOM`
* if the url is prefixed by `basicwebrtc`, the server is assumed to be of the type
* https://github.com/cracker0dks/basicwebrtc which some UIs have native support for.
* If no type is prefixed, the videochat is handled completely in a browser.
*
* If you want to retrieve a value, use dc_get_config().
*