Changeset 1114 for pjproject/trunk/pjmedia/include/pjmedia/rtp.h

Timestamp:

Mar 29, 2007 9:54:21 PM (17 years ago)

Author:

bennylp

Message:

Added ICE-CONTROLLING and ICE-CONTROLLED STUN attribute types

File:

• pjproject/trunk/pjmedia/include/pjmedia/rtp.h (modified) (4 diffs)

pjproject/trunk/pjmedia/include/pjmedia/rtp.h

@@ -78 +78 @@
 
 /**
- * RTP packet header.
+ * RTP packet header. Note that all RTP functions here will work with this
+ * header in network byte order.
  */
 #pragma pack(1)
@@ -230 +231 @@
  * @param ses           The session.
  * @param default_pt    Default payload type.
- * @param sender_ssrc   SSRC used for outgoing packets.
+ * @param sender_ssrc   SSRC used for outgoing packets, in host byte order.
  *
  * @return              PJ_SUCCESS if successfull.
@@ -263 +264 @@
  * position regardless of any options present in the RTP packet.
  *
+ * Note that this function does not modify the returned RTP header to
+ * host byte order.
+ *
  * @param ses           The session.
  * @param pkt           The received RTP packet.
  * @param pkt_len       The length of the packet.
- * @param hdr           Upon return will point to the location of the RTP header
- *                      inside the packet.
+ * @param hdr           Upon return will point to the location of the RTP 
+ *                      header inside the packet. Note that the RTP header
+ *                      will be given back as is, meaning that the fields
+ *                      will be in network byte order.
  * @param payload       Upon return will point to the location of the
  *                      payload inside the packet.
@@ -286 +292 @@
  *
  * @param ses       The session.
- * @param hdr       The RTP header of the incoming packet.
+ * @param hdr       The RTP header of the incoming packet. The header must
+ *                  be given with fields in network byte order.
  * @param seq_st    Optional structure to receive the status of the RTP packet
  *                  processing.