Convert the RTPQOS function to just be additional parameter of the CHANNEL

function.  This way, it will be possible for other RTP based channel drivers
to expose this information in the future.


git-svn-id: http://svn.digium.com/svn/asterisk/branches/1.4@59256 f38db490-d61c-443f-a65b-d21fe96a405b

1 files changed, 30 insertions, 12 deletions

diff --git a/funcs/func_channel.c b/funcs/func_channel.c
index 9c02a59fa..9184cf955 100644
--- a/funcs/func_channel.c
+++ b/funcs/func_channel.c
@@ -149,18 +149,36 @@ static struct ast_custom_function channel_function = {
 	.syntax = "CHANNEL(item)",
 	.desc = "Gets/set various pieces of information about the channel.\n"
 		"Standard items (provided by all channel technologies) are:\n"
-		"R/O	audioreadformat		format currently being read\n"
-		"R/O	audionativeformat 	format used natively for audio\n"
-		"R/O	audiowriteformat 	format currently being written\n"
-		"R/W	callgroup		call groups for call pickup\n"
-		"R/O	channeltype		technology used for channel\n"
-		"R/W	language 		language for sounds played\n"
-		"R/W	musicclass 		class (from musiconhold.conf) for hold music\n"
-		"R/W	rxgain			set rxgain level on channel drivers that support it\n"
-		"R/O	state			state for channel\n"
-		"R/W	tonezone 		zone for indications played\n"
-		"R/W	txgain			set txgain level on channel drivers that support it\n"
-		"R/O	videonativeformat 	format used natively for video\n"
+		"R/O	audioreadformat    format currently being read\n"
+		"R/O	audionativeformat  format used natively for audio\n"
+		"R/O	audiowriteformat   format currently being written\n"
+		"R/W	callgroup          call groups for call pickup\n"
+		"R/O	channeltype        technology used for channel\n"
+		"R/W	language           language for sounds played\n"
+		"R/W	musicclass         class (from musiconhold.conf) for hold music\n"
+		"R/W	rxgain             set rxgain level on channel drivers that support it\n"
+		"R/O	state              state for channel\n"
+		"R/W	tonezone           zone for indications played\n"
+		"R/W	txgain             set txgain level on channel drivers that support it\n"
+		"R/O	videonativeformat  format used natively for video\n"
+		"\n"
+		"chan_sip provides the following additional options:\n"
+		"R/O    rtpqos             Get QOS information about the RTP stream\n"
+		"       This option takes two additional arguments:\n"
+		"  Argument 1:\n"
+		"    audio                 Get data about the audio stream\n"
+		"    video                 Get data about the video stream\n"
+		"  Argument 2:\n"
+		"    local_ssrc            Local SSRC (stream ID)\n"
+		"    local_lostpackets     Local lost packets\n"
+		"    local_jitter          Local calculated jitter\n"
+		"    local_count           Number of received packets\n"
+		"    remote_ssrc           Remote SSRC (stream ID)\n"
+		"    remote_lostpackets    Remote lost packets\n"
+		"    remote_jitter         Remote reported jitter\n"
+		"    remote_count          Number of transmitted packets\n"
+		"    rtt                   Round trip time\n"
+		"    all                   All statistics (in a form suited to logging, but not for parsing)\n"
 		"\n"
 		"Additional items may be available from the channel driver providing\n"
 		"the channel; see its documentation for details.\n"