Properties

Use these properties to initialize the meeting with your preferred settings and UI. Use events and methods for further customizations while the conference is in progress or when it ends.

ClanMeeting Constructor

domain and consumerId are mandatory arguments and need to be passed in the respective order.

new ClanMeeting(domain, consumerId, [optionalProperties])

Example Usage

Use the ClanMeeting constructor to set different meeting properties as follows.

Initialize a meeting with optionalProperties for more control.

​x
1
const optionalProperties = { 
2
    roomName: 'unique-room-name',
3
    displayName: 'John Doe',
4
    jwt: 'token-for-host',
5
    elementId: 'my-meeting',
6
};
7
const domain = 'clanmeeting-domain';
8
const consumerId = 'clanmeeting-consumer-id';
9
const meeting = new ClanMeeting(domain, consumerId, optionalProperties);
10

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

All Meeting Properties

domain

Clan Meeting domain name (first mandatory argument)

consumerId

Clan Meeting consumer ID (second mandatory argument)

roomName

Unique meeting room name (lowercase alphabets, digits, dashes and underscores only).

displayName

Display Name of the meeting user as visible to other users. Display names are also captured as a part of attendance.

jwt

Required only by the host to join/start a meeting. Participants do not need to pass a JWT.

autofillPassword

Setting this to the meeting password enables a participant to bypass the password prompt programmatically without revealing the password.

avatarUrl

Set avatar image URL for the meeting users. Use compressed images.

elementId

Meeting DOM element.

enableClanMeetingApps

Shows Clan Meeting app download page for mobile users. Disabling this opens the meetings directly on mobile browser.

enableFollowMe

Everyone follows the host.

enableJoinMeetingPage

enableLowBandwidthMode

Local participant will not see any video to save bandwidth even if the remote participants have their videos turned on. Meeting will continue as usual for others.

enableMobileView

Optimizations for responsiveness.

enableModeratorIndicator

Indicated by a "Star" symbol.

initialZoom

Initial zoom level in smaller devices.

maxZoom

Set maximum zoom level on smaller devices. Useful to zoom in to shared screen on mobile devices.

muteAudioOnJoin

Initial mic status when local participant joins a meeting.

muteVideoOnJoin

Initial camera status when local participant joins a meeting.

toolbarButtons

Show these toolbar buttons (desktop = screen sharing and etherpad = whiteboard).

password

Sets the meeting password to this and locks meeting automatically as soon as the host joins. Needs host privilege. Setting this for non-hosts (participants) will have no effect.

localSubject

Subject shown beside the timer for the local participant.

subject

Subject as shown to all participants beside the timer.