Added ICE-CONTROLLING and ICE-CONTROLLED STUN attribute types

git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@1114 74dad513-b988-da41-8d7b-12977e46ad98

1 files changed, 12 insertions, 5 deletions

diff --git a/pjmedia/include/pjmedia/rtp.h b/pjmedia/include/pjmedia/rtp.h
index 5b7b8e64..f41cda05 100644
--- a/pjmedia/include/pjmedia/rtp.h
+++ b/pjmedia/include/pjmedia/rtp.h
@@ -77,7 +77,8 @@ PJ_BEGIN_DECL
 
 
 /**
- * RTP packet header.
+ * RTP packet header. Note that all RTP functions here will work with this
+ * header in network byte order.
  */
 #pragma pack(1)
 struct pjmedia_rtp_hdr
@@ -229,7 +230,7 @@ typedef struct pjmedia_rtp_status pjmedia_rtp_status;
  *
  * @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.
  */
@@ -262,11 +263,16 @@ PJ_DECL(pj_status_t) pjmedia_rtp_encode_rtp( pjmedia_rtp_session *ses,
  * The decode function is guaranteed to point the payload to the correct 
  * 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.
  * @param payloadlen	Upon return will indicate the size of the payload.
@@ -285,7 +291,8 @@ PJ_DECL(pj_status_t) pjmedia_rtp_decode_rtp( pjmedia_rtp_session *ses,
  * calculations.
  *
  * @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.
  */