Mercurial > libavformat.hg

diff rtp.h @ 4503:c3d058b6ddde libavformat

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Document ff_rtp_get_payload_type()
author lucabe
date Mon, 16 Feb 2009 10:21:14 +0000
parents daca5391106a
children 35d76826b641
line wrap: on
line diff
--- a/rtp.h	Mon Feb 16 09:36:21 2009 +0000
+++ b/rtp.h	Mon Feb 16 10:21:14 2009 +0000
@@ -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