doc: player: mention that get_pipeline method needs unref
authorRafostar <40623528+Rafostar@users.noreply.github.com>
Thu, 5 Nov 2020 08:11:03 +0000 (09:11 +0100)
committerGStreamer Merge Bot <gitlab-merge-bot@gstreamer-foundation.org>
Thu, 5 Nov 2020 08:57:51 +0000 (08:57 +0000)
All other methods in docs clearly mention that an unref is needed, so should `get_pipeline()`. #1450

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-bad/-/merge_requests/1764>

gst-libs/gst/player/gstplayer.c

index 04148fa1d1a371188cb4d6b0f092f228a6fd8e3b..45705c6710a3aeb510849867f403968d2c7497ee 100644 (file)
@@ -3680,7 +3680,9 @@ gst_player_set_mute (GstPlayer * self, gboolean val)
  * gst_player_get_pipeline:
  * @player: #GstPlayer instance
  *
- * Returns: (transfer full): The internal playbin instance
+ * Returns: (transfer full): The internal playbin instance.
+ *
+ * The caller should free it with g_object_unref()
  */
 GstElement *
 gst_player_get_pipeline (GstPlayer * self)