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

Controlling a Meeting

setConfConfig

API Description

This API is used to perform meeting control operations.

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

1
setConfConfig(config):Promise<Result>

Related Event

Meeting Control Status Change Notification

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.

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.

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 sharing. The WeChat browser on mobile phones does not support this parameter. true: Share a screen. false: Cancel screen sharing.

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
// Share a screen.
let params = {shareScreen: true};
HWMeeting.setConfConfig(params).then(() => {
      // API called.
      ...      
    }).catch((e) => {
      // API calling failed.
      ...
    });
}