diff options
| author | Richard Mudgett <rmudgett@digium.com> | 2017-01-10 17:48:39 -0600 |
|---|---|---|
| committer | Richard Mudgett <rmudgett@digium.com> | 2017-01-24 13:36:51 -0600 |
| commit | 1484a991e17bb3320fbf8d1cfbe92d7ba5d6ea01 (patch) | |
| tree | 761000e6a215e815ca4e1b99c12b74cf974ac6b3 /include/asterisk | |
| parent | 48178e5918967337624a7e43ff1d84a7bb63fa85 (diff) | |
Add notes about embedded ast_frame structs holding a format ref.
mod_format.h: Note ast_filestream.fr holds a format ref.
translate.h: Note ast_trans_pvt.f holds a format ref.
Change-Id: I86bda354d725207b41e08920355d7c31b2d7f749
Diffstat (limited to 'include/asterisk')
| -rw-r--r-- | include/asterisk/mod_format.h | 6 | ||||
| -rw-r--r-- | include/asterisk/translate.h | 2 |
2 files changed, 6 insertions, 2 deletions
diff --git a/include/asterisk/mod_format.h b/include/asterisk/mod_format.h index 7f17741fa..d76be5eca 100644 --- a/include/asterisk/mod_format.h +++ b/include/asterisk/mod_format.h @@ -114,7 +114,11 @@ struct ast_filestream { int lasttimeout; struct ast_channel *owner; FILE *f; - struct ast_frame fr; /*!< frame produced by read, typically */ + /*! + * \brief frame produced by read, typically + * \note This frame holds a fr.subclass.format ref. + */ + struct ast_frame fr; char *buf; /*!< buffer pointed to by ast_frame; */ void *_private; /*!< pointer to private buffer */ const char *orig_chan_name; diff --git a/include/asterisk/translate.h b/include/asterisk/translate.h index e2a4f300f..ce46cd083 100644 --- a/include/asterisk/translate.h +++ b/include/asterisk/translate.h @@ -208,7 +208,7 @@ struct ast_translator { */ struct ast_trans_pvt { struct ast_translator *t; - struct ast_frame f; /*!< used in frameout */ + struct ast_frame f; /*!< used in frameout. This frame holds a f.subclass.format ref. */ int samples; /*!< samples available in outbuf */ /*! \brief actual space used in outbuf */ int datalen; |