Video recording - Videorecording

This component requires a minimum iOS13 version

Introduction

The Component the one addressed in the current document is called VideoRecording Component. This is responsible for capturing the device screen in the background. It is mainly intended for recording the Onboarding process.

In the section of Simplified Launch the necessary steps for the basic integration of the SDK are detailed. In this section, information is added for the launch of this component.

Dependencies

To avoid conflicts and compatibility issues, if you want to install the component in a project that contains an old version of the Facephi libraries (Widgets), they must be completely removed before installing the components of the SDKMobile.

CocoaPods

• Currently, FacePhi libraries are distributed remotely through different dependency managers, in this case CocoaPods. The dependencies required that must have been installed beforehand (by adding them to the project's Podfile) are:

  pod 'FPHISDKMainComponent', '~> $VERSION'

• To install the Selphi component, the following entry must be included in the application's Podfile:

  pod 'FPHISDKVideoRecordingComponent', '~> $VERSION'

SPM

• The mandatory dependencies that must have been installed previously are:

//HTTPS
https://github.com/facephi-clienters/SDK-SdkPackage-SPM.git
//SSH
[email protected]:facephi-clienters/SDK-SdkPackage-SPM.git

• To install the SELPHI component, it must be included in the project's modules:

//HTTPS
https://github.com/facephi-clienters/SDK-VideoRecording-SPM.git
//SSH
[email protected]:facephi-clienters/SDK-VideoRecording-SPM.git

Permissions

In the client application where the components will be integrated, it is necessary to include the following element in the file Info.plist when the recording is going to include audio:

It is necessary to allow the use of the microphone (NSMicrophoneUsageDescription - Privacy - Microphone Usage Description)

Microphone permission is only required if you enable enableAudio in VideoRecordingConfigurationData. By default enableAudio is false and the recording does not capture audio.

Available controllers

Controller	Description
VideoRecordingController	Main video recording controller

Simplified Launch

Once the SDK has been started and a new operation has been created, the component can be launched. Any of its controllers can be used to execute its functionality.

Controller declaration

private var videoRecordingController: VideoRecordingController?

Starting the capture

To start screen recording:

public func launchVideoRecording(viewController: UIViewController) {
    let data = VideoRecordingConfigurationData()
    let videoRecordingController = VideoRecordingController(
        data: data,
        viewController: viewController,
        output: {
            print("videoRecordingController output: \($0.errorType)")
        })
    SDKController.shared.launch(controller: videoRecordingController)
    self.videoRecordingController = videoRecordingController
}

Stop the capture

To stop screen recording:

public func stopVideoRecording() {
    self.videoRecordingController?.stopVideoRecording()
}

Error handling

Errors will be returned as a 'VideoRecordingError' object.

Error list:

• VRC_EMPTY_LICENSE: The License String is empty

• VRC_INITIALIZATION_ERROR: Initialization error

• VRC_OPERATION_NOT_CREATED: There is no operation in progress

• VRC_NETWORK_CONNECTION: Internet connection error

• VRC_PERMISSION_ERROR: The user has denied the permissions

• VRC_SOCKET_ERROR: Error in the services connection

• VRC_UNKNOWN_ERROR: Unknown error

• VRC_VIDEO_CALL_ACTIVE: It cannot be started because there is an active Video Call

• VRC_VIDEO_ERROR: Error in video processing

• VRC_VIDEO_RECORDING_ACTIVE: It cannot be started because the Video Recording process is active

Advanced information

This section expands on the component information.

Advanced component configuration

To launch the current component, an object VideoRecordingConfigurationData must be created, which will be the configuration of the component controller.

Below are all the fields that are part of this class.

The fields included in the configuration, normally do not need to be provided since they are completed internally through the License used.

These fields are usually reported only when the server is On-Premise.

url

Path to the video socket

apiKey

ApiKey required to connect to the video socket

tenantId

Identifier of the tenant that refers to the current client, required to connect to the video service.

enableAudio

Flag that allows configuring whether video recording will have audio or not. By default to false.

If enableAudio is true, you must declare the microphone permission in Info.plist (see the section Permissions).