Cloud call recording

LINE Planet provides the cloud call recording function, which performs recording of specific 1-to-1 calls on the cloud upon request. This page describes how to use the cloud call recording function through PlanetKit.

Supported call type	Minimum SDK version
1-to-1 call	5.2

Warning

To use the cloud call recording function, you must consult with the LINE Planet team in advance. If you want to use this function, please contact us.

Enable cloud call recording

Either caller or callee can enable cloud call recording during the call setup process.

Tip

To learn more about the 1-to-1 call setup flow, see 1-to-1 call flow.

Caller side

A caller can enable cloud call recording while making a call.

To enable cloud call recording on the caller side, set recordOnCloud to true while creating a PlanetKitCallParam object and call makeCall() with the PlanetKitCallParam object.

let param = PlanetKitCallParam(myUserId: myUserId, peerUserId: peerUserId, delegate: delegate, accessToken: accessToken, recordOnCloud: true)

let result = PlanetKitManager.shared.makeCall(param: param)

Callee side

A callee can enable cloud call recording while accepting a call.

To enable cloud call recording on the callee side, pass true to recordOnCloud when calling acceptCall().

// "call" is the verified call instance from the result of verifyCall().

call?.acceptCall(startMessage: callStartMessage, useResponderPreparation: useResponderPreparation, recordOnCloud: true)

Receive events related to cloud call recording

You can receive events related to cloud call recording, which deliver information such as the status of activation and the reason for deactivation.

When there is an update in the status of cloud call recording, the recordOnCloudDidUpdate callback is invoked. The updated: PlanetKitRecordOnCloudUpdatedParam parameter of recordOnCloudDidUpdate callback delivers the following information:

Parameter	Type	Description
activated	Bool	Indicates whether cloud call recording is activated or not.
deactivated	PlanetKitRecordOnCloudDeactivateReason	Expresses why cloud call recording is deactivated, which can be one of the following: internal: An internal error occurred. activationFailed: Recording failed on the cloud. Note: If activated is true, this parameter is not valid.

Related API

APIs related to cloud call recording are as follows.

• recordOnCloud of PlanetKitCallParam ^{iOS, macOS}
• makeCall() ^{iOS, macOS}
• acceptCall() ^{iOS, macOS}
• recordOnCloudDidUpdate ^{iOS, macOS}