kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-11-16 14:58:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

add some doxygen docs

Browse Source 
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@6945 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Kevin P. Fleming
2005-11-02 18:08:33 +00:00
parent 5f50e4cb93
commit 150ff6393b
2 changed files with 30 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
ChangeLog
View File

@@ -1,5 +1,7 @@
2005-11-02 Kevin P. Fleming <kpfleming@digium.com> 2005-11-02 Kevin P. Fleming <kpfleming@digium.com>
* include/asterisk/channel.h: add doxygen docs for silence generator APIs
* channel.c (ast_channel_bridge): simplify native-bridge return logic, remove 'unsuccessful' message since it causes too many questions :-) * channel.c (ast_channel_bridge): simplify native-bridge return logic, remove 'unsuccessful' message since it causes too many questions :-)
2005-11-01 Kevin P. Fleming <kpfleming@digium.com> 2005-11-01 Kevin P. Fleming <kpfleming@digium.com>

28
include/asterisk/channel.h
View File

@@ -1101,8 +1101,36 @@ struct ast_frame *ast_channel_spy_read_frame(struct ast_channel_spy *spy, unsign
*/ */
void ast_channel_spy_trigger_wait(struct ast_channel_spy *spy); void ast_channel_spy_trigger_wait(struct ast_channel_spy *spy);
/*!
\brief An opaque 'object' structure use by silence generators on channels.
*/
struct ast_silence_generator; struct ast_silence_generator;
/*!
\brief Starts a silence generator on the given channel.
\param chan The channel to generate silence on
\return An ast_silence_generator pointer, or NULL if an error occurs
This function will cause SLINEAR silence to be generated on the supplied
channel until it is disabled; if the channel cannot be put into SLINEAR
mode then the function will fail.
The pointer returned by this function must be preserved and passed to
ast_channel_stop_silence_generator when you wish to stop the silence
generation.
*/
struct ast_silence_generator *ast_channel_start_silence_generator(struct ast_channel *chan); struct ast_silence_generator *ast_channel_start_silence_generator(struct ast_channel *chan);
/*!
\brief Stops a previously-started silence generator on the given channel.
\param chan The channel to operate on
\param state The ast_silence_generator pointer return by a previous call to
ast_channel_start_silence_generator.
\return nothing
This function will stop the operating silence generator and return the channel
to its previous write format.
*/
void ast_channel_stop_silence_generator(struct ast_channel *chan, struct ast_silence_generator *state); void ast_channel_stop_silence_generator(struct ast_channel *chan, struct ast_silence_generator *state);
/* Misc. functions below */ /* Misc. functions below */