diff options
| author | dvossel <dvossel@f38db490-d61c-443f-a65b-d21fe96a405b> | 2010-04-29 16:27:24 +0000 |
|---|---|---|
| committer | dvossel <dvossel@f38db490-d61c-443f-a65b-d21fe96a405b> | 2010-04-29 16:27:24 +0000 |
| commit | 3ef0d2c9371b0d6e227d2dee2967a3106952af91 (patch) | |
| tree | 838ed3ee97b50e7571485a2da4467273cc128cf9 /include/asterisk | |
| parent | e2c9f611d8ef010f1162b8b5ff4df34835f7b5e6 (diff) | |
updates blocker fixes for RC
(closes issue 0017052)
Reported by: dvossel
Tested by: dvossel
(closes issue 0016196)
Reported by: atis
(closes issue 0017052)
Reported by: dvossel
Tested by: dvossel
git-svn-id: http://svn.digium.com/svn/asterisk/tags/1.6.1.19-rc3@260113 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'include/asterisk')
| -rw-r--r-- | include/asterisk/audiohook.h | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/include/asterisk/audiohook.h b/include/asterisk/audiohook.h index 5fb863ac0..a42d48fef 100644 --- a/include/asterisk/audiohook.h +++ b/include/asterisk/audiohook.h @@ -73,9 +73,16 @@ struct ast_audiohook; * \param chan Channel * \param frame Frame of audio to manipulate * \param direction Direction frame came from - * \return Returns 0 on success, -1 on failure - * \note An audiohook does not have any reference to a private data structure for manipulate types. It is up to the manipulate callback to store this data - * via it's own method. An example would be datastores. + * \return Returns 0 on success, -1 on failure. + * \note An audiohook does not have any reference to a private data structure for manipulate + * types. It is up to the manipulate callback to store this data via it's own method. + * An example would be datastores. + * \note The input frame should never be freed or corrupted during a manipulate callback. + * If the callback has the potential to corrupt the frame's data during manipulation, + * local data should be used for the manipulation and only copied to the frame on + * success. + * \note A failure return value indicates that the frame was not manipulated and that + * is being returned in its original state. */ typedef int (*ast_audiohook_manipulate_callback)(struct ast_audiohook *audiohook, struct ast_channel *chan, struct ast_frame *frame, enum ast_audiohook_direction direction); |