[asterisk-commits] tilghman: branch 1.4 r296990 - /branches/1.4/include/asterisk/frame.h

[SVN commits to the Asterisk project]

Author: tilghman
Date: Wed Dec  1 10:59:26 2010
New Revision: 296990

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=296990
Log:
Clarify documentation on how we store codec preference lists.

(closes issue #18397)
 Reported by: birgita

Modified:
    branches/1.4/include/asterisk/frame.h

Modified: branches/1.4/include/asterisk/frame.h
URL: http://svnview.digium.com/svn/asterisk/branches/1.4/include/asterisk/frame.h?view=diff&rev=296990&r1=296989&r2=296990
==============================================================================
--- branches/1.4/include/asterisk/frame.h (original)
+++ branches/1.4/include/asterisk/frame.h Wed Dec  1 10:59:26 2010
@@ -556,7 +556,15 @@
 /*! \brief Dump audio codec preference list into a string */
 int ast_codec_pref_string(struct ast_codec_pref *pref, char *buf, size_t size);
 
-/*! \brief Shift an audio codec preference list up or down 65 bytes so that it becomes an ASCII string */
+/*! \brief Shift an audio codec preference list up or down 65 bytes so that it becomes an ASCII string
+ * \note Due to a misunderstanding in how codec preferences are stored, this
+ * list starts at 'B', not 'A'.  For backwards compatibility reasons, this
+ * cannot change.
+ * \param pref A codec preference list structure
+ * \param buf A string denoting codec preference, appropriate for use in line transmission
+ * \param size Size of \a buf
+ * \param right Boolean:  if 0, convert from \a buf to \a pref; if 1, convert from \a pref to \a buf.
+ */
 void ast_codec_pref_convert(struct ast_codec_pref *pref, char *buf, size_t size, int right);
 
 /*! \brief Returns the number of samples contained in the frame */