From 0f05be382bddfde7f1f0109b96ac1d358c5abff0 Mon Sep 17 00:00:00 2001 From: Sangchul Lee Date: Wed, 19 Oct 2022 16:03:55 +0900 Subject: [PATCH] webrtcbin: Improve documentation of 'turn-server' property Description about how to set time-limited credentials is added. Part-of: --- .../gst-plugins-bad/docs/plugins/gst_plugins_cache.json | 2 +- subprojects/gst-plugins-bad/ext/webrtc/gstwebrtcbin.c | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/subprojects/gst-plugins-bad/docs/plugins/gst_plugins_cache.json b/subprojects/gst-plugins-bad/docs/plugins/gst_plugins_cache.json index dbc2b8236f..5cca7207f2 100644 --- a/subprojects/gst-plugins-bad/docs/plugins/gst_plugins_cache.json +++ b/subprojects/gst-plugins-bad/docs/plugins/gst_plugins_cache.json @@ -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, diff --git a/subprojects/gst-plugins-bad/ext/webrtc/gstwebrtcbin.c b/subprojects/gst-plugins-bad/ext/webrtc/gstwebrtcbin.c index 54a8c8853f..7167b86b55 100644 --- a/subprojects/gst-plugins-bad/ext/webrtc/gstwebrtcbin.c +++ b/subprojects/gst-plugins-bad/ext/webrtc/gstwebrtcbin.c @@ -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));