Relay.Calling.PlayAction

This object returned from one of asynchronous play methods that represents a playing currently active on a call.

Properties

Property	Type	Description
`result`	`Relay.Calling.PlayResult`	Final result of playing
`state`	`string`	Current state of playing
`completed`	`boolean`	Whether the playing has finished
`payload`	`object`	Payload sent to Relay to start playing
`controlId`	`string`	UUID to identify the playing

Methods

pause

Pause the playback immediately.

Parameters

None

Returns

Promise<PlayPauseResult> - Promise object that will be fulfilled with a Relay.Calling.PlayPauseResult object.

Examples

Start playing an audio file and pause it after 5 seconds.

1 // Promise to wait some seconds..
2 const sleep = (seconds) => new Promise(resolve => setTimeout(resolve, seconds*1000))
3 
4 async function main() {
5   const playAction = await call.playAudioAsync('https://cdn.signalwire.com/default-music/welcome.mp3')
6   await sleep(5)
7   const pauseResult = await playAction.pause()
8 }
9 
10 main().catch(console.error)

resume

Resume the playback immediately.

Parameters

None

Returns

Promise<PlayResumeResult> - Promise object that will be fulfilled with a Relay.Calling.PlayResumeResult object.

Examples

Start playing an audio file, stop it and then resume it after 5 seconds.

1 // Promise to wait some seconds..
2 const sleep = (seconds) => new Promise(resolve => setTimeout(resolve, seconds*1000))
3 
4 async function main() {
5   const playAction = await call.playAudioAsync('https://cdn.signalwire.com/default-music/welcome.mp3')
6   await sleep(5)
7   const pauseResult = await playAction.pause()
8   await sleep(5)
9   const resumeResult = await playAction.resume()
10 }
11 
12 main().catch(console.error)

stop

Stop the action immediately.

Parameters

None

Returns

Promise<StopResult> - Promise object that will be fulfilled with a Relay.Calling.StopResult object.

Examples

Start playing an audio file and stop it after 5 seconds.

1 async function main() {
2   const playAction = await call.playAudioAsync('https://cdn.signalwire.com/default-music/welcome.mp3')
3 
4   setTimeout(async () => {
5     const stopResult = await playAction.stop()
6   }, 5000)
7 }
8 
9 main().catch(console.error)

volume

Control the volume of the playback.

Parameters

Parameter	Type	Required	Description
`volume`	`number`	✓	Volume value between -40dB and +40dB where 0 is unchanged

Returns

Promise<PlayVolumeResult> - Promise object that will be fulfilled with a Relay.Calling.PlayVolumeResult object.

Examples

Start playing an audio file and increase the playback volume.

1 async function main() {
2   const playAction = await call.playAudioAsync('https://cdn.signalwire.com/default-music/welcome.mp3')
3   const volumeResult = await playAction.volume(5.0)
4 }
5 
6 main().catch(console.error)