[farsight2/master] Improve the documentation of some functions, make it clear that the src-pad-added signal is called on the streaming thread

Olivier Crête olivier.crete at collabora.co.uk
Tue Dec 23 15:20:02 PST 2008


---
 gst-libs/gst/farsight/fs-stream.c      |    5 ++++-
 gst/fsrtpconference/fs-rtp-stream.c    |    2 ++
 gst/fsrtpconference/fs-rtp-substream.c |    7 +++++++
 3 files changed, 13 insertions(+), 1 deletions(-)

diff --git a/gst-libs/gst/farsight/fs-stream.c b/gst-libs/gst/farsight/fs-stream.c
index 1dffb1e..1c48607 100644
--- a/gst-libs/gst/farsight/fs-stream.c
+++ b/gst-libs/gst/farsight/fs-stream.c
@@ -296,9 +296,12 @@ fs_stream_class_init (FsStreamClass *klass)
    * This signal is emitted when a new gst source pad has been created for a
    * specific codec being received. There will be a different source pad for
    * each codec that is received. The user must ref the #GstPad if he wants to
-   * use it. The user should not modify the #FsCodec and must copy it if he
+   * keep it. The user should not modify the #FsCodec and must copy it if he
    * wants to use it outside the callback scope.
    *
+   * This signal is not emitted on the main thread, but on GStreamer's streaming
+   * thread!
+   *
    */
   signals[SRC_PAD_ADDED] = g_signal_new ("src-pad-added",
       G_TYPE_FROM_CLASS (klass),
diff --git a/gst/fsrtpconference/fs-rtp-stream.c b/gst/fsrtpconference/fs-rtp-stream.c
index 8f0971d..5e5c9c5 100644
--- a/gst/fsrtpconference/fs-rtp-stream.c
+++ b/gst/fsrtpconference/fs-rtp-stream.c
@@ -544,6 +544,8 @@ fs_rtp_stream_transmitter_error (
  * @substream: the #FsRtpSubStream to associate with this stream
  *
  * This functions associates a substream with this stream
+ *
+ * Returns: TRUE on success, FALSE on failure
  */
 gboolean
 fs_rtp_stream_add_substream (FsRtpStream *stream,
diff --git a/gst/fsrtpconference/fs-rtp-substream.c b/gst/fsrtpconference/fs-rtp-substream.c
index 599b39c..9601b27 100644
--- a/gst/fsrtpconference/fs-rtp-substream.c
+++ b/gst/fsrtpconference/fs-rtp-substream.c
@@ -344,6 +344,8 @@ _blocked_cb (GstPad *pad, gboolean blocked, gpointer user_data)
  * fs_rtp_sub_stream_block:
  *
  * Blocks the src pad of this new substream until
+ *
+ * MT safe.
  */
 
 void
@@ -478,6 +480,11 @@ fs_rtp_sub_stream_new (FsRtpConference *conference,
   return substream;
 }
 
+/**
+ * fs_rtp_sub_stream_stop:
+ *
+ * Stops all of the elements on a #FsRtpSubstream
+ */
 
 void
 fs_rtp_sub_stream_stop (FsRtpSubStream *substream)
-- 
1.5.6.5




More information about the farsight-commits mailing list