From 9947461351942e3b4189817e92e2a9941676ca5d Mon Sep 17 00:00:00 2001 From: tilghman Date: Wed, 1 Dec 2010 17:03:05 +0000 Subject: [PATCH] Merged revisions 296992 via svnmerge from https://origsvn.digium.com/svn/asterisk/branches/1.8 ................ r296992 | tilghman | 2010-12-01 11:01:56 -0600 (Wed, 01 Dec 2010) | 19 lines Merged revisions 296991 via svnmerge from https://origsvn.digium.com/svn/asterisk/branches/1.6.2 ................ r296991 | tilghman | 2010-12-01 11:01:00 -0600 (Wed, 01 Dec 2010) | 12 lines 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 ........ ................ ................ git-svn-id: http://svn.digium.com/svn/asterisk/trunk@296993 f38db490-d61c-443f-a65b-d21fe96a405b --- include/asterisk/frame.h | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/include/asterisk/frame.h b/include/asterisk/frame.h index b9eb75bd1..0d8fc0b22 100644 --- a/include/asterisk/frame.h +++ b/include/asterisk/frame.h @@ -714,7 +714,15 @@ int ast_parse_allow_disallow(struct ast_codec_pref *pref, format_t *mask, const /*! \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 */