Properties

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.

 

All Meeting Properties

 

domain

Clan Meeting domain name (first mandatory argument)

typedefaultneedsHostPrivilegeisRequired
Stringemptyfalsetrue

 

consumerId

Clan Meeting consumer ID (second mandatory argument)

typedefaultneedsHostPrivilegeisRequired
Stringemptyfalsetrue

 

roomName

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

If you do not pass a roomName in the options, you must use the generateRoomName() method to generate a secure random room name. roomName should be unique within your environment.

 

typedefaultneedsHostPrivilegeisRequired
Stringemptyfalsetrue

 

displayName

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

If you do not pass a displayName in the options, you must use the anonymizeDisplayName() method to generate a random participant name.

 

typedefaultneedsHostPrivilegeisRequired
Stringemptyfalsetrue

 

jwt

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

typedefaultneedsHostPrivilegeisRequired
Stringemptytruetrue (for host)

 

autofillPassword

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

 

typedefaultneedsHostPrivilegeisRequired
Stringemptytruetrue (for host)

 

avatarUrl

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

typedefaultneedsHostPrivilegeisRequired
Stringemptyfalsefalse

 

elementId

Meeting DOM element.

typedefaultneedsHostPrivilegeisRequired
Stringmy-meetingfalsefalse

 

enableClanMeetingApps

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

typedefaultneedsHostPrivilegeisRequired
Booleanfalsefalsefalse

 

enableFollowMe

Everyone follows the host.

typedefaultneedsHostPrivilegeisRequired
Booleanfalsetruefalse

 

enableJoinMeetingPage

typedefaultneedsHostPrivilegeisRequired
Booleanfalsefalsefalse

 

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.

typedefaultneedsHostPrivilegeisRequired
Booleanfalsefalsefalse

 

enableMobileView

Optimizations for responsiveness.

typedefaultneedsHostPrivilegeisRequired
Booleantruefalsefalse

 

enableModeratorIndicator

Indicated by a "Star" symbol.

typedefaultneedsHostPrivilegeisRequired
Booleantruefalsefalse

 

initialZoom

Initial zoom level in smaller devices.

typedefaultneedsHostPrivilegeisRequired
Number1.0falsefalse

 

maxZoom

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

typedefaultneedsHostPrivilegeisRequired
Number1.0falsefalse

 

muteAudioOnJoin

Initial mic status when local participant joins a meeting.

typedefaultneedsHostPrivilegeisRequired
Booleantruefalsefalse

 

muteVideoOnJoin

Initial camera status when local participant joins a meeting.

typedefaultneedsHostPrivilegeisRequired
Booleantruefalsefalse

 

toolbarButtons

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

typedefaultneedsHostPrivilegeisRequired
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']falsefalse

 

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.

In case of multiple hosts joining a meeting (co-hosts) remember to set this to the same password for all hosts to avoid unexpected behavior.
typedefaultneedsHostPrivilegeisRequired
Stringemptytruefalse

 

localSubject

Subject shown beside the timer for the local participant.

typedefaultneedsHostPrivilegeisRequired
Stringemptyfalsefalse

 

subject

Subject as shown to all participants beside the timer.

typedefaultneedsHostPrivilegeisRequired
Stringemptytruefalse