From: Luca Abeni <lucabe72@email.it>
Date: Mon, 16 Feb 2009 10:21:14 +0000 (+0000)
Subject: Document ff_rtp_get_payload_type()
X-Git-Tag: v0.5~384
X-Git-Url: http://git.osdn.net/view?a=commitdiff_plain;h=b0a880b38b9625e9371c721e33e4c12704e04736;p=coroid%2Flibav_saccubus.git

Document ff_rtp_get_payload_type()

Originally committed as revision 17365 to svn://svn.ffmpeg.org/ffmpeg/trunk
---

diff --git a/libavformat/rtp.h b/libavformat/rtp.h
index 1347045f3..3d8b79acb 100644
--- a/libavformat/rtp.h
+++ b/libavformat/rtp.h
@@ -23,7 +23,14 @@
 
 #include "libavcodec/avcodec.h"
 
-/** return < 0 if unknown payload type */
+/**
+ * Return the payload type for a given codec.
+ *
+ * @param codec The context of the codec
+ * @return In case of unknown payload type or dynamic payload type, a
+ * negative value is returned; otherwise, the payload type (the 'PT' field
+ * in the RTP header) is returned.
+ */
 int ff_rtp_get_payload_type(AVCodecContext *codec);
 
 #define RTP_PT_PRIVATE 96