summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavier Claessens <xavier.claessens@collabora.com>2016-07-20 23:05:09 -0400
committerSebastian Dröge <sebastian@centricular.com>2016-10-25 15:53:49 +0300
commitb51d7a62a6712b1dffc4f8cc468d690bc000629b (patch)
tree1e4869747841df9bfd707eed0289cedc911a686e
parentf0d07afa0e13c9d12fc1674233e2daf3cd7d3eb3 (diff)
stream: small documentation clarification
https://bugzilla.gnome.org/show_bug.cgi?id=766612
-rw-r--r--gst/rtsp-server/rtsp-stream.c8
1 files changed, 6 insertions, 2 deletions
diff --git a/gst/rtsp-server/rtsp-stream.c b/gst/rtsp-server/rtsp-stream.c
index 1835de2..a3317d0 100644
--- a/gst/rtsp-server/rtsp-stream.c
+++ b/gst/rtsp-server/rtsp-stream.c
@@ -866,7 +866,9 @@ gst_rtsp_stream_get_address_pool (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()
@@ -932,7 +934,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.