Clearing UI Configurations

CleanConfig

API Description

This API is used to clear all configurations related to the meeting UI and restore the default status.

Precautions

You can only call this API if you have called the Config API and want to clear configurations performed by the Config API.
This API is an asynchronous API. The return value only indicates whether the API is successfully called. The actual service processing result is returned in the corresponding callback function.

Method Definition

    
         HWM_SDK_AGENT_API hwmsdk::HwmErrCode CleanConfig();

Callback Function

   
        virtual void OnCleanConfigResult(hwmsdk::HwmErrCode ret, const char* reason) {};

Parameter Description

None

Return Values

**Table 1** Return values
Type	Description
HwmErrCode	If 0 is returned, the operation is successful. If other values are returned, the operation fails. For details about values returned upon failures, see Common Error Codes.

Sample Code

   
        /**
* Clear UI configurations.
*/
int hwmSDKConfigUI::hwmSDKConfigUI()
{
     // Clear configurations.
    int ret = hwmsdkagent::CleanConfig();
    LOG_INFO("Call hwmsdkagent::CleanConfig ret is " << ret);
}