Skip to main content

Relay::Calling::RecordAction

This object is returned by the record! method and represents a recording that is currently active on a call.

Properties

PropertyTypeDescription
resultRelay::Calling::RecordResultFinal result of recording.
stateStringCurrent state of recording.
completedBooleanWhether the recording has finished.
payloadHashPayload sent to Relay to start recording.
controlIdStringUUID to identify the recording.
urlStringUrl 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.