[asterisk-commits] oej: trunk r47251 - /trunk/include/asterisk/frame.h

[asterisk-commits at lists.digium.com]

Author: oej
Date: Tue Nov  7 07:16:05 2006
New Revision: 47251

URL: http://svn.digium.com/view/asterisk?rev=47251&view=rev
Log:
Stealing Tilghman's explanation from the -dev list and producing documentation...

Modified:
    trunk/include/asterisk/frame.h

Modified: trunk/include/asterisk/frame.h
URL: http://svn.digium.com/view/asterisk/trunk/include/asterisk/frame.h?rev=47251&r1=47250&r2=47251&view=diff
==============================================================================
--- trunk/include/asterisk/frame.h (original)
+++ trunk/include/asterisk/frame.h Tue Nov  7 07:16:05 2006
@@ -450,6 +450,19 @@
  */
 char *ast_codec2str(int codec);
 
+/*! \page ast_smooth
+The ast_smoother interface was designed specifically
+to take frames of variant sizes and produce frames of a single expected
+size, precisely what you want to do.
+
+The basic interface is:
+
+- Initialize with ast_smoother_new()
+- Queue input frames with ast_smoother_feed()
+- Get output frames with ast_smoother_read()
+- when you're done, free the structure with ast_smoother_free()
+- Also see ast_smoother_test_flag(), ast_smoother_set_flags(), ast_smoother_get_flags(), ast_smoother_reset()
+*/
 struct ast_smoother;
 
 struct ast_format_list *ast_get_format_list_index(int index);