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.

xxxxxxxxxx
12
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.

audioLevelsInterval #

How frequently is audio level updated.

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.

disabledSounds #

Disable the following sounds.

'ASKED_TO_UNMUTE_SOUND', 'INCOMING_MSG_SOUND', 'KNOCKING_PARTICIPANT_SOUND', 'LIVE_STREAMING_OFF_SOUND', 'LIVE_STREAMING_ON_SOUND', 'NO_AUDIO_SIGNAL_SOUND', 'NOISY_AUDIO_INPUT_SOUND', 'OUTGOING_CALL_EXPIRED_SOUND', 'OUTGOING_CALL_REJECTED_SOUND', 'OUTGOING_CALL_RINGING_SOUND', 'OUTGOING_CALL_START_SOUND', 'PARTICIPANT_JOINED_SOUND', 'PARTICIPANT_LEFT_SOUND', 'RAISE_HAND_SOUND', 'REACTION_SOUND', 'RECORDING_OFF_SOUND', 'RECORDING_ON_SOUND', 'TALK_WHILE_MUTED_SOUND'

enable1On1Mode #

Hide remote thumbnails when in a 1-on-1 conference call.

enableWebinarMode #

Enables the webinar mode in Clan Meeting. If you need webinar mode, this property needs to be set for both the host and the participants.

enableAddingBackgroundImages #

Allow participants to add their own virtual background images.

enableAudioLevels #

Show audio levels when participants speak.

enableAutoKnockLobby #

Automatically knock when lobby is enabled. If set to false, participant has to click on the lobby button to request access to the meeting room.

enableChatSmileys #

enableClanMeetingApps #

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

enableConferenceTimer #

enableConnectionIndicators #

Display connection indicators on participant thumbnails that show the connection status.

enableConnectionIndicatorsAutoHide #

connectionIndicatorsAutoHideTimeout #

Autohide connection indicators above participant thumbnails after these many milliseconds.

enableConnectionIndicatorsDetails #

Show connection details when connection indicators are hovered upon.

enableConnectionIndicatorsInactive #

Enable connection indicator for inactive participants.

enableDisplayName #

enableEmailInSettings #

elementId #

Meeting DOM element.

enableFollowMe #

Everyone follows what the host does on his screen.

enableGrantModerator #

Allow host to grant moderator access to a participant by hovering on the three dots over participant thumbnail.

enableInsecureRoomNameWarning #

Shows a warning if you are using insecure room names.

enableInviteFunctions #

Allow to invite others into the meeting.

enableJoinMeetingPage #

Shows a join meeting page where the participants can test their mic and camera.

enableJoinMeetingPageDisplayName #

Enable editing of display name on the join meeting page.

enableKickParticipant #

Kick unwanted participants.

enableLobbyButton #

enableLobbyChat #

Allow chatting between the people waiting in the lobby and the host.

enableLocalVideoFlip #

Flip the local video.

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.

enableMandatoryDisplayName #

Make display names mandatory.

enableMobileView #

Optimizations for responsiveness.

enableModeratorIndicator #

Indicated by a "Star" symbol.

enableMuteParticipant #

Allow muting other participants.

enableNoAudioDetection #

Shows a notification if someone is trying to speak while on mute.

enableNoisyMicDetection #

Shows a notification if a participant's background is noisy.

enableParticipantsPaneModeratorSettings #

enableParticipantsPaneMoreActionsButton #

enableParticipantsPaneMuteAllButton #

enablePolls #

enablePrivateChat #

Allows private chatting amongst participants.

enableProfile #

enableReactions #

enableReactionsModeration #

enableReadOnlyName #

Makes the display names read only. Useful if you do not want to allow participants to edit their names and you want to enforce names set by the API displayName property.

enableRecordingLabel #

Shows a recording icon when recording is on.

enableRemoteVideoMenu #

Shows three dot icon on participant thumbnails.

enableRemoveRaisedHandOnFocus #

Removes raised hand automatically when the raised hand participant speaks.

enableResponsiveTiles #

enableScreensharingVirtualBackground #

Enables shared screen as virtual background.

enableSelfView #

enableSelfViewSettings #

enableShortcuts #

enableSilentMode #

Disable any sounds coming from another participants.

enableSpeakerStatsSearch #

Allows participant search bar on the speaker stats dialog.

enableStereoAudioQuality #

Enables HD audio quality. Remember that enabling this disables other audio optimizations like noise cancellation. Used with audioQualityMaxBitRate.

audioQualityMaxBitRate #

enableStereoAudioQuality should be set to true for this. Ranges between 6000 and 51000.

enableTileEnlargement #

In tileview.

enableTileView #

Enables tile (grid) view for the participants.

enableWhiteboardOnJoin #

Turns on whiteboard by default.

initialZoom #

Initial zoom level in smaller devices.

joinMeetingPageButtons #

Show these buttons on the Join Meeting page.

lang #

Language.

localSubject #

Subject shown beside the timer for the local participant.

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.

noticeMessage #

Displays a notice at the top. Used for showing an important message to the participants.

overriddenToolbarButtons #

Override the default behavior of the above toolbarButtons with your custom logic when one of these buttons is clicked. Used often in conjunction with overriddenToolbarButtonClicked event.

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.

subject #

Subject as shown to all participants beside the timer.

tileViewNumberOfVisibleTiles #

Number of participants visible in the tile view.

toolbarButtons #

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

Note that notepad (etherpad) is a private notepad and whiteboard is a collaborative notepad visible and editable by all participants. One can share the private notepad using screen sharing if they do not want to allow edits to their board.