[svn-commits] tilghman: branch 1.6.2 r296991 - in /branches/1.6.2: ./ include/asterisk/frame.h

[SVN commits to the Digium repositories]

Author: tilghman
Date: Wed Dec  1 11:01:00 2010
New Revision: 296991

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=296991
Log:
Merged revisions 296990 via svnmerge from 
https://origsvn.digium.com/svn/asterisk/branches/1.4

........
  r296990 | tilghman | 2010-12-01 10:59:26 -0600 (Wed, 01 Dec 2010) | 5 lines
  
  Clarify documentation on how we store codec preference lists.
  
  (closes issue #18397)
   Reported by: birgita
........

Modified:
    branches/1.6.2/   (props changed)
    branches/1.6.2/include/asterisk/frame.h

Propchange: branches/1.6.2/
------------------------------------------------------------------------------
Binary property 'branch-1.4-merged' - no diff available.

Modified: branches/1.6.2/include/asterisk/frame.h
URL: http://svnview.digium.com/svn/asterisk/branches/1.6.2/include/asterisk/frame.h?view=diff&rev=296991&r1=296990&r2=296991
==============================================================================
--- branches/1.6.2/include/asterisk/frame.h (original)
+++ branches/1.6.2/include/asterisk/frame.h Wed Dec  1 11:01:00 2010
@@ -647,7 +647,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 */