diff --git a/src/modules/rtpengine/doc/rtpengine_admin.xml b/src/modules/rtpengine/doc/rtpengine_admin.xml index 9866f15fe04..9b358e1573a 100644 --- a/src/modules/rtpengine/doc/rtpengine_admin.xml +++ b/src/modules/rtpengine/doc/rtpengine_admin.xml @@ -2888,6 +2888,45 @@ stop_media("from-tag=5yqaeriguhxcikxj"); +
+ + <function moreinfo="none">play_dtmf([flags])</function> + + + Injects a DTMF event into the media stream. Depending on which codecs were + negotiated, this either injects an RFC 2833/4733 DTMF event, or an in-band PCM + DTMF tone into the audio stream. The flag inject DTMF must have + been present in both offer and answer messages when the call was established, + which forces all audio to go through rtpengine's transcoding engine. + + + Usage is similar to play_media with the following exceptions. + The selected party is not the party that will receive the DTMF event, but rather + the party which is generating the event. This is to support DTMF + events that are carried in &sip; INFO messages. Instead of specifying a media file, + a DTMF event code must be specified, as well as optionally a duration and the volume. + The code can be a number 0 through 15, or a DTMF digit (0-9, A-D, *, #). + The duration is specified in milliseconds and defaults to 250, within + a range of 100-5000. The volume is specified in absolute decibels, with + a default of -8 db. + + + Multiple consecutive DTMF events can be queued up by calling this function multiple + times consecutively. Rtpengine will play out the DTMF events in sequence, separated + by a default pause of 100 ms. An alternative pause length can be given through the + pause option, between 100 and 5000 ms. + + + <function>play_dtmf</function> usage + +... +play_dtmf("from-tag=5yqaeriguhxcikxj code=#"); +play_dtmf("code=1 volume=5 duration=300 pause=150"); +... + + +
+