Skip to main content
Version: 5.5

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 typeMinimum SDK version
1-to-1 call5.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, call SetRecordOnCloud(true) on a MakeCallParam object and call MakeCall() with the MakeCallParam object.

PlanetKit::PlanetKitCallPtr pPlanetKitCall;
PlanetKit::MakeCallParamPtr pMakeCallParam = PlanetKit::MakeCallParam::CreateWithAccessToken(
    myId, peerId, accessToken
);
pMakeCallParam->SetRecordOnCloud(true);

PlanetKit::PlanetKitManagerPtr pPlanetKitManager = PlanetKit::PlanetKitManager::GetInstance();
PlanetKit::SStartResult sStartResult = pPlanetKitManager->MakeCall(pMakeCallParam, &pPlanetKitCall);

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 bRecordOnCloud when calling AcceptCall().

// The `pPlanetKitCall` variable is the verified `PlanetKitCall` instance.

pPlanetKitCall->AcceptCall(bPreparation, pCallStartMessage, PLNK_INITIAL_MY_VIDEO_STATE_RESUME, true);

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 OnRecordOnCloudUpdated callback is invoked. To get the information related to the status of cloud call recording, use the following methods on the pRecordOnCloud parameter of the OnRecordOnCloudUpdated callback.

MethodReturn value typeDescription
IsActivated()boolGets the state of cloud call recording.
GetDeactivatedReason()DeactivateReasonOptionalGets the reason why cloud call recording is deactivated, which can be one of the following:
  • PLNK_RECORD_ON_CLOUD_DEACTIVATE_REASON_INTERNAL: An internal error occurred.
  • PLNK_RECORD_ON_CLOUD_DEACTIVATE_REASON_ACTIVATION_FAILED: Recording failed on the cloud.
Note: If the return value of IsActivated() is true, the return value can be nullptr.

APIs related to cloud call recording are as follows.