[farsight2/master] Improve transmitter documentation a bit

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


---
 .../multicast/fs-multicast-stream-transmitter.c    |    5 +++--
 transmitters/rawudp/fs-rawudp-stream-transmitter.c |    7 ++++---
 2 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/transmitters/multicast/fs-multicast-stream-transmitter.c b/transmitters/multicast/fs-multicast-stream-transmitter.c
index a9ee72f..91a9d8d 100644
--- a/transmitters/multicast/fs-multicast-stream-transmitter.c
+++ b/transmitters/multicast/fs-multicast-stream-transmitter.c
@@ -51,8 +51,9 @@
  *
  * <para>
  * It will only listen to and send from the IP specified in the
- * prefered-local-candidates. There can be only one prefered candidate per
- * component.
+ * prefered-local-candidates. There can be only one preferred candidate per
+ * component. Only the component_id and the ip will be used from the preferred
+ * local candidates, everything else is ignored.
  * </para>
  *
  * <para>
diff --git a/transmitters/rawudp/fs-rawudp-stream-transmitter.c b/transmitters/rawudp/fs-rawudp-stream-transmitter.c
index 86d1c3a..7b19018 100644
--- a/transmitters/rawudp/fs-rawudp-stream-transmitter.c
+++ b/transmitters/rawudp/fs-rawudp-stream-transmitter.c
@@ -55,11 +55,12 @@
  * </para>
  *
  * <para>
- * Example: Candidate {proto=UDP, component=RTP, ip=NULL, port=9098} will
+ * Example: Candidate {proto=UDP, component_id=RTP, ip=NULL, port=9098} will
  *  produce native candidates
- * ({component=RTP, ip=IP, port=9078}, {component=RTCP, ip=IP, port=9079}) or
+ * ({component_id=RTP, ip=IP, port=9078}, {component_id=RTCP, ip=IP, port=9079})
+ *  or
  * if this one is not available
- * ({component=RTP, ip=IP, port=9080}, {component=RTCP, ip=IP, port=9081}).
+ * ({component_id=RTP, ip=IP, port=9080},{component_id=RTCP, ip=IP, port=9081}).
  * The default port starts at 7078 for the first component.
  * </para>
  * </refsect2>
-- 
1.5.6.5




More information about the farsight-commits mailing list