@signalwire/realtime-api
Version:
SignalWire RealTime SDK for Node.js
58 lines • 2.37 kB
TypeScript
import type { CreateVoicePlaylistParams, VoicePlaylist, VoiceCallPlayParams, VoiceCallPlayAudioParams, VoiceCallPlayTTSParams, VoiceCallPlaySilenceParams, VoiceCallPlayRingtoneParams, VoicePlaylistAudioParams, VoicePlaylistTTSParams, VoicePlaylistSilenceParams, VoicePlaylistRingtoneParams } from '@signalwire/core';
/**
* A Playlist object allows you to specify a series of media which should be
* played in sequence. You can then pass the playlist to the methods that
* support it, for example {@link Call.play}.
*
* @example
*
* Creates a playlist for playing, in sequence, a TTS message, 1 second of
* silence, and an mp3 file.
*
* ```js
* const playlist = new Voice.Playlist({ volume: 1.0 })
* .add(Voice.Playlist.TTS({
* text: 'Welcome to SignalWire!',
* }))
* .add(Voice.Playlist.Silence({ duration: 1 }))
* .add(Voice.Playlist.Audio({
* url: 'https://cdn.signalwire.com/default-music/welcome.mp3'
* }))
* ```
*/
export declare class Playlist implements VoicePlaylist {
private params;
private _media;
constructor(params?: CreateVoicePlaylistParams);
/** Default volume for the audio in the playlist. */
get volume(): number | undefined;
/** The media in this playlist. */
get media(): import("@signalwire/core").NestedArray<VoiceCallPlayParams>;
/** Adds a new media to the playlist*/
add(params: VoiceCallPlayParams): this;
/**
* An audio media.
* @params params - {@link VoicePlaylistAudioParams}
* @returns - {@link VoiceCallPlayAudioParams}
**/
static Audio(params: VoicePlaylistAudioParams): VoiceCallPlayAudioParams;
/**
* A TTS media.
* @params params - {@link VoicePlaylistTTSParams}
* @returns - {@link VoiceCallPlayTTSParams}
**/
static TTS(params: VoicePlaylistTTSParams): VoiceCallPlayTTSParams;
/**
* A silence interval.
* @params params - {@link VoicePlaylistSilenceParams}
* @returns - {@link VoiceCallPlaySilenceParams}
**/
static Silence(params: VoicePlaylistSilenceParams): VoiceCallPlaySilenceParams;
/**
* A ringtone media.
* @params param - {@link VoicePlaylistRingtoneParams}
* @returns - {@link VoiceCallPlayRingtoneParams}
**/
static Ringtone(params: VoicePlaylistRingtoneParams): VoiceCallPlayRingtoneParams;
}
//# sourceMappingURL=Playlist.d.ts.map