diff options
author | tilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b> | 2010-12-01 17:01:56 +0000 |
---|---|---|
committer | tilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b> | 2010-12-01 17:01:56 +0000 |
commit | cb9ecef1b87a225d3dd559a20affceb8f6b344b2 (patch) | |
tree | 929c088a666527f768a766b869208867bac7e27e /include/asterisk | |
parent | 45a06641f4dec228f98ee377394469dd14795b0a (diff) |
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/branches/1.8@296992 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'include/asterisk')
-rw-r--r-- | include/asterisk/frame.h | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/include/asterisk/frame.h b/include/asterisk/frame.h index c16a3c150..728178ab5 100644 --- a/include/asterisk/frame.h +++ b/include/asterisk/frame.h @@ -708,7 +708,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 */ |