Advanced Meeting Controls

• Introduction
• Available Controls
• Screen Recording
  • Start a Recording
  • Pause a Recording
  • Resume a Recording
  • Stop a Recording
• Lock Meeting
  • Locking a meeting
  • Unlocking a meeting
• Sending DTMF Tones
• Transcription
  • How to enable a meeting to receive transcription?
  • Start Receiving Transcription
  • Stop Receiving Transcription
• Using Phone Audio
• Effects: Meeting Audio & Video

Introduction

This is a wiki that discusses some of the advanced meeting controls available in the Webex Web SDK for Meetings.

Available Controls

The advanced meeting controls can be classified as follows,

• Screen Recording
• Lock a Meeting
• Send DTMF tones
• Transcription
• Using a Phone audio
• Effects for Audio and Video.

Screen Recording

Once the meeting is created and joined, the screen recording controls shall be invoked.

Start a Recording

To start a recording, the following API available in a meeting object needs to be called,

await meeting.startRecording();

Asynchronous	Yes
Parameters	None
Returns	Promise<undefined>

Pause a Recording

When the recording has already started, one can pause and resume the recording. Below is a code example of how to do that,

await meeting.pauseRecording();

Asynchronous	Yes
Parameters	None
Returns	Promise<undefined>

Resume a Recording

A recording that is started and then paused can be resumed using the following API,

await meeting.resumeRecording();

Asynchronous	Yes
Parameters	None
Returns	Promise<undefined>

Stop a Recording

A recording that is started can be stopped as shown below,

await meeting.stopRecording();

Asynchronous	Yes
Parameters	None
Returns	Promise<undefined>

Lock Meeting

A meeting is locked means that no other participant could join the meeting unless let in. A meeting can be locked only by a participant who is also a moderator of the meeting.

Locking a meeting

To lock a meeting, the following API needs to be invoked,

await meeting.lockMeeting();

Asynchronous	Yes
Parameters	None
Returns	Promise<undefined>

Unlocking a meeting

To unlock a locked meeting, the following API needs to be invoked,

await meeting.unlockMeeting();

Asynchronous	Yes
Parameters	None
Returns	Promise<undefined>

Sending DTMF Tones

The meetings SDK can be used to send DTMF tones in a meeting and it can be done as follows,

await meeting.sendDTMF(DTMFStringToBeSent);

Asynchronous	Yes
Parameters	Sl. No Parameter Name Parameter Type Mandatory Description 1 DTMFStringToBeSent String Yes This String represents the DTMF tone to be sent
Returns	Promise<undefined>

Transcription

The meeting transcription happens at the backend and this transcription can be received by listening to an event on the meetings SDK. To start receiving transcription,

• The Webex Assistant needs to be enabled in a meeting
• The Meeting should also be enabled to receive transcription

How to enable a meeting to receive transcription?

A meeting shall be enabled to receive transcription at the time of joining a meeting as shown below,

await meeting.join({ receiveTranscription: true });

Start Receiving Transcription

A meeting can start receiving transcription information from the Webex backend by subscribing to the following event,

const transcriptionContent = document.getElementById('transcript-content');
meeting.on('meeting:receiveTranscription:started', (payload) => {
  transcriptionContent.innerHTML += `\n${JSON.stringify(payload)}`;
});

In this event, the payload we receive is a transcription string.

Stop Receiving Transcription

A meeting transcription can be stopped as mentioned below,

meeting.stopReceivingTranscription();

Asynchronous	No
Parameters	None
Returns	undefined

When the Webex backend stops sending transcription, the meeting:receiveTranscription:stopped event will be triggered and it can be listened to as shown below:

const transcriptionContent = document.getElementById('transcript-content');
meeting.on('meeting:receiveTranscription:stopped', () => {
  transcriptionContent.innerHTML = '';
});

(Note - The transcription sending is understood to be stopped only after the above event is received)

Using Phone Audio

In a meeting, when the audio is not clear or there are troubles in using the device audio (Desktop app, Mobile app, or Web app), Webex offers to dial-in to the meeting via PSTN calls. The following are the available controls,

• Use Phone Audio
• Disconnect Phone Audio

More information about this control and usage can be found at: Webex Web SDK Wiki: Use phone audio for SDK meeting Dial IN OUT

Effects: Meeting Audio & Video

On the Webex Meetings, there are three effects offered right now:

• Background Noise Removal for Webex Audio
• Background Blur for Webex Video
• Virtual Background for Webex Video

To enable these in a meeting, one needs a valid Webex access token. More information about these features and their usage can be found here: Webex Web SDK Wiki: Audio & Video Effects.