docs: mention gst_parse_bin_from_description() in gst_parse_launch() docs
authorTim-Philipp Müller <tim@centricular.com>
Wed, 27 Nov 2019 09:41:36 +0000 (09:41 +0000)
committerTim-Philipp Müller <tim@centricular.com>
Wed, 27 Nov 2019 09:41:36 +0000 (09:41 +0000)
gst/gstparse.c

index 9f976372fc79335974c104da9ee6ecbcd31a3988..5cb2e0888e7f1c4ae7bcf61b3d84d903ee0af7eb 100644 (file)
@@ -291,6 +291,9 @@ gst_parse_launchv_full (const gchar ** argv, GstParseContext * context,
  * the @error is set. In this case there was a recoverable parsing error and you
  * can try to play the pipeline.
  *
+ * To create a sub-pipeline (bin) for embedding into an existing pipeline
+ * use gst_parse_bin_from_description().
+ *
  * Returns: (transfer floating) (nullable): a new element on success, %NULL on
  *   failure. If more than one toplevel element is specified by the
  *   @pipeline_description, all elements are put into a #GstPipeline, which
@@ -316,6 +319,9 @@ gst_parse_launch (const gchar * pipeline_description, GError ** error)
  * the @error is set. In this case there was a recoverable parsing error and you
  * can try to play the pipeline.
  *
+ * To create a sub-pipeline (bin) for embedding into an existing pipeline
+ * use gst_parse_bin_from_description_full().
+ *
  * Returns: (transfer floating) (nullable): a new element on success, %NULL on
  *    failure. If more than one toplevel element is specified by the
  *    @pipeline_description, all elements are put into a #GstPipeline, which