Relay.Calling.RecordAction

View as Markdown

Relay.Calling.RecordAction

This object returned from record_async method that represents a recording currently active on a call.

Properties

PropertyTypeDescription
resultRelay.Calling.RecordResultFinal result of recording.
statestringCurrent state of recording.
completedbooleanWhether the recording has finished.
payloaddictPayload sent to Relay to start recording.
control_idstringUUID to identify the recording.

Methods

stop

Stop the action immediately.

Parameters

None

Returns

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

Examples

Start recording the call and stop it after 10 seconds:

1import asyncio # to use sleep
2
3action = await call.record_async(stereo=True)
4await asyncio.sleep(10)
5await action.stop()