opusenc: improve inband-fec property documentation

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/2853>

diff --git a/subprojects/gst-plugins-base/docs/plugins/gst_plugins_cache.json b/subprojects/gst-plugins-base/docs/plugins/gst_plugins_cache.json
index c4afc36..b8c0164 100644 (file)
--- a/subprojects/gst-plugins-base/docs/plugins/gst_plugins_cache.json
+++ b/subprojects/gst-plugins-base/docs/plugins/gst_plugins_cache.json
@@ -7870,7 +7870,7 @@
                         "writable": true
                     },
                     "inband-fec": {
-                        "blurb": "Enable forward error correction",
+                        "blurb": "Enable in-band forward error correction (use in combination with the packet-loss-percentage property)",
                         "conditionally-available": false,
                         "construct": false,
                         "construct-only": false,

diff --git a/subprojects/gst-plugins-base/ext/opus/gstopusenc.c b/subprojects/gst-plugins-base/ext/opus/gstopusenc.c
index 805ccd7..6f1fc2b 100644 (file)
--- a/subprojects/gst-plugins-base/ext/opus/gstopusenc.c
+++ b/subprojects/gst-plugins-base/ext/opus/gstopusenc.c
@@ -325,7 +325,8 @@ gst_opus_enc_class_init (GstOpusEncClass * klass)
           GST_PARAM_MUTABLE_PLAYING));
   g_object_class_install_property (gobject_class, PROP_INBAND_FEC,
       g_param_spec_boolean ("inband-fec", "In-band FEC",
-          "Enable forward error correction", DEFAULT_INBAND_FEC,
+          "Enable in-band forward error correction (use in combination with "
+          "the packet-loss-percentage property)", DEFAULT_INBAND_FEC,
           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
           GST_PARAM_MUTABLE_PLAYING));
   g_object_class_install_property (gobject_class, PROP_DTX,