6.1.2.15. ControlPlayback (dialplan application)
1. ControlPlayback - this application allows you to play and control a sound file.
NOTE: This application is valid for Asterisk version 1.0.9 and above.
Syntax:
Purpose and usage
Prerequisites
Asterisk PBX configurations
2. Screenshots of what you can see on the CLI of the Asterisk PBX
3. Additional information
4. Similar dialplan applications
NOTE: This application is valid for Asterisk version 1.0.9 and above.
Syntax:
ControlPlayback(filename[|skip[|fforwardkey[|rewindkey[|stopkey[|pausekey]]]]])
Purpose and usage
With this application you can play a sound file. You can also control it by using the keyboard of the phone. You can forward, rewind, stop and pause the message.
We will show you a simple example below.
We will show you a simple example below.
Prerequisites
To use this application you need a working Asterisk PBX with registered users in iax.conf, sip.conf or mgcp.conf(It depends on which protocol you would like to use) and made extensions.
To see how the application works we recommend to use our IAX softphone Idefisk. You can download it from here. Please also read our tutorial to learn how to configure it to work with Asterisk PBX.
To see how the application works we recommend to use our IAX softphone Idefisk. You can download it from here. Please also read our tutorial to learn how to configure it to work with Asterisk PBX.
Asterisk PBX configurations
NOTE: This is only an example of what for you can use this application. Of course you can use it and for other things.
We need two registered users in iax.conf file. This is because we are going to use the IAX2 protocol. If you want to use other protocol such as SIP or MGCP, you have to do the configurations below respectively in sip.conf or mgcp.conf.
We need two registered users in iax.conf file. This is because we are going to use the IAX2 protocol. If you want to use other protocol such as SIP or MGCP, you have to do the configurations below respectively in sip.conf or mgcp.conf.
So, we have registered the users anatoliy and user1
Type=friend means that this user can make and receive calls. Host=dynamic means that the IP is not static but dynamic through a DHCP server. Allow=all means that the line which this user will use, could support all audio codecs. Context=test - this shows that this user is working with the extensions in this context of the configuration file extensions.conf.
Type=friend means that this user can make and receive calls. Host=dynamic means that the IP is not static but dynamic through a DHCP server. Allow=all means that the line which this user will use, could support all audio codecs. Context=test - this shows that this user is working with the extensions in this context of the configuration file extensions.conf.
On the picture above you can see our extensions.conf file.
In our example when somebody dials 222, the call will be answered by the Answer application. Then the caller will hear the sound file. In our example the file is demo-instruct. Then the call will be connected to the user user1 through the IAX2 channel.
Now, lets take a look at the arguments of the ControlPlayback application. The first option, separated from the filename by the "|" character, is with how many ms the sound file will go forward or rewind, when you press the corresponding key.
With the next argument you can set the key for the fast forwarding operation. By default this key is set to the "*"(asterisk key). In our case we have set it to 3. This argument is separated from the previous again with the "|" character.
With the third argument you can set the key for the rewind operation. By default this key is set to the "#"(pound key). In our case we have set it to 1. This argument is separated from the previous again with the "|" character.
With the fourth argument you can set the key for the stop operation. This argument is separated from the previous again with the "|" character.
With the last argument you can set the key for the pause operation. In our case this is 2. This argument is separated from the previous again with the "|" character.
About the sound files - the directory where the application will try to find the files by default is /var/lib/asterisk/sounds. It cannot be changed.
NOTE: Please, pay attention that the name of the sound file is written without the extension. For example: You have to write trading-desk, not trading-desk.gsm
In our example when somebody dials 222, the call will be answered by the Answer application. Then the caller will hear the sound file. In our example the file is demo-instruct. Then the call will be connected to the user user1 through the IAX2 channel.
Now, lets take a look at the arguments of the ControlPlayback application. The first option, separated from the filename by the "|" character, is with how many ms the sound file will go forward or rewind, when you press the corresponding key.
With the next argument you can set the key for the fast forwarding operation. By default this key is set to the "*"(asterisk key). In our case we have set it to 3. This argument is separated from the previous again with the "|" character.
With the third argument you can set the key for the rewind operation. By default this key is set to the "#"(pound key). In our case we have set it to 1. This argument is separated from the previous again with the "|" character.
With the fourth argument you can set the key for the stop operation. This argument is separated from the previous again with the "|" character.
With the last argument you can set the key for the pause operation. In our case this is 2. This argument is separated from the previous again with the "|" character.
About the sound files - the directory where the application will try to find the files by default is /var/lib/asterisk/sounds. It cannot be changed.
NOTE: Please, pay attention that the name of the sound file is written without the extension. For example: You have to write trading-desk, not trading-desk.gsm
2. Screenshots of what you can see on the CLI of the Asterisk PBX
3. Additional information
For more information about extensions.conf you can check here.
For more information about iax.conf you can check here.
This application is tested with our IAX softphone Idefisk. You can download it from here. For more information about this softphone please read our tutorial.
If you would like to test this application with the SIP channel you can read our tutorials about the SIP Softphones to learn how to configure them to work with Asterisk PBX
For more information about iax.conf you can check here.
This application is tested with our IAX softphone Idefisk. You can download it from here. For more information about this softphone please read our tutorial.
If you would like to test this application with the SIP channel you can read our tutorials about the SIP Softphones to learn how to configure them to work with Asterisk PBX
4. Similar dialplan applications
| Add Comment |
Latest Headlines:
-
T.38 faxing with Zoiper 2.15 is now easier than ever
section: voip software
-
Asterisk 1.4.21 Released
section: Asterisk
-
Asterisk 1.4.20 Released
section: Asterisk
-
Asterisk 1.4.20-rc2 Released
section: Asterisk
-
Asterisk 1.4.20-rc1 Now Available
section: Asterisk
- News Archives (older news)
Latest Tutorials:
-
Sending Fax from Zoiper to Zoiper using T.38
added 08/Dec/2008 18:16
-
VMAuthenticate (dialplan application)
added 01/Mar/2008 15:57
-
Siptronic ST-530
added 06/Nov/2007 17:57
-
Siemens C455 IP hardphone
added 05/Nov/2007 10:24
-
Zoiper
added 22/Oct/2007 17:53
Latest Comments:
-
https://git-ce.rwth-aachen.de/mbd/kiste_...
tutorial: Basic Information
-
https://git-ce.rwth-aachen.de/mbd/kiste_...
tutorial: Basic Information
-
https://www.thebeachlittlehampton.co.uk/...
tutorial: Digium Wildcard TE405 / Wildcard TE410P
-
https://www.viessmann-community.com/t5/R...
tutorial: Asterisk Installation
-
https://d2l.msu.edu/d2l/eP/presentations...
tutorial: Asterisk Realtime configuration