rtpbin: clarify the ntp-sync option
authorWim Taymans <wim.taymans@collabora.co.uk>
Wed, 17 Oct 2012 11:35:07 +0000 (13:35 +0200)
committerWim Taymans <wim.taymans@collabora.co.uk>
Wed, 17 Oct 2012 11:35:07 +0000 (13:35 +0200)
gst/rtpmanager/gstrtpbin.c

index d27946d..4d8e54e 100644 (file)
@@ -1805,9 +1805,11 @@ gst_rtp_bin_class_init (GstRtpBinClass * klass)
   /**
    * GstRtpBin::ntp-sync:
    *
-   * Synchronize received streams to the NTP clock. When the NTP clock is shared
-   * between the receivers and the senders (such as when using ntpd) this option
-   * can be used to synchronize receivers on multiple machines.
+   * Set the NTP time from the sender reports as the running-time on the
+   * buffers. When both the sender and receiver have sychronized
+   * running-time, i.e. when the clock and base-time is shared
+   * between the receivers and the and the senders, this option can be
+   * used to synchronize receivers on multiple machines.
    *
    * Since: 0.10.21
    */