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:37:47 -0600 |
| commit | 36bdd7c1a0f8508312420abffb220d60946b25ff (patch) | |
| tree | 1a5e334857ff84a6805a5c04ff5f5e1040462fe4 | |
| parent | f517c015e244f54a94a10b419163425c8131d497 (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
| -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 bcd31deaa..7e05a282b 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 8188eb8eb..5c7990945 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; |