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.
x1const optionalProperties = {
2 roomName: 'unique-room-name',
3 displayName: 'John Doe',
4 jwt: 'token-for-host',
5 elementId: 'my-meeting',
6};
7const domain = 'clanmeeting-domain';
8const consumerId = 'clanmeeting-consumer-id';
9const meeting = new ClanMeeting(domain, consumerId, optionalProperties);
10
11window.onload = function() { meeting.start(); }
12window.onunload = function() { meeting.end(); }
All Meeting Properties
domain
Clan Meeting domain name (first mandatory argument)
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
String | empty | false | true |
consumerId
Clan Meeting consumer ID (second mandatory argument)
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
String | empty | false | true |
roomName
Unique meeting room name (lowercase alphabets, digits, dashes and underscores only).
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
String | empty | false | true |
displayName
Display Name of the meeting user as visible to other users. Display names are also captured as a part of attendance.
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
String | empty | false | true |
jwt
Required only by the host to join/start a meeting. Participants do not need to pass a JWT.
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
String | empty | true | true (for host) |
autofillPassword
Setting this to the meeting password enables a participant to bypass the password prompt programmatically without revealing the password.
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
String | empty | true | true (for host) |
avatarUrl
Set avatar image URL for the meeting users. Use compressed images.
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
String | empty | false | false |
elementId
Meeting DOM element.
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
String | my-meeting | false | false |
enableClanMeetingApps
Shows Clan Meeting app download page for mobile users. Disabling this opens the meetings directly on mobile browser.
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
Boolean | false | false | false |
enableFollowMe
Everyone follows the host.
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
Boolean | false | true | false |
enableJoinMeetingPage
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
Boolean | false | false | false |
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.
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
Boolean | false | false | false |
enableMobileView
Optimizations for responsiveness.
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
Boolean | true | false | false |
enableModeratorIndicator
Indicated by a "Star" symbol.
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
Boolean | true | false | false |
initialZoom
Initial zoom level in smaller devices.
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
Number | 1.0 | false | false |
maxZoom
Set maximum zoom level on smaller devices. Useful to zoom in to shared screen on mobile devices.
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
Number | 1.0 | false | false |
muteAudioOnJoin
Initial mic status when local participant joins a meeting.
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
Boolean | true | false | false |
muteVideoOnJoin
Initial camera status when local participant joins a meeting.
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
Boolean | true | false | false |
toolbarButtons
Show these toolbar buttons (desktop = screen sharing and etherpad = whiteboard).
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
Array | ['camera', 'chat', 'closedcaptions', 'desktop', 'download', 'embedmeeting', 'etherpad', 'feedback', 'filmstrip', 'fullscreen', 'hangup', 'help', 'invite', 'livestreaming', 'microphone', 'mute-everyone', 'mute-video-everyone', 'participants-pane', 'raisehand', 'recording', 'security', 'select-background', 'settings', 'shareaudio', 'sharedvideo', 'shortcuts', 'stats', 'tileview', 'toggle-camera', 'videoquality', '__end'] | false | false |
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.
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
String | empty | true | false |
localSubject
Subject shown beside the timer for the local participant.
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
String | empty | false | false |
subject
Subject as shown to all participants beside the timer.
type | default | needsHostPrivilege | isRequired |
---|---|---|---|
String | empty | true | false |