Help Center/ Meeting/ Client SDK Reference/ Web SDK/ APIs/ UI Customization/ Customizing a Button
Updated on 2025-09-19 GMT+08:00
View PDF
Share

Customizing a Button

API Description

This API is used to customize an in-meeting button.

Precautions

  1. Call this API after calling the API for joining a meeting.
  2. Call this API only after you receive the event of the meeting joining result notification.

Method Definition

setCustomerButton(customerButtonObj[])::Promise<Result>

Parameter Description

Table 1 Description

Parameter

Mandatory

Type

Description

customerButtonObj[]

Yes

array

List of custom buttons. For details about the data type, see Table 2.
Table 2 customerButtonObj description

Parameter

Mandatory

Type

Description

buttonId

Yes

string

Unique ID of a button.

eventName

Yes

string

Name of the event triggered when the button is clicked or touched. You can receive this event through GUI Operation Event Notification.

desc

Yes

object

See Table 3.

icon

No

string

Custom button icon displayed on the mobile app. The image path must be accessible.

buttonPos

No

string

Position of the custom button. Default value: 0. Range:

0: More menu (with up to six buttons).

1: meeting control bar (with only one button).
Table 3 desc description

Parameter

Mandatory

Type

Description

zh

Yes

string

Chinese button name.

en

Yes

string

English button name.

Return Values

For details about the result structure, see Table 1. For details about the error structure, see Table 3.

Sample Code

/**
* Customize a button.
*/
HWMeeting.setCustomerButton(value).then((data) => {
  // TODO: Display the result.
 }).catch((e) => {
  // Display the result.
  console.log(e.retCode+":"+e.retMsg);
});
Parent topic: UI Customization