control stream file filename escape_digits skipms ffchar rewchr pausechr offsetms
Send the given file, allowing playback to be controlled by the given digits, if any. Use double quotes for the digits if you wish none to be permitted. If offsetms is provided then the audio will seek to offsetms before play starts. Returns 0 if playback completes without a digit being pressed, or the ASCII numerical value of the digit if one was pressed, or -1 on error or if the channel was disconnected. Returns the position where playback was terminated as endpos.
It sets the following channel variables upon completion:
- CPLAYBACKSTATUS - Contains the status of the attempt as a text string
SUCCESSUSERSTOPPEDREMOTESTOPPEDERROR
- CPLAYBACKOFFSET - Contains the offset in ms into the file where playback was at when it stopped.
-1is end of file. - CPLAYBACKSTOPKEY - If the playback is stopped by the user this variable contains the key that was pressed.
filenamerequired - The file extension must not be included in the filename.escape_digitsrequiredskipmsffchar- Defaults to#rewchr- Defaults to*pausechroffsetms- Offset, in milliseconds, to start the audio playback
User Notes
No notes yet. Be the first to contribute a tip or example.
Contribute a note
Share a tip, gotcha, or practical example. Keep it under 2000 characters. No questions (use the Asterisk community forums for support). Wrap code in backticks.