summaryrefslogtreecommitdiff
path: root/apps/app_controlplayback.c
diff options
context:
space:
mode:
authorRussell Bryant <russell@russellbryant.com>2005-11-11 13:34:38 +0000
committerRussell Bryant <russell@russellbryant.com>2005-11-11 13:34:38 +0000
commit78d740290a7504f93b692f30173c51429818d30d (patch)
tree1c9f2eab32d3bd593c0c9254ea70fb5790a5c8fa /apps/app_controlplayback.c
parent91b616c9ba0ca0754df4297ff4d7bc6be00428c5 (diff)
more cleanups to application descriptions
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@7072 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'apps/app_controlplayback.c')
-rwxr-xr-xapps/app_controlplayback.c28
1 files changed, 16 insertions, 12 deletions
diff --git a/apps/app_controlplayback.c b/apps/app_controlplayback.c
index 6cd577d7f..dab0c156c 100755
--- a/apps/app_controlplayback.c
+++ b/apps/app_controlplayback.c
@@ -48,18 +48,22 @@ static const char *app = "ControlPlayback";
static const char *synopsis = "Play a file with fast forward and rewind";
static const char *descrip =
-"ControlPlayback(filename[|skipms[|ffchar[|rewchar[|stopchar[|pausechar[|restartchar[|option]]]]]]]):\n"
-" Plays back a given filename (do not put extension). Options may also\n"
-" be included following a pipe symbol. You can use * and # to rewind and\n"
-" fast forward the playback specified. If 'stopchar' is added the file will\n"
-" terminate playback when 'stopchar' is pressed. If 'restartchar' is added, the file\n"
-" will restart when 'restartchar' is pressed.\n"
-" The option string may contain the following character:\n"
-" 'j' -- jump to +101 priority if the file requested isn't found.\n"
-" This application sets the following channel variable upon completion:\n"
-" CPLAYBACKSTATUS The status of the attempt as a text string, one of\n"
-" SUCCESS | USERSTOPPED | ERROR\n"
-" Example: exten => 1234,1,ControlPlayback(file|4000|*|#|1|0|5)\n\n";
+" ControlPlayback(file[|skipms[|ff[|rew[|stop[|pause[|restart|options]]]]]]]):\n"
+"This application will play back the given filename. By default, the '*' key\n"
+"can be used to rewind, and the '#' key can be used to fast-forward.\n"
+"Parameters:\n"
+" skipms - This is number of milliseconds to skip when rewinding or\n"
+" fast-forwarding.\n"
+" ff - Fast-forward when this DTMF digit is received.\n"
+" rew - Rewind when this DTMF digit is received.\n"
+" stop - Stop playback when this DTMF digit is received.\n"
+" pause - Pause playback when this DTMF digit is received.\n"
+" restart - Restart playback when this DTMF digit is received.\n"
+"Options:\n"
+" j - Jump to priority n+101 if the requested file is not found.\n"
+"This application sets the following channel variable upon completion:\n"
+" CPLAYBACKSTATUS - This variable contains the status of the attempt as a text\n"
+" string, one of: SUCCESS | USERSTOPPED | ERROR\n";
STANDARD_LOCAL_USER;