Methods

Use the ClanMeeting methods to change the meeting settings/properties dynamically while a meeting is going on.

Note: Examples on this page show how to execute the methods on meeting join. However, you can also execute these methods using custom buttons or when other events occur within the meeting.

Example Usage (All Methods) #

xxxxxxxxxx
21
1
const meeting = new ClanMeeting(domain, consumerId, optionalProperties);
2

3
window.onload = function () {
4
  // Method 1
5
  meeting.start();
6

7
  const meetingJoinedLsnr = function meetingJoinedLsnr(eventData) {
8
      // Method 2
9
      console.log(meeting.get('allParticipants'));
10
      // Method 3
11
      meeting.set('displayName', 'ChangedName');
12
    };
13
  };
14

15
  meeting.once('meetingJoined', meetingJoinedLsnr);
16
};
17

18
window.onunload = function () {
19
  // Method 4
20
  meeting.end();
21
};

Example Usage (Host Methods) #

NOTE: If trying to call methods as soon as meeting is joined, wait for the role to be upgraded to moderator before executing methods that need host privileges as shown in the example below.

xxxxxxxxxx
28
1
const meeting = new ClanMeeting(domain, consumerId, optionalProperties);
2
// Methods 1 and 2 (chained together)
3
meeting.generateRoomName().anonymizeDisplayName();
4

5
window.onload = function () {
6
  // Method 3
7
  meeting.start();
8

9
  const meetingJoinedLsnr = function meetingJoinedLsnr() {
10
    const roleChangedLsnr = function roleChangedLsnr(event) {
11
      // Execute host methods only AFTER the user has joined and has become the moderator
12
      if (event.role === 'moderator') {
13
        // Methods 4 & 5 (chained)
14
        meeting
15
          .exec('enableLobby', true)
16
          .exec('startRecording');
17
      }
18
    };
19
    meeting.on('roleChanged', roleChangedLsnr);
20
  };
21

22
  meeting.once('meetingJoined', meetingJoinedLsnr);
23
};
24

25
window.onunload = function () {
26
  // Method 6
27
  meeting.end();
28
};

Method Chaining #

Few ClanMeeting methods support chaining as shown in the examples above. The ones that do are flagged as isChainable.

xxxxxxxxxx
10
1
// Chainable
2
meeting
3
  .exec('enableLobby', true)
4
  .exec('startRecordingWithTranscription')
5
  .set('localSubject', subject)
6
  .toggle('tileView');
7

8
// Not chainable
9
meeting.get('nbParticipants');
10
meeting.checkAsync('isAudioAvailable').then(value => { console.log(value); });

All Methods #

start() #

Starts the conference. Use on window load.

Example:

xxxxxxxxxx
3
1
window.onload = function () {
2
  meeting.start();
3
};

end() #

Removes all listeners and ends the conference (only for the local user).

Example:

xxxxxxxxxx
3
1
window.onunload = function () {
2
  meeting.end();
3
};

generateRoomName([prefix], [nbChars], [suffix]) #

Generates a complex random room name and sets the roomName property.

If you do not set the roomName property to a room of your choice then you must use this method BEFORE meeting.start().

Example:

xxxxxxxxxx
12
1
// either set the roomName in optionalProperties
2
const meeting = new ClanMeeting(domain, consumerId, optionalProperties);
3

4
// or generate one before starting the meeting
5
meeting.generateRoomName();
6
// customize roomName like below if you want
7
// this example generates 15 character room names
8
meeting.generateRoomName('', 15, '');
9

10
window.onload = function () {
11
  meeting.start();
12
};

anonymizeDisplayName([prefix], [nbDigits]) #

Anonymizes the displayName of the participant. e.g. User_1234

If you do not set the displayName property then you must use this method BEFORE meeting.start().

Example:

xxxxxxxxxx
12
1
// either set the displayName in optionalProperties
2
const meeting = new ClanMeeting(domain, consumerId, optionalProperties);
3

4
// or anonymize the name before starting the meeting
5
meeting.anonymizeDisplayName();
6
// or customize as per need
7
// examples - Batch5_123, Batch5_843
8
meeting.anonymizeDisplayName('Batch5_', 3);
9

10
window.onload = function () {
11
  meeting.start();
12
};

isInFuture(startDateTime) #

Returns true if the meeting is in the future as compared to the current time.

Example:

See usage in schedule meetings guide.

get('allParticipants') #

Deprecated #

Use getAsync('roomsInfo') instead.

Get an array containing all participant information such as ID, display name, avatar URL, and email.

Example:

xxxxxxxxxx
9
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    const allParticipants = meeting.get('allParticipants');
6
  };
7

8
  meeting.once('meetingJoined', meetingJoinedLsnr);
9
};

get('nbParticipants') #

Get number of participants in the room.

Example:

xxxxxxxxxx
9
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    const nbParticipants = meeting.get('nbParticipants');
6
  };
7

8
  meeting.once('meetingJoined', meetingJoinedLsnr);
9
};

get('videoQuality') #

Get current video resolution.

Example:

xxxxxxxxxx
9
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    meeting.get('videoQuality');
6
  };
7

8
  meeting.once('meetingJoined', meetingJoinedLsnr);
9
};

get('meetingElement') #

Get HTML element which is used to load the conference.

Example:

xxxxxxxxxx
9
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    meeting.get('meetingElement');
6
  };
7

8
  meeting.once('meetingJoined', meetingJoinedLsnr);
9
};

get('avatarUrlById', participantId) #

Deprecated #

Use getAsync('roomsInfo') instead.

Get avatarUrl for the participant.

Example:

xxxxxxxxxx
10
1
window.onload = function () {
2
  meeting.start();
3

4
  const someoneJoinedLsnr = function someoneJoinedLsnr(participant) {
5
    meeting.get('avatarUrlById', participant.id);
6
  };
7

8
  // event is triggered when a remote participant joins the meeting
9
  meeting.on('someoneJoined', someoneJoinedLsnr);
10
};

get('displayNameById', participantId) #

Get display name for the participant.

Example:

xxxxxxxxxx
10
1
window.onload = function () {
2
  meeting.start();
3

4
  const someoneJoinedLsnr = function someoneJoinedLsnr(participant) {
5
    meeting.get('displayNameById', participant.id);
6
  };
7

8
  // event is triggered when a remote participant joins the meeting
9
  meeting.on('someoneJoined', someoneJoinedLsnr);
10
};

get('emailById', participantId) #

Get email of the participant if set.

Example:

xxxxxxxxxx
10
1
window.onload = function () {
2
  meeting.start();
3

4
  const someoneJoinedLsnr = function someoneJoinedLsnr(participant) {
5
    meeting.get('emailById', participant.id);
6
  };
7

8
  // event is triggered when a remote participant joins the meeting
9
  meeting.on('someoneJoined', someoneJoinedLsnr);
10
};

get('participantById', participantId) #

Deprecated #

Use getAsync('roomsInfo') instead.

Get participant information by participant ID.

Example:

xxxxxxxxxx
10
1
window.onload = function () {
2
  meeting.start();
3

4
  const someoneJoinedLsnr = function someoneJoinedLsnr(participant) {
5
    meeting.get('participantById', participant.id);
6
  };
7

8
  // event is triggered when a remote participant joins the meeting
9
  meeting.on('someoneJoined', someoneJoinedLsnr);
10
};

getAsync('roomsInfo') #

Returns an array with room and participant details.

Example:

xxxxxxxxxx
9
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    meeting.getAsync('roomsInfo').then(info => { console.log(info); });
6
  };
7

8
  meeting.once('meetingJoined', meetingJoinedLsnr);
9
};

Response:

xxxxxxxxxx
24
1
{
2
  "rooms": [
3
    {
4
      "isMainRoom": true,
5
      "id": "1234@muc.nanothread.ap01.clanmeeting.com",
6
      "jid": "1234@muc.nanothread.ap01.clanmeeting.com/ce1a8e2a",
7
      "participants": [
8
        {
9
          "role": "moderator",
10
          "displayName": "Jason",
11
          "avatarUrl": "",
12
          "id": "ce1a8e2a"
13
        },
14
        {
15
          "jid": "1234@muc.nanothread.ap01.clanmeeting.com/75032972",
16
          "role": "participant",
17
          "displayName": "Ayushman",
18
          "avatarUrl": "",
19
          "id": "75032972"
20
        }
21
      ]
22
    }
23
  ]
24
}

getAsync('availableDevices') #

Get the list of audio and video devices available to the local participant.

Example:

xxxxxxxxxx
9
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    meeting.getAsync('availableDevices').then(devices => { console.log(devices); });
6
  };
7

8
  meeting.once('meetingJoined', meetingJoinedLsnr);
9
};

Response:

xxxxxxxxxx
20
1
devices = {
2
  audioInput: [{
3
    deviceId: 'ID'
4
    groupId: 'grpID'
5
    kind: 'audioinput'
6
    label: 'label'
7
  },....],
8
  audioOutput: [{
9
    deviceId: 'ID'
10
    groupId: 'grpID'
11
    kind: 'audioOutput'
12
    label: 'label'
13
  },....],
14
  videoInput: [{
15
    deviceId: 'ID'
16
    groupId: 'grpID'
17
    kind: 'videoInput'
18
    label: 'label'
19
  },....],
20
}

getAsync('currentDevices') #

Get the list of currently selected audio/video devices for the local participant.

Example:

xxxxxxxxxx
9
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    meeting.getAsync('currentDevices').then(devices => { console.log(devices); });
6
  };
7

8
  meeting.once('meetingJoined', meetingJoinedLsnr);
9
};

Response:

xxxxxxxxxx
20
1
devices = {
2
  audioInput: [{
3
    deviceId: 'ID'
4
    groupId: 'grpID'
5
    kind: 'audioinput'
6
    label: 'label'
7
  },....],
8
  audioOutput: [{
9
    deviceId: 'ID'
10
    groupId: 'grpID'
11
    kind: 'audioOutput'
12
    label: 'label'
13
  },....],
14
  videoInput: [{
15
    deviceId: 'ID'
16
    groupId: 'grpID'
17
    kind: 'videoInput'
18
    label: 'label'
19
  },....],
20
}

getAsync('livestreamUrl') #

Get the livestream URL if livestreaming is on.

Example:

xxxxxxxxxx
9
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    meeting.getAsync('livestreamUrl').then(data => { console.log(data); });
6
  };
7

8
  meeting.once('meetingJoined', meetingJoinedLsnr);
9
};

Response:

xxxxxxxxxx
3
1
data = {
2
  livestreamUrl: 'livestreamUrl'
3
}

getAsync('contentSharingParticipants') #

Get the list of screen sharing participants.

Example:

xxxxxxxxxx
9
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    meeting.getAsync('contentSharingParticipants').then(data => { console.log(data); });
6
  };
7

8
  meeting.once('meetingJoined', meetingJoinedLsnr);
9
};

Response:

xxxxxxxxxx
3
1
data = {
2
  sharingParticipantIds: [particId1, particId2, ...]
3
}

selectDeviceAsync(type, label, id) #

Once you get the device list using above methods, you can select a particular audio / video input or output device. Device list has the label and ID.

Example:

xxxxxxxxxx
10
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    // returns true if selected
6
    meeting.selectDeviceAsync('audioInput', 'Microphone Array (Realtek Audio)', 'qndtoJUhFXtLampWZ3tLfObK7/yovEm7/G8XZmQvT/g=', ).then(value => { console.log(value); });
7
  };
8

9
  meeting.once('meetingJoined', meetingJoinedLsnr);
10
};

Response:

xxxxxxxxxx
2
1
value = true or false
2
// based on if the device was selected successfully

checkAsync('isAudioAvailable') #

Is audio available?

Example:

xxxxxxxxxx
10
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    // value could be true or false
6
    meeting.checkAsync('isAudioAvailable').then(value => { console.log(value); });
7
  };
8

9
  meeting.once('meetingJoined', meetingJoinedLsnr);
10
};

checkAsync('isVideoAvailable') #

Is video available?

Example:

xxxxxxxxxx
10
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    // value could be true or false
6
    meeting.checkAsync('isVideoAvailable').then(value => { console.log(value); });
7
  };
8

9
  meeting.once('meetingJoined', meetingJoinedLsnr);
10
};

checkAsync('isAudioDisabled') #

Is audio disabled?

Example:

xxxxxxxxxx
10
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    // value could be true or false
6
    meeting.checkAsync('isAudioDisabled').then(value => { console.log(value); });
7
  };
8

9
  meeting.once('meetingJoined', meetingJoinedLsnr);
10
};

checkAsync('isAudioMuted') #

Is microphone muted?

Example:

xxxxxxxxxx
10
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    // value could be true or false
6
    meeting.checkAsync('isAudioMuted').then(value => { console.log(value); });
7
  };
8

9
  meeting.once('meetingJoined', meetingJoinedLsnr);
10
};

checkAsync('isVideoMuted') #

Is video muted?

Example:

xxxxxxxxxx
10
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    // value could be true or false
6
    meeting.checkAsync('isVideoMuted').then(value => { console.log(value); });
7
  };
8

9
  meeting.once('meetingJoined', meetingJoinedLsnr);
10
};

checkAsync('isAudioModerationOn') #

Whether host can mute/ ask to unmute other participants.

Example:

xxxxxxxxxx
10
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    // value could be true or false
6
    meeting.checkAsync('isAudioModerationOn').then(value => { console.log(value); });
7
  };
8

9
  meeting.once('meetingJoined', meetingJoinedLsnr);
10
};

checkAsync('isVideoModerationOn') #

Is host allowed to turn off the camera of remote participants?

Example:

xxxxxxxxxx
10
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    // value could be true or false
6
    meeting.checkAsync('isVideoModerationOn').then(value => { console.log(value); });
7
  };
8

9
  meeting.once('meetingJoined', meetingJoinedLsnr);
10
};

checkAsync('isDeviceListAvailable') #

Is device list available?

Example:

xxxxxxxxxx
10
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    // value could be true or false
6
    meeting.checkAsync('isDeviceListAvailable').then(value => { console.log(value); });
7
  };
8

9
  meeting.once('meetingJoined', meetingJoinedLsnr);
10
};

checkAsync('isDeviceChangeAvailable') #

Is device change available?

Example:

xxxxxxxxxx
10
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    // value could be true or false
6
    meeting.checkAsync('isDeviceChangeAvailable', 'input').then(value => { console.log(value); });
7
  };
8

9
  meeting.once('meetingJoined', meetingJoinedLsnr);
10
};

checkAsync('isMultipleAudioInputSupported') #

Are multiple audio inputs supported?

Example:

xxxxxxxxxx
10
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    // value could be true or false
6
    meeting.checkAsync('isMultipleAudioInputSupported').then(value => { console.log(value); });
7
  };
8

9
  meeting.once('meetingJoined', meetingJoinedLsnr);
10
};

checkAsync('isParticipantsPaneOpen') #

Is the side participant pane open?

Example:

xxxxxxxxxx
10
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    // value could be true or false
6
    meeting.checkAsync('isParticipantsPaneOpen').then(value => { console.log(value); });
7
  };
8

9
  meeting.once('meetingJoined', meetingJoinedLsnr);
10
};

checkAsync('isSilentModeEnabled') #

Is silent mode enabled? Audio from remote participants is disabled when in silent mode.

Example:

xxxxxxxxxx
10
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    // value could be true or false
6
    meeting.checkAsync('isSilentModeEnabled').then(value => { console.log(value); });
7
  };
8

9
  meeting.once('meetingJoined', meetingJoinedLsnr);
10
};

checkAsync('isParticipantAudioForceMuted', participantId) #

Is audio for this participant muted by host?

Example:

xxxxxxxxxx
10
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    // value could be true or false
6
    meeting.checkAsync('isParticipantAudioForceMuted', participant.id).then(value => { console.log(value); });
7
  };
8

9
  meeting.once('meetingJoined', meetingJoinedLsnr);
10
};

checkAsync('isParticipantVideoForceMuted', participantId) #

Is video for this participant muted by host?

Example:

xxxxxxxxxx
10
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    // value could be true or false
6
    meeting.checkAsync('isParticipantVideoForceMuted', participant.id).then(value => { console.log(value); });
7
  };
8

9
  meeting.once('meetingJoined', meetingJoinedLsnr);
10
};

set('audioModeration', true) #

If set to true, the host will have control whether they want to allow a participant to switch ON microphone.

Example:

See Here

set('videoModeration', true) #

If set to true, the host will have control whether they want to allow a participant to switch ON camera.

Example:

See Here

set('avatarUrl', avatarUrl) #

Sets the display picture URL for the local participant. You can set this to a compressed public image URL. Display picture will appear instead of display name when the participant's video is turned off.

Example:

xxxxxxxxxx
19
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    meeting
6
      .set('avatarUrl', 'https://path/to/compressed/avatar/image')
7
      .set('displayName', 'John Doe')
8
      .set('localSubject', 'Local Subject')
9
      .set('onStageParticipant', participant.id)
10
      .set('tileView', false)
11
      .set('participantsPaneVisibility', true)
12
      .set('email', 'example@clanmeeting.com')
13
      .set('noiseSupression', false)
14
      .set('largeVideoSize', 500, 500)
15
      .set('filmstripSize', 200);
16
  };
17

18
  meeting.once('meetingJoined', meetingJoinedLsnr);
19
};

set('displayName', participantName) #

Sets the display name for the local participant.

Example:

See Here

set('localSubject', subject) #

Local subject is visible to the local participant only and can be used to set different meeting subjects for different participants.

Example:

See Here

set('noiseSupression', true) #

Enable noise suppression. Uses more CPU on client devices.

Example:

See Here

set('onStageParticipant', participantId) #

Set the participant whose video needs to be shown on stage.

Example:

See Here

set('tileView', true) #

Turn on or off tile view where participant videos are arranged in the form of tiles.

Example:

See Here

set('followMe', true) #

If set to true, everyone follows what host does on the screen.

Example:

See Here

set('participantVolume', participantId, volumeLevel) #

Set the microphone volume per participant.

Example:

Sets participant volume to 20% as soon as any participant joins.

xxxxxxxxxx
19
1
window.onload = function () {
2
  meeting.start();
3

4
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
5
    const roleChangedLsnr = function roleChangedLsnr(event) {
6
      if (event.role === 'moderator') {
7

8
        const someoneJoinedLsnr = function someoneJoinedLsnr(participant) {
9
          meeting.set('participantVolume', participant.id, 0.2);
10
        };
11
        // whenever any remote participant joins
12
        meeting.on('someoneJoined', someoneJoinedLsnr);
13
      }
14
    };
15
    meeting.on('roleChanged', roleChangedLsnr);
16
  };
17

18
  meeting.once('meetingJoined', meetingJoinedLsnr);
19
};

set('largeVideoSize', width, height) #

Sets the size of the video on stage. On stage video resizes automatically by default.

Example:

See Here

set('subtitles', enabled, language) #

Enables or disables subtitles if transcription is supported.

Example:

See Here

set('filmstripSize', width) #

Sets the width of the filmstrip (the strip on the extreme right of the screen where participant thumbnails are visible).

Example:

See Here

set('password', password) #

Set meeting password.

Example:

See Here

set('email', email) #

Set email for the local participant.

Example:

See Here

set('subject', subject) #

This is a host privilege which sets the subject for all unlike localSubject.

Example:

See Here

set('participantsPaneVisibility', true) #

Whether to show or hide participants pane on the right side of the screen.

Example:

See Here

Set Method Examples #

xxxxxxxxxx
21
1
// host methods
2
window.onload = function () {
3
  meeting.start();
4

5
  const meetingJoinedLsnr = function meetingJoinedLsnr(participant) {
6
    const roleChangedLsnr = function roleChangedLsnr(event) {
7
      if (event.role === 'moderator') {
8
        meeting
9
          .set('followMe', true)
10
          .set('password', 'mysecret680')
11
          .set('subject', 'Subject')
12
          .set('audioModeration', false)
13
          .set('videoModeration', false)
14
          .set('subtitles', true, 'en');
15
      }
16
    };
17
    meeting.on('roleChanged', roleChangedLsnr);
18
  };
19

20
  meeting.once('meetingJoined', meetingJoinedLsnr);
21
};

exec('enableLobby', true) #

Enable lobby for the meeting.

Example:

See Here

exec('hangup') #

Hang up the local participant only. DOES NOT end the meeting for everyone.

Example:

See Here

exec('endConference') #

Ends the meeting for everyone. Can only be executed by the moderator.