From 6c34de22b560c72ee36661ca09353b493a56e87b Mon Sep 17 00:00:00 2001 From: Matthew Jordan Date: Mon, 11 Aug 2014 01:31:31 +0000 Subject: 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 --- funcs/func_jitterbuffer.c | 42 +++++++++++++++++++++++++++--------------- 1 file changed, 27 insertions(+), 15 deletions(-) (limited to 'funcs/func_jitterbuffer.c') 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 - 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. - Jitterbuffer type can be fixed, adaptive, or - disabled. - Used as follows. - Set(JITTERBUFFER(type)=max_size[,resync_threshold[,target_extra]]) - Set(JITTERBUFFER(type)=default) + + + + + - max_size: Defaults to 200 ms - Length in milliseconds of buffer. - - resync_threshold: Defaults to 1000ms - The length in milliseconds over which a timestamp difference will result in resyncing the jitterbuffer. - - target_extra: Defaults to 40ms - This option only affects the adaptive jitterbuffer. It represents the amount time in milliseconds by which the new jitter buffer will pad its size. - + Jitterbuffers are constructed in two different ways. + The first always take three arguments: max_size, + resync_threshold, and target_extra. + Alternatively, a single argument of default can be provided, + which will construct the default jitterbuffer for the given + jitterbuffer type. + The arguments are: + max_size: Length in milliseconds of the buffer. + Defaults to 200 ms. + resync_threshold: The length in milliseconds over + which a timestamp difference will result in resyncing the jitterbuffer. + Defaults to 1000ms. + 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. exten => 1,1,Set(JITTERBUFFER(fixed)=default) -- cgit v1.2.3