From: Thibault Saunier <tsaunier@igalia.com>
Date: Mon, 15 Jun 2020 17:09:39 +0000 (-0400)
Subject: pipeline: doc: Add a note about trying to render before setting rendering settings
X-Git-Tag: 1.19.3~493^2~138
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=ba6c8428310ee18e104eeb73421e2a9551285dc2;p=platform%2Fupstream%2Fgstreamer.git

pipeline: doc: Add a note about trying to render before setting rendering settings

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-editing-services/-/merge_requests/189>
---

diff --git a/ges/ges-pipeline.c b/ges/ges-pipeline.c
index b4c56f6..19fc004 100644
--- a/ges/ges-pipeline.c
+++ b/ges/ges-pipeline.c
@@ -1086,7 +1086,7 @@ ges_pipeline_set_render_settings (GESPipeline * pipeline,
   CHECK_THREAD (pipeline);
 
   /*  FIXME Properly handle multi track, for now GESPipeline
-   *  only hanles single track per type, so we should just set the
+   *  only handles single track per type, so we should just set the
    *  presence to 1.
    */
   if (GST_IS_ENCODING_CONTAINER_PROFILE (profile)) {
@@ -1179,9 +1179,14 @@ ges_pipeline_get_mode (GESPipeline * pipeline)
  *
  * Sets the #GESPipeline:mode of the pipeline.
  *
- * Note that the pipeline will be set to #GST_STATE_NULL during this call
- * to perform the necessary changes. You will need to set the state again
- * yourself after calling this.
+ * Note that the pipeline will be set to #GST_STATE_NULL during this call to
+ * perform the necessary changes. You will need to set the state again yourself
+ * after calling this.
+ *
+ * > **NOTE**: [Rendering settings](ges_pipeline_set_render_settings) need to be
+ * > set before setting @mode to #GES_PIPELINE_MODE_RENDER or
+ * > #GES_PIPELINE_MODE_SMART_RENDER, the call to this method will fail
+ * > otherwise.
  *
  * Returns: %TRUE if the mode of @pipeline was successfully set to @mode.
  **/