stream: small documentation clarification
authorXavier Claessens <xavier.claessens@collabora.com>
Thu, 21 Jul 2016 03:05:09 +0000 (23:05 -0400)
committerSebastian Dröge <sebastian@centricular.com>
Mon, 5 Sep 2016 10:25:57 +0000 (13:25 +0300)
https://bugzilla.gnome.org/show_bug.cgi?id=766612

gst/rtsp-server/rtsp-stream.c

index 081fc14..33242a4 100644 (file)
@@ -932,7 +932,9 @@ gst_rtsp_stream_get_multicast_iface (GstRTSPStream * stream)
  * @stream: a #GstRTSPStream
  * @family: the #GSocketFamily
  *
- * Get the multicast address of @stream for @family.
+ * Get the multicast address of @stream for @family. The original
+ * #GstRTSPAddress is cached and copy is returned, so freeing the return value
+ * won't release the address from the pool.
  *
  * Returns: (transfer full) (nullable): the #GstRTSPAddress of @stream
  * or %NULL when no address could be allocated. gst_rtsp_address_free()
@@ -998,7 +1000,9 @@ no_address:
  * @n_ports: n_ports
  * @ttl: a TTL
  *
- * Reserve @address and @port as the address and port of @stream.
+ * Reserve @address and @port as the address and port of @stream. The original
+ * #GstRTSPAddress is cached and copy is returned, so freeing the return value
+ * won't release the address from the pool.
  *
  * Returns: (nullable): the #GstRTSPAddress of @stream or %NULL when
  * the address could be reserved. gst_rtsp_address_free() after usage.