Relay.Calling.PlayAction

Relay.Calling.PlayAction

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

Properties

Methods

pause

Pause the playback immediately.

Parameters

None

Returns

coroutine - Coroutine that will return a Relay.Calling.PlayPauseResult object.

Examples

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

1
import asyncio # to use sleep
2
3
action = await call.play_audio_async('https://cdn.signalwire.com/default-music/welcome.mp3')
4
await asyncio.sleep(5)
5
pause_result = await action.pause()

resume

Resume the playback immediately.

Parameters

None

Returns

coroutine - Coroutine that will return a Relay.Calling.PlayResumeResult object.

Examples

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

1
import asyncio # to use sleep
2
3
action = await call.play_audio_async('https://cdn.signalwire.com/default-music/welcome.mp3')
4
await asyncio.sleep(5)
5
pause_result = await action.pause()
6
await asyncio.sleep(5)
7
resume_result = await action.resume()

stop

Stop the action immediately.

Parameters

None

Returns

coroutine - Coroutine that will return a Relay.Calling.StopResult object.

Examples

Play an Mp3 file and stop it after 5 seconds:

1
import asyncio # to use sleep
2
3
action = await call.play_audio_async('https://cdn.signalwire.com/default-music/welcome.mp3')
4
await asyncio.sleep(5)
5
await action.stop()

volume

Control the volume of the playback.

Parameters

Returns

coroutine - Coroutine that will return a Relay.Calling.PlayVolumeResult object.

Examples

Start playing an audio file and increase the playback volume:

1
action = await call.play_audio_async('https://cdn.signalwire.com/default-music/welcome.mp3')
2
result = await action.volume(5.0)