Browse code

Document ff_rtp_get_payload_type()

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

Luca Abeni authored on 2009/02/16 19:21:14
Showing 1 changed files
... ...
@@ -23,7 +23,14 @@
23 23
 
24 24
 #include "libavcodec/avcodec.h"
25 25
 
26
-/** return < 0 if unknown payload type */
26
+/**
27
+ * Return the payload type for a given codec.
28
+ *
29
+ * @param codec The context of the codec
30
+ * @return In case of unknown payload type or dynamic payload type, a
31
+ * negative value is returned; otherwise, the payload type (the 'PT' field
32
+ * in the RTP header) is returned.
33
+ */
27 34
 int ff_rtp_get_payload_type(AVCodecContext *codec);
28 35
 
29 36
 #define RTP_PT_PRIVATE 96