stream file filename escape_digits sample offset
Description
Send the given file, allowing playback to be interrupted by the given digits, if any. 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. If musiconhold is playing before calling stream file it will be automatically stopped and will not be restarted after completion.
It sets the following channel variables upon completion:
- PLAYBACKSTATUS - The status of the playback attempt as a text string.
SUCCESSFAILED
Arguments
filenamerequired - File name to play. The file extension must not be included in the filename.escape_digitsrequired - Use double quotes for the digits if you wish none to be permitted.sample offset- If sample offset is provided then the audio will seek to sample offset before play starts.
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.
Related
AGI Commands
ANSWER
ASYNCAGI BREAK
CHANNEL STATUS
CONTROL STREAM FILE
DATABASE DEL
DATABASE DELTREE
DATABASE GET
DATABASE PUT
EXEC
GET DATA
GET FULL VARIABLE
GET OPTION
GET VARIABLE
GOSUB
HANGUP
NOOP
RECEIVE CHAR
RECEIVE TEXT
RECORD FILE
SAY ALPHA
SAY DATE
SAY DATETIME
SAY DIGITS
SAY NUMBER
SAY PHONETIC
SAY TIME
SEND IMAGE
SEND TEXT
SET AUTOHANGUP
SET CALLERID
SET CONTEXT
SET EXTENSION
SET MUSIC
SET PRIORITY
SET VARIABLE
SPEECH ACTIVATE GRAMMAR
SPEECH CREATE
SPEECH DEACTIVATE GRAMMAR
SPEECH DESTROY
SPEECH LOAD GRAMMAR
SPEECH RECOGNIZE
SPEECH SET
SPEECH UNLOAD GRAMMAR
STREAM FILE
TDD MODE
VERBOSE
WAIT FOR DIGIT