playRingtone

View as Markdown

playRingtone

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

Plays a ringtone.

Parameters

NameTypeDescription
paramsObject-
params.duration?numberDuration of ringtone to play. Defaults to 1 ringtone iteration.
params.nameRingtoneNameThe name of the ringtone.
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.playRingtone({ name: "it" });
2await playback.ended();