Help Center/ Meeting/ Client SDK Reference/ Web SDK/ APIs/ Meeting Control/ Controlling a Meeting

Updated on 2025-09-19 GMT+08:00

View PDF

Controlling a Meeting

setConfConfig

API Description

This API is used to perform meeting control operations.

Precautions

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

Method Definition

    
         setConfConfig(config):Promise<Result>

Parameter Description

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
config	Yes	JavaScript object {"key": value}	The value has a type requirement. If the value does not match the type, the configuration does not take effect. For details, see Table 2.

**Table 2** Description of the confConfig object
Parameter	Type	Description
audioMute	boolean	Whether to mute the microphone. (The microphone and camera cannot be invoked at the same time.) true: Mute the microphone. false: Unmute the microphone. CAUTION: If a user unmutes the microphone without interacting with the page, the API fails to be called. You are advised to guide the user to interact with the page first.
videoMute	boolean	Whether to enable the camera. (The microphone and camera cannot be invoked at the same time.) true: Disable the camera. false: Enable the camera. CAUTION: If a user enables the camera without interacting with the page, the API fails to be called. You are advised to guide the user to interact with the page first.
speakerMute	boolean	Whether to mute the speakers. true: Mute the speakers. false: Unmute the speakers.
volume	number	Speaker volume. The WeChat browser on mobile phones does not support this parameter. Value range: 0–100.
handUp	boolean	Whether to raise or lower hands. true: Raise hands. false: Lower hands.
shareScreen	boolean	Whether to share a screen or cancel screen sharing. true: Share a screen. false: Cancel screen sharing. NOTE: Mobile browsers do not support screen sharing because their WebRTC screen capture API has limitations.
userName	string	Participant name. The value can contain up to 64 characters.

When calling this API, pass only the value of keys to be changed. For example, to raise hands, pass only {"handUp": true}.

Return Values

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

Sample Code

    
         // Share a screen.
let params = {shareScreen: true};
HWMeeting.setConfConfig(params).then(() => {
      // API called.
      ...      
    }).catch((e) => {
      // API calling failed.
      ...
    });
}