Pexip Meeting Controls for Cisco Endpoints

When using a Cisco endpoint, you can enhance your Microsoft Teams meeting room experience with Pexip Meeting Controls for Cisco Endpoints. Using this feature, while in a Teams meeting you can use the Cisco endpoint's touch panel to:

  • change the conference layout
  • enable/disable the overlay text (the names of the participants or endpoints)
  • spotlight a participant
  • view the participants list
  • view who is presenting
  • view who is spotlighted
  • view who has raised their hand
  • view a participant's mute state.

Pexip Meeting Controls also automatically synchronizes the endpoint's local mute state with its mute state in the Teams participant list.

On this page:

Supported endpoints and conferences

The Pexip Meeting Controls feature is supported:

  • on Cisco Room Devices MX, SX, DX and Room Kit Series, but not SX10. Firmware CE9.13 or newer required for all.
  • in Microsoft Teams conferences.

Prerequisites

  • Admin user access to the Cisco endpoint for configuration.
  • Pexip Infinity version 29 or newer.
  • A Teams Connector as part of your Pexip deployment.

Downloads

The Pexip Meeting Controls feature uses a Meeting Controls macro that is installed on the Cisco endpoint. During the macro installation, you require the following files:

  • macro file: this is the macro that is uploaded to the endpoint
  • settings file: this file contains settings for the macro; these settings must be customized for your organization before being uploaded to the endpoint.

Information on how to access and save these files is given below.

Macro file

Download the following file:

Download link Required?
meeting-controls-macro.js This file is required in all installations but you do not need to customize it.

Settings file

Below is an example file that contains the settings for the Meeting Controls macro. You must customize these settings for your organization:

  1. Copy the settings below.
  2. Open the settings in Notepad or a tool of your choice.

  3. Make the following edits:

    Note that when using regex within javascript as we are doing here, any . characters must be escaped within the regex (i.e. \.), and the escape character itself must be escaped within javascript. For example, if the domain is pexample.com, this must be included in the regex field as pexample\\.com

    • For nodeURL and regex, edit <DOMAIN> with the relevant domain for your organization. For Pexip Infinity deployments, this will be the IP address or FQDN of a Conferencing Node or reverse proxy in your deployment.

    • For regex, you may need to customize |teams to match the IVR address used in your organization.

    • For layouts, you can include any supported layouts by using the PexRTC client API layout codes.

  4. Save the settings file as meeting-controls-settings.js
Copy to clipboard 
const meeting_controls_settings = {
 "services": [
  {
   "nodeURL": "https://<DOMAIN>/api/client/v2/conferences",
   "layouts": ["1:0", "1:7", "ac", "4:0"],
   "regex": "^({{teamsMeetingId}}|teams)@<DOMAIN>$",
   "shouldMCUMute": false,
   "sendSessionID": false,
   "panelSettings": {
    "controls": ["layout", "overlayText"],
    "roster": true
   }
  }
 ],
 "InCallButton": {
  "panelId": "panel_pex_in",
  "type": "InCall",
  "icon": "Info",
  "name": "Meeting Controls"
 },
 "LayoutButton": {
  "panelId": "layout_panel",
  "type": "Never",
  "icon": "Info",
  "name": "Change Layout"
 }
}

Manual installation of Pexip Meeting Controls

The following instructions explain how to install the Meeting Controls macro and settings manually on a single endpoint. If you use Enhanced Room Management (ERM) and want to provision the macro on multiple endpoints simultaneously, proceed to ERM installation of Pexip Meeting Controls.

  1. Log into the web interface of your Cisco endpoint in your browser.

  2. Go to Macro Editor.

  3. Select Enable Macros. This prompt only appears if you have never used a macro before.
  4. In the Macro Editor, select Import from file and select the settings file (meeting-controls-settings.js) that you edited and saved earlier.

  5. Select the Save to video system icon:

  6. Select Import from file again and select the macro file (meeting-controls-macro.js) that you downloaded earlier.

  7. Select the Save to video system icon:

  8. Toggle the meeting-controls-macro from off to on:

  9. Refresh the web page.

With immediate effect, during Teams conferences the touch panel of the Cisco endpoint shows the additional control features.

Troubleshooting

If you need to troubleshoot the Meeting Controls macro at any point, you can download logs from the web interface in

System Maintenance > Issues and Diagnostics > Systems logs > Download logs...

ERM installation of Pexip Meeting Controls

If you use Enhanced Room Management (ERM), you can enable Pexip Meeting Controls on multiple endpoints simultaneously.

Installing Meeting Controls macro in ERM

  1. Go to Enhanced Room Management > Panels and macros.

  2. On the Room Controls tab, select the + button.

  3. Enter a title and description for the settings.
  4. Attach the settings file that you downloaded earlier and select Add.
  5. Again, select the + button.
  6. Enter a title and description for the macro.
  7. Attach the macro file that you downloaded earlier and select Add.

The Meeting Controls macro and settings are now installed in ERM.

Provisioning Pexip Meeting Controls on multiple endpoints in ERM

The following instructions explain how to provision one or more Cisco endpoints in ERM with Pexip Meeting Controls.

  1. Go to Enhanced Room Management > Systems.
  2. On the Search tab, select all room systems that you want to deploy the Pexip Meeting Controls to.
  3. Select Provisioning.
  4. Select Apply macros/panels and from the Controls options select Meeting Controls macro.

  5. To enable the macro on the endpoints with immediate effect select Apply, otherwise select Schedule for the night.