diff options
Diffstat (limited to 'doc/README.externalivr')
| -rwxr-xr-x | doc/README.externalivr | 21 |
1 files changed, 17 insertions, 4 deletions
diff --git a/doc/README.externalivr b/doc/README.externalivr index ff4ff12c7..a1d4757e7 100755 --- a/doc/README.externalivr +++ b/doc/README.externalivr @@ -46,7 +46,7 @@ All events will be newline-terminated strings. Events send to the child's stdin will be in the following format: -tag,timestamp +tag,timestamp[,data] The tag can be one of the following characters: @@ -57,6 +57,11 @@ A-D: DTMF event for keys A through D H: the channel was hung up by the connected party Z: the previous command was unable to be executed (file does not exist, etc.) +T: the play list was interrupted (see below) +D: a file was dropped from the play list due to interruption (the +data element will be the dropped file name) +F: a file has finished playing (the data element will be the file +name) The timestamp will be 10 digits long, and will be a decimal representation of a standard Unix epoch-based timestamp. @@ -71,13 +76,17 @@ The child process can send commands on stdout in the following formats: S,filename A,filename H,message +O,option The 'S' command checks to see if there is a playable audio file with the specified name, and if so, clear's the generator's playlist and places the file onto the list. Note that the playability check does not take into account transcoding requirements, so it is possible for the file to not be played even though it was found. If the file cannot -be found, a 'Z' event (see above) will be sent to the child. +be found, a 'Z' event (see above) will be sent to the child. If the +generator is not currently playing silence, then T and D events will +be sent to the child to signal the playlist interruption and notify +it of the files that will not be played. The 'A' command checks to see if there is a playable audio file with the specified name, and if so, adds it to the generator's @@ -87,10 +96,14 @@ playlist. The same playability and exception rules apply as for the The 'H' command stops the generator and hangs up the channel, and logs the supplied message to the Asterisk log. +The 'O' command allows the child to set/clear options in the +ExternalIVR() application. The supported options are: + autoclear/noautoclear: + Automatically interrupt and clear the playlist upon reception + of DTMF input. + Errors ------ Any newline-terminated output generated by the child process on its stderr handle will be copied into the Asterisk log. - - |