Wipple CPaaS
Menu
Functions / Dub

Dub

{
  "verb": "dub",
  "action": "addTrack",
  "track": "ambient-noise",
},
{
  "verb": "dub",
  "action": "playOnTrack",
  "track": "ambient-noise",
  "play": "https://example.com/sounds/office-hubbub.mp3"
}

Function properties for the dub command:

Parameters

actionstringrequired

One of 'addTrack', 'removeTrack', 'silenceTrack', 'playOnTrack', or 'sayOnTrack'.


gainstring

A string value in the format "-6 dB" specifying decibels to boost or reduce the strength of the audio signal
(note: simple integer values accepted as well). The value supplied must be between ±50 dB.


loopboolean

If true, loop the mp3.


playstring

An http(s) URL to an mp3 file to play into the track.


saystring

Text to convert to audio and play into the track.


trackstringrequired

Label for the track.


The various options are:

  • addTrack adds an audio track to the conversation; once added, the play or say command may be used to inject audio into the track
  • removeTrack removes an audio track from the conversation
  • silenceTrack silences an audio track but leaves it in place
  • playOnTrack plays audio from an http(s) mp3 url into the audio track
  • sayOnTrack generates text-to-speech into the audio track

Note: all tracks are automatically removed when the call completes, so if using an additional track for the entire conversation there is no need to explicitly remove it when the call ends.

Note: for convenience the addTrack and playOnTrack operations may be combined into a single addTrack Function; e.g.:

  {
    "verb": "dub",
    "action": "addTrack",
    "track": "ambient-noise",
    "play": "https://example.com/sounds/office-hubbub.mp3",
    "loop": true,
    "gain": "-10 dB"
  }