rtsp-onvif-media-factory: Document that backchannel pipelines must end with async...

https://bugzilla.gnome.org/show_bug.cgi?id=794143

diff --git a/gst/rtsp-server/rtsp-onvif-media-factory.c b/gst/rtsp-server/rtsp-onvif-media-factory.c
index f242608..7da5670 100644 (file)
--- a/gst/rtsp-server/rtsp-onvif-media-factory.c
+++ b/gst/rtsp-server/rtsp-onvif-media-factory.c
@@ -375,6 +375,11 @@ gst_rtsp_onvif_media_factory_init (GstRTSPOnvifMediaFactory * factory)
  * all possible, complete RTP caps that are going to be supported. At least
  * the payload type, clock-rate and encoding-name need to be specified.
  *
+ * Note: The pipeline part passed here must end in sinks that are not waiting
+ * until pre-rolling before reaching the PAUSED state, i.e. setting
+ * async=false on #GstBaseSink. Otherwise the whole media will not be able to
+ * prepare.
+ *
  * Since: 1.14
  */
 void