diff options
| author | Matthew Jordan <mjordan@digium.com> | 2014-08-11 01:31:31 +0000 |
|---|---|---|
| committer | Matthew Jordan <mjordan@digium.com> | 2014-08-11 01:31:31 +0000 |
| commit | 6c34de22b560c72ee36661ca09353b493a56e87b (patch) | |
| tree | 40b5a8587ea44e6f6ad09ace23b1f3ac5abb0b6f /funcs | |
| parent | 95871451f638203e8d76049221cbad0cbc930dbf (diff) | |
funcs/func_jitterbuffer: Tweak documentation
This patch merely reformats and cleans up a bit of the jitterbuffer
documentation for the wiki.
git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/13@420639 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'funcs')
| -rw-r--r-- | funcs/func_jitterbuffer.c | 42 |
1 files changed, 27 insertions, 15 deletions
diff --git a/funcs/func_jitterbuffer.c b/funcs/func_jitterbuffer.c index 0b57caf6e..e33b2c23a 100644 --- a/funcs/func_jitterbuffer.c +++ b/funcs/func_jitterbuffer.c @@ -45,27 +45,39 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") /*** DOCUMENTATION <function name="JITTERBUFFER" language="en_US"> <synopsis> - Add a Jitterbuffer to the Read side of the channel. This dejitters the audio stream before it reaches the Asterisk core. This is a write only function. + Add a Jitterbuffer to the Read side of the channel. This dejitters the audio stream before it reaches the Asterisk core. This is a write only function. </synopsis> <syntax> <parameter name="jitterbuffer type" required="true"> - <para>Jitterbuffer type can be <literal>fixed</literal>, <literal>adaptive</literal>, or - <literal>disabled</literal>.</para> - <para>Used as follows. </para> - <para>Set(JITTERBUFFER(type)=max_size[,resync_threshold[,target_extra]])</para> - <para>Set(JITTERBUFFER(type)=default) </para> + <optionlist> + <option name="fixed"> + <para>Set a fixed jitterbuffer on the channel.</para> + </option> + <option name="adaptive"> + <para>Set an adaptive jitterbuffer on the channel.</para> + </option> + <option name="disabled"> + <para>Remove a previously set jitterbuffer from the channel.</para> + </option> + </optionlist> </parameter> </syntax> <description> - <para>max_size: Defaults to 200 ms</para> - <para>Length in milliseconds of buffer.</para> - <para> </para> - <para>resync_threshold: Defaults to 1000ms </para> - <para>The length in milliseconds over which a timestamp difference will result in resyncing the jitterbuffer. </para> - <para> </para> - <para>target_extra: Defaults to 40ms</para> - <para>This option only affects the adaptive jitterbuffer. It represents the amount time in milliseconds by which the new jitter buffer will pad its size.</para> - <para> </para> + <para>Jitterbuffers are constructed in two different ways. + The first always take three arguments: <replaceable>max_size</replaceable>, + <replaceable>resync_threshold</replaceable>, and <replaceable>target_extra</replaceable>. + Alternatively, a single argument of <literal>default</literal> can be provided, + which will construct the default jitterbuffer for the given + <replaceable>jitterbuffer type</replaceable>.</para> + <para>The arguments are:</para> + <para><replaceable>max_size</replaceable>: Length in milliseconds of the buffer. + Defaults to 200 ms.</para> + <para><replaceable>resync_threshold</replaceable>: The length in milliseconds over + which a timestamp difference will result in resyncing the jitterbuffer. + Defaults to 1000ms.</para> + <para>target_extra: This option only affects the adaptive jitterbuffer. It represents + the amount time in milliseconds by which the new jitter buffer will pad its size. + Defaults to 40ms.</para> <example title="Fixed with defaults" language="text"> exten => 1,1,Set(JITTERBUFFER(fixed)=default) </example> |