Asterisk: The Future of Telephony, 2nd Edition

Name

ControlPlayback() — Plays a file, with the ability to fast forward and rewind the file

Synopsis

ControlPlayback(file[,skipms[,ff[,rew[,stop[,pause[,restart[,options]]]]]]])

Plays back a given file (without the file extension), while allowing the caller to move forward and backward through the file by pressing ff and rew keys. By default, you can use * and # to rewind and fast-forward the playback of the file, respectively.

The skipms option specifies how far forward or backward to jump in the file with each press of ff or rew.

If stop is specified, the application will stop playback when stop is pressed.

A pause argument may also be specified, which when pressed will pause playback of the file. Pressing pause again will continue the playback of the file.

If the restart parameter is specified, the specified key may be used to restart the playback of the file.

If the options parameter is set to j, and the file does not exist, the application jumps to priority n+101, if present (where n is the current priority number).

The ControlPlayback() application sets a channel variable named CPLAYBACKSTATUS upon completion. The CPLAYBACKSTATUS variable will be set to one of the following values:

SUCCESS

USERSTOPPED

ERROR

; allow the caller to control the playback of this file
exten => 123,1,ControlPlayback(tt-monkeys|3000|#|*|5|0)

See Also

Playback(), Background(), Dictate(),