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

Enabling a Function

enableSDKCapability

API Description

This API is used to enable a function.

Method Definition

1
- (void)enableSDKCapability:(HWMSDKCapabilitySuport)type;

Parameter Description

Table 1 HWMSDKCapabilitySuport parameters

Parameter

Type

Description

HWMSDKCapabilitySuportVideoHD

NSUInteger

Enabling the 720p HD video. The default definition is 360p.

HWMSDKCapabilitySuportShareAudio

NSUInteger

Enabling the display of the Include computer sound option. This option is not displayed by default.

HWMSDKCapabilitySuportHideNoCameraView

NSUInteger

Enabling the Hide non-video participants option. This option is enabled by default.

HWMSDKCapabilitySuportBreakoutConf

NSUInteger

Enabling the breakout room function. This function is enabled by default.

HWMSDKCapabilitySuportConfirmRecord

NSUInteger

Recording security prompt, which is disabled by default.

Enabling the HD Video

Sample Code
/// Enable the HD video.
[[HWMBizSdk getBizOpenApi] enableSDKCapability:HWMSDKCapabilitySuportVideoHD];

Enabling Audio Sharing

  1. Call the enableSDKCapability API to enable the display of the Include computer sound option.

    Sample Code
    /// Enable audio sharing.
    [[HWMBizSdk getBizOpenApi] enableSDKCapability:HWMSDKCapabilitySuportShareAudio];

    If the function is enabled, the Include computer sound option will be displayed in the sharing window when a user initiates screen sharing, as shown in the following figure. If the function is not enabled, the option is not displayed.

  2. Disable the App Sandbox function.

    Disable the App Sandbox function and obtain the root permission to enable the SDK to automatically install the audio driver plug-in.

    Delete the App Sandbox item from the entitlements description file of the app. The following figure is an example.

    If the App Sandbox function is disabled, the root permission is obtained when Include computer sound is selected for the first time. After the user clicks OK, the audio driver plug-in is automatically installed. The following figure is an example.

    If the App Sandbox function is not disabled, the user will be prompted to download the client from the official website when selecting Include computer sound for the first time. After the user clicks Download, the official website is displayed. The following figure is an example.

    The download link can be configured in the appUrl parameter of the initWithConfig API, which is used to start and initialize the SDK. For details, see Initializing the SDK. If appUrl is not configured, the download page is not displayed.

After the App Sandbox function is disabled, the user path obtained by the app changes, and the app cannot be released to the Mac App Store.

Enabling the Function of Hiding Non-Video Participants

Sample Code
/// Enable the option of displaying or hiding non-video participants.
[[HWMBizSdk getBizOpenApi] enableSDKCapability:HWMSDKCapabilitySuportHideNoCameraView];

After the function is enabled, the Hide non-video participants option is displayed in the meeting settings.

Sample Code

/// Disable the option of displaying or hiding non-video participants.
[[HWMBizSdk getBizOpenApi] disableSDKCapability:HWMSDKCapabilitySuportHideNoCameraView];

After the function is disabled, the Hide non-video participants option is hidden from the meeting settings.