Skip to main content
Version: 2.2.X

Video Call Component

0. SDK Mobile baseline requirements​

SDK Mobile is a set of libraries (Components) that offer a series of functionalities and services, allowing their integration into a Mobile application in a simple and fully scalable way. Depending on the use case that is required, certain components must be installed. Its high level of modularity allows other new components to be added in the future without affecting those already integrated in the project.

For more information on the base configuration, go to the Getting Started section.

1. Introduction​

The component discussed in the current document is called VideoCall Component. It is in charge of managing the communication between a user and an agent remotely, through a communication channel. It is mainly oriented to video assistance use cases.

1.1 Minimum requirements​

The minimum iOS SDK version required is the following:

Minimum iOS version: 13

2. Integration of the component​

⚠️ Before integrating this component, it is recommended to read the documentation related to Initial Integration and follow its instructions.

This section will explain step by step how to integrate the current component into an existing project.

2.1. Dependencies required for integration​

To avoid conflicts and compatibility problems, in case you want to install the component in a project containing an old version of the Facephi libraries (Widgets), these must be completely removed before installing the SDKMobile components.

Cocoapods​

  • Currently FacePhi libraries are distributed remotely through different dependency managers, in this case Cocoapods. The mandatory dependencies that must have been previously installed (by adding them in the Podfile file of the project) are:
  pod 'FPHISDKMainComponent', '~> 1.5.0'
  • To install the VideoCall component, the following entry must be included in the application Podfile:
  pod 'FPHISDKVideoCallComponent', '~> 1.5.0'

  • Once the dependencies are installed, the different functionalities of the component can be used.

  • In case of development with xCode15 a post-installation script must be included: Image

2.2 Permissions and configurations​

In the client application where the components are going to be integrated it is necessary to incorporate the following elements in the info.plist file

It is necessary to allow the use of the camera (Privacy - Camera Usage Description).

3. Start new operation​

In order to generate the associated information correctly in the platform, the newOperation command must be executed first.

ℹ️ This command must have been executed before launch. To learn more about how to start a new operation, it is recommended to consult the Start a new operation documentation, which details and explains what this process consists of.

4. Available controllers​

ControllerDescription
VideoCallControllerVideocall main controller

5. Component configuration​

To configure the current component, once it has been initialised, a VideoCallConfigurationData object must be created and passed as a parameter to the SDKController when the component is launched.

The following section will show the fields that are part of this class and what each of them is used for.

5.1. Class VideoCallConfigurationData​

The fields included in the configuration, normally do not need to be be reported as they are filled internally through the license used. license used.

5.1.1. Basic Configuration​

activateScreenSharing​

Activate the screen sharing option in the call.

5.1.2. Advanced Settings​

5.1.2.1. url​

Path to video socket

5.1.2.2 apiKey​

ApiKey needed for the connection to the video socket

5.1.2.3 tenantId​

Tenant identifier referring to the current client, required for the connection to the video service.

5.1.3. Other parameters​

VibrationEnabled​

If set to true, vibration is enabled on errors and if the widget response is OK.

6. Use of the component​

⚠️ For version 2.0.2 or higher, you must include the parameter extensionName: ‘’. This new parameter is for screen sharing, if not used it must be an empty string.

let videocallController = VideoCallController(data: data, extensionName: "videoRecording", output: output, viewController: viewController)

Once the component has been started and a new operation has been created (section 3) the SDK components can be launched. There are two ways to launch the component:

  • [WITH TRACKING] This call allows launching the functionality of the component normally, but the events will be tracked internal to the tracking server in the event that the component tracking is installed and active:
let controller = VideoCallController(data: videoCallConfigurationData, output: output, viewController: viewController)
SDKController.shared.launchMethod(controller: controller)
  • [NO TRACKING] This call allows launching the functionality of the component normally, but will not be tracked any event to the tracking server in case the tracking:
let controller = VideoCallController(data: videoCallConfigurationData, output: output, viewController: viewController)
SDKController.shared.launch(controller: controller)

The launch method should be used by default. This method allows use tracking if its component is activated, and do not will be used when it is disabled (or the component is not found installed).

On the contrary, the launchMethod method covers a special case, in which the integrator has tracking installed and activated, but in a certain flow within the application you do not want to track information. In that case, this method is used to prevent that information from being sent. to the platform.

The configuration data (VideoCallConfigurationData) also contains They will be able to modify:

  • optional data that is normally included within the license

    • tenantId: Tenant identifier that refers to the current client, necessary for connection with the service video.

    • url: Path to the video socket.

    • apiKey: ApiKey necessary for the connection with the socket video.

Example configuration​

  log("LAUNCH VIDEO CALL")

  let videocallController = VideoCallController(data: VideoCallConfigurationData(
                                                          url: "Enter URL",
                                                          apikey: "Enter the ApiKey",
                                                          tenantId: "Enter the tenantId"),
                                                output: output, viewController: viewController)
  SDKController.shared.launchMethod(controller: videocallController)

*** IMPORTANT *** The values are assigned by default. ONLY must be configured in case of using an external platform to the one provided by Facephi, within the license.

7. Receipt of the result​

The controllers will return the required information in SdkResult format -more details in the Getting Started-.

7.1. Receiving errors​

On the error side, we will have the VideoCallError class.

 VIDEO_CALL_CANCEL_BY_USER
 VIDEO_CALL_TIMEOUT
 VIDEO_CALL_INTERNAL_ERROR
 VIDEO_CALL_DECODER_ERROR

7.2. Receiving successful execution - data​

On successful execution, simply report that everything went well with the SdkResult.Success. with the SdkResult.Success.

When the result is Success and the sharingScreen flag is active, screen sharing can be enabled.

8. Customizing the component​

Apart from the changes that can be made at SDK level (which are explained in the Getting Started document), this particular component allows the modification of specific texts.

To customise the component, ThemeVideoCallManager.setup(theme: CustomThemeVideoCall() ) must be called before launching the videocallController:

let videocallController = VideoCallController(data: VideoCallConfigurationData(), output: output, viewController: viewController)
ThemeVideoCallManager.setup(theme: CustomThemeVideoCall())
SDKController.shared.launch(controller: videocallController)

An example of the CustomThemeVideoCall class would be this (must implement ThemeVideoCallProtocol):

class CustomThemeVideoCall: ThemeVideoCallProtocol {
    var images: [R.Image: UIImage?] = [:]

    var colours: [R.Color: UIColor?] = [R.Color.TitleText: UIColor.red] = [R.Color.TitleText: UIColor.red].

    var animations: [R.Animation: String] = [:] var animations: [R.Animation: String] = [:]

    var name: String {
        "custom"
    }

    var fonts: [R.Font: String] = [:] var fonts: [R.Font: String] = [:] var font: [R.Font: String] = [:]

    var dimensions: [R.Dimension: CGFloat] {
        [.fontBig: 8]
    }
}

8.1 Colours and images​

Images are initialised in the variable images , passing it a dictionary, the key being one of the enumerated ones representing the different images on the screen, and the value being the custom image to be displayed.

case close

Colours are similarly initialised in the colours variable with a dictionary, with the value being a UIColor of your choice.

case ButtonBackground
case ButtonBackgroundDisabled
case CardBackground
case CardText
case MainBackground
case PhoneButtonBackground
case Primary
case TitleText

8.2 Fonts​

Fonts are initialised similarly in the fonts variable with a dictionary, having as value a String with the name of the desired UIFont.

case regular
case bold

The animations to be used are similarly initialised in the animations variable with a dictionary, having as value a String with the name of the animation found in the xcassets to be used.

case phone_calling

The size of the texts is initialised similarly in the dimensions variable with a dictionary, having as value a CGFloat with the desired size.

8.3 Texts​

If you want to modify the SDK texts, you would have to include the following XML file in the client application, and modify the value of each String by the desired one.

 <!-- VIDEO CALL -->
    <string name="video_call_text_waiting_agent_title">Connecting with an assistant…</string>
    <string name="video_call_agent">Agent</string>
    <string name="video_call_exit_alert_title">Cancel process</string>
    <string name="video_call_exit_alert_question">Are you sure you want to leave the video assistance?</string>
    <string name="video_call_exit_alert_exit">Quit</string>
    <string name="video_call_exit_alert_cancel">Cancel</string>
    <string name="video_call_exit">Exit</string>
    <string name="video_call_network_connection_error">Check your internet connection.</string>
    <string name="video_call_image_description">Phone</string>
    <string name="video_call_text_finish">Video assistance is complete</string>
    <string name="video_call_text_finish_button">Exit</string>
    <string name="video_call_accesibility_phone">Phone</string>

8.4 Colors​

<!-- VIDEO CALL -->
<color name="colorVideoCallPhoneButtonBackground">#F44336</color>
<color name="colorVideoCallActionsBackground">#30333d</color>
<color name="colorVideoCallCardText">#ffffff</color>
<color name="colorVideoCallButtonBackground">#FF526080</color>