Help Center/ Meeting/ Client SDK Reference/ Windows SDK/ APIs/ UI Customization/ Setting the Profile Picture Style

Updated on 2025-05-29 GMT+08:00

View PDF

Setting the Profile Picture Style

SetAvatarStyle

API Description

This API is used to set the profile picture style.

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 SetAvatarStyle(const HwmAvatarStyle* avatarStyle);

Callback Function

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

Parameter Description

**Table 1** HwmAvatarStyle description
Parameter	Mandatory	Type	Description
backgroundColor	Yes	char[]	Background color, in ARGB mode, for example, #ff59aaff.
textColor	Yes	char[]	Entity color, in ARGB mode, for example, #ffffffff.
phoneIconPath	Yes	char[]	Absolute path of the mobile phone icon. For example, to/path/image.svg. SVG and PNG formats are supported. UTF-8 encoding is required.
boardIconPath	Yes	char[]	Absolute path of the large display icon. For example, to/path/image.svg. SVG and PNG formats are supported. UTF-8 encoding is required.
nameShowType	No	HwmNameShowType	Name display style.
avatarShape	No	HwmAvatarShape	Profile picture shape.

**Table 2** Enumerated values of HwmNameShowType
Enumerated Value	Description
FIRST_LETTER	For a Chinese name, the first letter in pinyin is displayed. For an English name, the first letter is displayed.
FAMILY_NAME	For a Chinese name, the family name is displayed. For an English name, the first letter is displayed.

**Table 3** Enumerated values of HwmAvatarShape
Enumerated Value	Description
CIRCLE	Circle.

Sample Code

     
      
        
        
          /**
* Set the profile picture style.
*/
void demoSetAvatarStyleDlg::SetAvatarStyle()
{
    hwmsdkagent::HwmAvatarStyle avatarStyle{};
    CString contentCStr;
    m_editBKColor.GetWindowText(contentCStr);
    std::string content = CTools::UNICODE2UTF(contentCStr.GetString());
    errno_t err = strcpy_s(avatarStyle.backgroundColor, sizeof(avatarStyle.backgroundColor), content.c_str());

    m_editTextColor.GetWindowText(contentCStr);
    content = CTools::UNICODE2UTF(contentCStr.GetString());
    err += strcpy_s(avatarStyle.textColor, sizeof(avatarStyle.textColor), content.c_str());

    m_editPhoneIconPath.GetWindowText(contentCStr);
    content = CTools::UNICODE2UTF(contentCStr.GetString());
    err += strcpy_s(avatarStyle.phoneIconPath, sizeof(avatarStyle.phoneIconPath), content.c_str());

    m_editBoardIconPath.GetWindowText(contentCStr);
    content = CTools::UNICODE2UTF(contentCStr.GetString());
    err += strcpy_s(avatarStyle.boardIconPath, sizeof(avatarStyle.boardIconPath), content.c_str());

    if (err != S_OK)
    {
        AfxMessageBox(_T("String Copy Error!"));
    }

    unsigned int nameShowType = hwmsdkagent::HwmNameShowType::FIRST_LETTER;
    nameShowType = (unsigned int)m_comboboxNameShowType.GetCurSel();
    avatarStyle.nameShowType = static_cast<hwmsdkagent::HwmNameShowType>(nameShowType);

    unsigned int avatarShape = hwmsdkagent::HwmAvatarShape::CIRCLE;
    avatarShape = (unsigned int)m_comboboxAvatarType.GetCurSel();
    avatarStyle.avatarShape = static_cast<hwmsdkagent::HwmAvatarShape>(avatarShape);

    int ret = hwmsdkagent::SetAvatarStyle(&avatarStyle);
    return ret;
}

         

       

     
    