Relay::Calling::RecordAction
This object is returned by the record!
method and represents a recording that is currently active on a call.
Properties
Property | Type | Description |
---|---|---|
result | Relay::Calling::RecordResult | Final result of recording. |
state | String | Current state of recording. |
completed | Boolean | Whether the recording has finished. |
payload | Hash | Payload sent to Relay to start recording. |
controlId | String | UUID to identify the recording. |
url | String | Url of the recording. The file may not be present until the recording is finished. |
Methods
stop
Stop the action immediately.
Parameters
None
Returns
Relay::Calling::StopResult
- A StopResult
object with a successful
property.