Customizing the Text for a Specific Scenario

SetCustomUIText

API Description

This API is used to customize the text for a specific scenario.

Precautions

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 SetCustomUIText(const HwmCustomSceneTextInfoList* customSceneTextInfoList);

Callback Function

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

Parameter Description

**Table 1** HwmCustomSceneTextInfoList description
Parameter	Type	Description
customSceneTextInfoListSize	unsigned int	Number of scenarios requiring text customization.
customSceneTextInfoList	HwmCustomSceneTextInfo*	Custom text details.

**Table 2** HwmCustomSceneTextInfo description
Parameter	Type	Description
scene	HwmUICustomTextScene	Scenario requiring text customization.
sceneTextListSize	unsigned int	Number of custom text strings.
sceneTextInfoList	HwmUICustomTextInfo*	List of custom text strings.

**Table 3** Enumerated values of HwmUICustomTextScene
Enumerated Value	Description
CLOUD_RECORD_FINISHED_ALERT_SCENE	Cloud recording end notification.
CLOUD_RECORD_MENU_TITLE_TEXT_SCENE	Cloud recording title in the recording pop-up menu.
CLOUD_RECORD_MENU_DES_TEXT_SCENE	Cloud recording description in the recording pop-up menu.
MAIN_WINDOW_CLOUD_RECORD_DES_TEXT_SCENE	Cloud recording description in the main window.

**Table 4** HwmUICustomTextInfo description
Parameter	Type	Description
languageType	HwmLanguage	Language type.
languageCode	char[]	Custom language code.
customText	char[]	Custom text.

**Table 5** 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

     
      
        
        
          /**
* Customize the text for a specific scenario.
*/
void demoCustomSceneContentDlg::OnBnClickedOk()
{
    hwmsdkagent::HwmCustomSceneTextInfo textInfo;
    AssembleCustomSceneTextInfo(textInfo);

    hwmsdkagent::HwmCustomSceneTextInfoList data{};
    if (textInfo.sceneTextListSize == 0)
    {
        data.customSceneTextInfoListSize = 0;
        data.customSceneTextInfoList = nullptr;
    }
    else
    {
        data.customSceneTextInfoListSize = 1;
        // Apply for the struct memory.
        data.customSceneTextInfoList = new (std::nothrow)hwmsdkagent::HwmCustomSceneTextInfo[data.customSceneTextInfoListSize];
        if (data.customSceneTextInfoList == nullptr)
        {
            return;
        }
        data.customSceneTextInfoList[0] = std::move(textInfo);
    }

    hwmsdk::HwmErrCode ret = hwmsdkagent::SetCustomUIText(&data);
    if (ret != hwmsdk::HWM_COMMON_SUCCESS)
    {
        CTools::OutputRetStr("Custom scene content error");
    }
    // Release the struct memory.
    for (int i = 0; i < data.customSceneTextInfoListSize; i++)
    {
        if (data.customSceneTextInfoList[i].sceneTextList != nullptr)
        {
            delete data.customSceneTextInfoList[i].sceneTextList;
            data.customSceneTextInfoList[i].sceneTextList = nullptr;
        }
    }

    if (data.customSceneTextInfoList != nullptr)
    {
        delete data.customSceneTextInfoList;
        data.customSceneTextInfoList = nullptr;
    }
}

         

       

     
    