Mercurial > libavformat.hg

changeset 4616:5315c722e61e libavformat

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Document ff_rtp_codec_id()
author lucabe
date Sat, 28 Feb 2009 19:34:50 +0000
parents 12a7cd9178dd
children f04bc8b70940
files rtp.h
diffstat 1 files changed, 9 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/rtp.h	Sat Feb 28 18:35:53 2009 +0000
+++ b/rtp.h	Sat Feb 28 19:34:50 2009 +0000
@@ -57,6 +57,15 @@
  * the encoding name is returned
  */
 const char *ff_rtp_enc_name(int payload_type);
+
+/**
+ * Return the codec id for the given encoding name and codec type.
+ *
+ * @param buf A pointer to the string containing the encoding name
+ * @param codec_type The codec type
+ * @return In case of unknown encoding name, CODEC_ID_NONE is returned;
+ * otherwise, the codec id is returned
+ */
 enum CodecID ff_rtp_codec_id(const char *buf, enum CodecType codec_type);
 
 #define RTP_PT_PRIVATE 96