aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authortilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b>2010-12-01 16:59:26 +0000
committertilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b>2010-12-01 16:59:26 +0000
commitd73d05741467423b25a7233afde44faa199a3c06 (patch)
treef2ba5c9455911eaca1b82ca6bece74cb8abff800
parente729643886ff967ae22a543dee531d0a77c1154e (diff)
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.4@296990 f38db490-d61c-443f-a65b-d21fe96a405b
-rw-r--r--include/asterisk/frame.h10
1 files changed, 9 insertions, 1 deletions
diff --git a/include/asterisk/frame.h b/include/asterisk/frame.h
index 645e4071d..5ded71fa8 100644
--- a/include/asterisk/frame.h
+++ b/include/asterisk/frame.h
@@ -556,7 +556,15 @@ void ast_parse_allow_disallow(struct ast_codec_pref *pref, int *mask, const char
/*! \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 */