playAudio

View as Markdown

playAudio

  • playAudio(params): Promise<CallPlayback> - See CallPlayback for more details.

Plays an audio file.

Parameters

NameTypeDescription
paramsObject-
params.urlstringHTTP(s) URL to an audio resource to play.
params.volume?numberVolume value between -40dB and +40dB where 0 is unchanged. Default is 0.

Returns

Promise<CallPlayback> - See CallPlayback for more details.

Example

1const playback = await call.playAudio({
2 url: "https://cdn.signalwire.com/default-music/welcome.mp3",
3});
4await playback.ended();