Updated on 2024-07-30 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 11.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

AFNetworking

4.0.1

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. Open the demo project and copy HWMUISDK.framework and HWMMRMedia.framework to the demo project.
      Figure 2 HWMUISDK.framework and HWMMRMedia.framework added
    2. Choose TARGETS > HWMSDKDemo > General, choose Frameworks, Libraries, and Embedded Content separately, and change the value in the Embed column of HWMUISDK.framework and HWMMRMedia.framework to Embed & Sign.
      Figure 3 HWMUISDK.framework and HWMMRMedia.framework settings
    3. Copy HWMExtension.framework to the ScreenShareExtension directory.
      Figure 4 HWMExtension.framework added
    4. Added the -lc++ configuration in TARGETS > ScreenShareExtension > Build Settings > Other Linker Flags.
      Figure 5 ScreenShareExtension settings
    5. Download Masonry and copy the source code to the project.
      Figure 6 Masonry added
    6. Modify the Masonry reference mode in HWMSDKDemo-Prefix.h.
      Figure 7 Modifying the Masonry reference mode
    7. Download AFNetworking and copy the source code to the project.
      Figure 8 AFNetworking added
    8. Modify the AFNetworking reference mode in SchemeLinkViewController.m and APPIDLoginViewController.m.
      Figure 9 Modifying the AFNetworking reference mode in SchemeLinkViewController.m
      Figure 10 Modifying the AFNetworking reference mode in APPIDLoginViewController.m

  3. Configure the project.

    1. Modify the bundle ID in HWMSDKDemo and import the profile. For details about how to create a certificate and profile, see How Do I Apply for a Certificate for iOS?
      Figure 11 Configuration page
    2. Edit HWMSDKDemo.entitlements, delete the items under Associated Domains, and change the value of App Groups to the app group corresponding to the bundle ID of HWMSDKDemo.
      Figure 12 Configuration page of HWMSDKDemo.entitlements
    3. Modify the bundle ID in ScreenShareExtension and import the profile.
      Figure 13 Configuration page
    4. Edit ScreenShareExtension.entitlements and change the value of App Groups to the app group corresponding to the bundle ID of ScreenShareExtension.
      Figure 14 Configuration page of ScreenShareExtension.entitlements
    5. Modify the bundle ID in ScreenShareExtensionSetupUI and import the profile.
      Figure 15 Configuration page
    6. Edit ScreenShareExtensionSetupUI.entitlements and change the value of App Groups to the app group corresponding to the bundle ID of ScreenShareExtensionSetupUI.
      Figure 16 Configuration page of ScreenShareExtensionSetupUI.entitlements
    7. 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 AppId and AppKey in HWMUISDKDemoConfig.plist with the obtained app ID and key.

      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 17 In-meeting screen of the iOS demo