mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-23 08:46:40 +00:00
Code Issues 1 Projects Releases Wiki Activity

webrtcbin: Improve documentation of 'turn-server' property

Browse source 
Description about how to set time-limited credentials is added.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3229>
This commit is contained in:
Sangchul Lee 2022-10-19 16:03:55 +09:00 committed by GStreamer Marge Bot
parent 09fc6f14f3
commit 0f05be382b
2 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
subprojects/gst-plugins-bad/docs/plugins/gst_plugins_cache.json
View file

@ -230714,7 +230714,7 @@
"writable": true
},
"turn-server": {
"blurb": "The TURN server of the form turn(s)://username:password@host:port. This is a convenience property, use #GstWebRTCBin::add-turn-server if you wish to use multiple TURN servers",
"blurb": "The TURN server of the form turn(s)://username:password@host:port. To use time-limited credentials, the form must be turn(s)://timestamp:username:password@host:port. Please note that the ':' character of the 'timestamp:username' and the 'password' encoded by base64 should be escaped to be parsed properly. This is a convenience property, use #GstWebRTCBin::add-turn-server if you wish to use multiple TURN servers",
"conditionally-available": false,
"construct": false,
"construct-only": false,

4
subprojects/gst-plugins-bad/ext/webrtc/gstwebrtcbin.c
View file

@ -8402,6 +8402,10 @@ gst_webrtc_bin_class_init (GstWebRTCBinClass * klass)
PROP_TURN_SERVER,
g_param_spec_string ("turn-server", "TURN Server",
"The TURN server of the form turn(s)://username:password@host:port. "
"To use time-limited credentials, the form must be turn(s)://timestamp:"
"username:password@host:port. Please note that the ':' character of "
"the 'timestamp:username' and the 'password' encoded by base64 should "
"be escaped to be parsed properly. "
"This is a convenience property, use #GstWebRTCBin::add-turn-server "
"if you wish to use multiple TURN servers",
NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));