Updated on 2023-03-23 GMT+08:00

Building the iOS Demo

This section describes how to quickly compile and run the iOS demo of the client SDK.

Environment Requirements

Ensure that the following environment requirements are met during the compilation and running of the iOS demo.

Table 1 Environment requirements

Environment and Tool

Version

Description

OS

macOS High Sierra 10.14.4 or later

Requirement of Xcode on the macOS. The recommended version is 10.15 or later.

Xcode

Xcode 11 or later

Xcode 11.3.1 is used as an example in the demo and documentation.

iOS

iOS 10.0 or later, 64-bit device

The screen sharing function requires iOS 12 or later.

Requesting test resources and app IDs

-

For details, see Preparations.

Table 2 Project configuration requirements

Item

Requirement

Description

Enable Bitcode

NO

Compilation code optimization is not supported.

Valid Architectures

Arm64

CPU architecture is supported.

Other Link Flags

-ObjC

Load all Objective-C classes and categories in the static library to the final executable file.

Table 3 Third-party open-source libraries

Open Source Library Name

Recommended Version

Masonry

The version must be 1.1.0 or later.

SSZipArchive

2.1.3

YYModel

1.0.4

CocoaLumberjack

3.4.1

libyuv

1.0.2

Procedure

  1. Download the SDK and demo source code.

    1. Download the ZIP package of the SDK by following the instructions provided in Table 1.
    2. Decompress the ZIP package to obtain the following files and directories:
    Figure 1 Directory structure of the SDK package

  2. Add a dependency library.

    1. Copy HWMUISDK.framework, HWMMREngine.framework, and HWMMRMedia.framework to the demo. Choose TARGETS > HWMSDKDemo > General > Frameworks, Libraries, and Embedded Content, and change the value in the Embed column of HWMUISDK.framework to Embed & Sign.
    2. Copy HWMExtension.framework to ScreenShareExtension, choose TARGETS > ScreenShareExtension > Build Settings > Other Linker Flags, and add -lc++.
    3. Change the value in the Embed column of HWMUISDK.framework to Embed & Sign
      Figure 2 HWMUISDK.framework, HWMMREngine.framework, and HWMMRMedia.framework settings
      Figure 3 Setting HWMExtension.framework
    4. Download Masonry and copy the source code to the project.

  3. Configure the project.

    1. Modify the bundle identifier and app groups and install the corresponding certificate. For details about how to create and manage the certificate address, see Certificate Address.
    2. Compile and run the project.

  4. Use the demo.

    The following describes how to create an instant meeting:

    1. Touch Initialization to initialize the SDK.

    2. Log in to the system.

      Login using an account and password: Click the login button. On the login screen, enter the account and password and click Log in.

      Login using an app ID

      For details about how to request an app ID, see Introduction to App ID Authentication.

      Method 1: Change the default value in the code.

      Replace the app ID in SDKEnvConfig with the obtained app ID.

      Figure 4 Changing the default app ID of the demo

      Method 2: Modify the app ID and initialize the SDK.

      Open the demo, access the global configuration screen, configure the app ID and key, save the settings, initiate the SDK, and log in to the system.

    3. Touch Create meeting.
      Figure 5 In-meeting screen of the iOS demo