aboutsummaryrefslogtreecommitdiffstats
path: root/include/asterisk/channel.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/asterisk/channel.h')
-rw-r--r--include/asterisk/channel.h21
1 files changed, 14 insertions, 7 deletions
diff --git a/include/asterisk/channel.h b/include/asterisk/channel.h
index d022a8816..e24e72a6f 100644
--- a/include/asterisk/channel.h
+++ b/include/asterisk/channel.h
@@ -725,19 +725,26 @@ struct ast_channel * attribute_malloc __attribute__((format(printf, 12, 13)))
__FILE__, __LINE__, __FUNCTION__, __VA_ARGS__)
/*!
- * \brief Queue an outgoing frame
+ * \brief Queue one or more frames to a channel's frame queue
*
- * \note The channel does not need to be locked before calling this function.
+ * \param chan the channel to queue the frame(s) on
+ * \param f the frame(s) to queue. Note that the frame(s) will be duplicated
+ * by this function. It is the responsibility of the caller to handle
+ * freeing the memory associated with the frame(s) being passed if
+ * necessary.
+ *
+ * \retval 0 success
+ * \retval non-zero failure
*/
int ast_queue_frame(struct ast_channel *chan, struct ast_frame *f);
/*!
- * \brief Queue an outgoing frame to the head of the frame queue
+ * \brief Queue one or more frames to the head of a channel's frame queue
*
- * \param chan the channel to queue the frame on
- * \param f the frame to queue. Note that this frame will be duplicated by
- * this function. It is the responsibility of the caller to handle
- * freeing the memory associated with the frame being passed if
+ * \param chan the channel to queue the frame(s) on
+ * \param f the frame(s) to queue. Note that the frame(s) will be duplicated
+ * by this function. It is the responsibility of the caller to handle
+ * freeing the memory associated with the frame(s) being passed if
* necessary.
*
* \retval 0 success