Mercurial > libavformat.hg

changeset 4613:0642f8079ecf libavformat

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Document ff_rtp_enc_name()
author lucabe
date Sat, 28 Feb 2009 18:21:43 +0000
parents 259725e31ef1
children b4c4ee906a60
files rtp.h
diffstat 1 files changed, 10 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/rtp.h	Sat Feb 28 17:31:25 2009 +0000
+++ b/rtp.h	Sat Feb 28 18:21:43 2009 +0000
@@ -46,6 +46,16 @@
  * negative value is returned; otherwise, 0 is returned
  */
 int ff_rtp_get_codec_info(AVCodecContext *codec, int payload_type);
+
+/**
+ * Return the encoding name (as defined in
+ * http://www.iana.org/assignments/rtp-parameters) for a given payload type.
+ *
+ * @param payload_type The payload type (the 'PT' field in the RTP header)
+ * @return In case of unknown payload type or dynamic payload type, a pointer
+ * to an empty string is returned; otherwise, a pointer to a string containing
+ * the encoding name is returned
+ */
 const char *ff_rtp_enc_name(int payload_type);
 enum CodecID ff_rtp_codec_id(const char *buf, enum CodecType codec_type);