From 0c14a92c28744449cd32f6f2a34e956f2fad2a0d Mon Sep 17 00:00:00 2001
From: Philippe Normand <philn@igalia.com>
Date: Sun, 7 Jan 2018 14:45:37 +0000
Subject: [PATCH] player: doc update for set_subtitle_uri()

A call to this function without enabling the subtitle track has no effect.
---
 gst-libs/gst/player/gstplayer.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/gst-libs/gst/player/gstplayer.c b/gst-libs/gst/player/gstplayer.c
index 2b324267c0..8dac3e9f85 100644
--- a/gst-libs/gst/player/gstplayer.c
+++ b/gst-libs/gst/player/gstplayer.c
@@ -3503,7 +3503,9 @@ gst_player_set_uri (GstPlayer * self, const gchar * val)
  * @player: #GstPlayer instance
  * @uri: subtitle URI
  *
- * Sets the external subtitle URI.
+ * Sets the external subtitle URI. This should be combined with a call to
+ * gst_player_set_subtitle_track_enabled(@player, TRUE) so the subtitles are actually
+ * rendered.
  */
 void
 gst_player_set_subtitle_uri (GstPlayer * self, const gchar * suburi)