Microsoft Teams Room (MTR)
You can integrate Q-SYS with a Microsoft Teams Room compute (PC) and room console. Integration of a Q-SYS system into a Microsoft Teams Room requires multiple Q-SYS software elements. Read this topic to understand what software elements are required, and to follow step-by-step guidance on getting your Teams Room integration up and running.
Tip: To learn about the strategic alliance between QSC and Microsoft Teams, to see examples of spaces featuring Teams Room with Q-SYS integration, and to read application documentation, go to the Q-SYS + Microsoft Teams page on the Q-SYS website.
Click an element to learn more.
Q-SYS Designer Software version 9.0.0 and later is required.
The Q-SYS Software Feature License for Microsoft Teams Rooms is a single SKU that enables two software features on the Q-SYS Core processor:
- Q-SYS Scripting Engine
- Q-SYS UCI Deployment
Note: If your Core already has active licenses for both scripting and UCI deployment, the Q-SYS Software Feature License for Microsoft Teams Rooms is not needed. Refer to the Licensing topic for Core model support.
This sample design file enables Q-SYS to meet Microsoft Teams Room experience expectations, including audio DSP signal flow, DSP settings, room type optimization, and loudspeaker configuration optimization. The design file can be augmented with other DSP and control programming as long as the required signal flow remains intact.
The Teams Sample design is available in Asset Manager and includes the Mobile Device Companion App
The Mobile Device Companion App is a UCI embedded in the Teams Sample Design. Use it to fine-tune and optimize the DSP parameters in the design based on room acoustics.
Access the Mobile Device Companion App using a mobile device with network access to the Core. This could be via the HTML5 UCI viewer in Core Manager or from the Q-SYS Control app for iOS devices.
Tip: If you adjust the DSP settings in the Mobile Device Companion App and later change your mind, you can easily start over in the companion app and repeat the process with the default Teams-certified settings.
Q-SYS Webhooks is a Lua script that is part of the Teams Sample Design. It automatically reports back to a Webhook that can be set up as a Connector on a Microsoft Teams Channel. This is useful for sending messages to IT departments when room optimization is complete (using the Mobile Device Companion App) or when settings in optimized rooms are changed and may be impacting the performance of the system.
The Teams UCI Style is included with the Teams Sample Design and also available for download separately via Asset Manager. Use it to apply CSS classes to controls in a native Q-SYS UCI. The CSS Style automatically applies colors, fonts, and control style information to match the Teams Room aesthetic.
To see a list of Teams style classes and examples for each, refer to the CSS Class Reference in the UCI Styles topic.
Q-SYS Control for MTR is an application, installed on the Microsoft Teams Room compute via .exe installer, that allows the Teams Room console to display any Q-SYS UCI deployed on the Core – typically for room control. An icon appears on the Teams Room touch panel to switch over to Room Control mode to view the Q-SYS UCI. You can then switch back to the native Teams Room console display when ready.
The Q-SYS Control for MTR .exe installer is included with the Q-SYS Designer Software download and also available separately from the Q-SYS Software and Firmware website.
The Q-SYS MTR Component connects to the Q-SYS Control for MTR application running on the Microsoft Teams Room compute. Use it to obtain the status of that connection and define what UCI is displayed on the Microsoft Teams Room console.
Follow these steps to get your Q-SYS system integrated with a Microsoft Teams Room. Before proceeding:
-
Consult your network administrator and the Microsoft Teams Deployment Overview (provided by Microsoft) for details on getting your Microsoft Teams Room compute device running.
Tip: Watch the Integrating Microsoft Teams Rooms into Q-SYS video from QSC Training for an overview of the integration process.
See the Licensing topic to review feature licensing requirements and for license activation instructions on the Q-SYS Core processor.
Download and install Q-SYS Designer version 9.0.0 and later from the Q-SYS Software and Firmware website.
The Q-SYS Control for MTR .exe installer is included with the Designer download bundle. Or, you can download separately from the Q-SYS Software and Firmware website. Follow this procedure to install the application on the Microsoft Teams Room compute.
Note: Install the application on the Teams Room compute, not the PC running Q-SYS Designer Software.
- Ensure that the Teams Rooms platform is already installed and running on the Teams Room compute.
- Copy the Q-SYS Control for MTR Installer.exe file to a thumb drive.
- Insert the thumb drive into a USB port on the Microsoft Teams Room compute.
- On the Teams Room console, tap More > Settings.
- On the User Account Control prompt, type the Administrator password, and then tap Yes. If you do not know the password, consult your IT administrator.
- On the Settings page, tap Windows Settings.
- In the lower left corner, tap the Administrator user and log in with the Administrator password.
- In Windows, use File Explorer to navigate to the USB thumb drive.
- Double-tap the .exe installer file.
- Follow the prompts to install the Q-SYS Control for MTR application and reboot the Microsoft Teams Room compute.
In Q-SYS Designer, go to Tools > Show Asset Manager (or click from the toolbar) to find, select, and download the Teams Sample Design.
Go to File > Open Sample Design and select the Teams Sample Design to open. Then, select File > Save to Core & Run (or press F5) to deploy the design to the Core.
Tip: For help with saving designs to the Core, see the Loading and Saving Designs topic.
On the Teams Room console:
- Tap More > Settings.
- Enter the system password.
- Select Peripherals from the left pane.
- In the center window, select "Echo Canceling Speakerphone (Core110f)" for the Microphone, Speaker, and Default Speaker boxes.
- Tap Save and Exit to go back to the main control window.
The Sennheiser TCC2 is a ceiling-mounted dynamic beamforming microphone that supports Dante for audio transport. The Sennheiser Control Cockpit software is required to begin the setup process. With your PC and the TCC2 Ethernet PoE/Ctrl port connected to the network switch, the browser-based Control Cockpit interface uses mDNS to detect and identify the TCC2.
- Click the Devices tab.
- Select the TCC2 mic to open its properties.
- Click the Ethernet tab to configure its IP address, and then click Save.
Note: Make a note of the mic's IP address, as you will use it later in the setup process when configuring the Teams Sample Design.
- Click the Audio tab. The Source Detection section shows the current focus of the TCC2 automatic beam-steering, which can be tracked in real time. Click Edit to manually configure vertical and horizontal exclusion zones, which prevents detection of noise and sounds in these zones – for example, from ceiling-mounted AC vents, projector fans, doors, and credenzas.
Tip: In some reverberant environments, applying an exclusion zone directed toward the front of the room and in the direction of the video display can improve AEC performance. Refer to the Sennheiser TeamConnect Ceiling 2 instruction manual for more information.
With the Teams Sample Design running on the Core, follow the Room Setup steps in the design:
Step 1: Room Name
Type a unique name/identifier for the room.
Step 2: Loudspeaker Type
Select where your room's loudspeaker's are installed, Ceiling or Surface. This selection determines the options for Loudspeaker Model.
Step 3: Loudspeaker Model
For each output, select the installed QSC loudspeaker model.
Step 4: Microphone
Configure the communication parameters for the Sennheiser TCC2 microphone:
- Control IP address: Specify the microphone's control IP address, which is obtainable from the Sennheiser Control Cockpit software.
- Dante receive: Select the appropriate Dante device and channel for the microphone.
- Dante transmit: To send audio back to the microphone as a reference, specify a unique channel name for this purpose. Then, use Dante Controller software to route that channel from the Core back to the microphone.
Step 5: Microsoft Teams Room Compute
This configures the MTR component in the sample design.
- MTR IP address: Specify the IP address of the PC that is running the Microsoft Teams Rooms software. This is visible on the idle screen of the Q-SYS Control for MTR application when you switch to the Room Controls view (when the application is not connected to the Core).
- Room Console UCI: Select the UCI from the design file to display on the Teams Room console. For now, you can leave this set to the room controls sample UCI.
Step 6: Webhook
Paste the unique Webhook URL for the Teams Room. This allows the Core to post messages in a Teams channel about design status, including whether audio parameters have been adjusted and may be impacting system performance or are using certified settings.
Step 7: Mobile Device Companion App
From a mobile device with network access to the Q-SYS Core:
- Scan the QR code to load the Mobile Device Companion App. (Alternatively, you can open Core Manager, navigate to the User Control Interfaces page, and select the "Companion App" UCI.)
- Follow the instructions to fine-tune the audio settings for your specific room.
- At the end of the process, save the settings. This generates a Webhook message that commissioning is complete for the room.
Build a Q-SYS UCI to display on the Teams Room console for users to control and monitor camera selection and positioning, displays, HVAC, shades, mic and loudspeaker meters, etc.
Tip: You can modify the Room Controls sample UCI (included with the Teams Sample Design) for your own application.
- Disconnect from the running Teams Sample Design (F7).
- From the navigation pane, click User Control Interfaces.
- Click to create a new UCI.
- Add controls to the UCI. For information about creating UCIs, see User Control Interface (UCI) Design Overview.
- From the navigation pane, select your UCI name.
- From the User Control Interface Properties, select "Teams" as the Style. (The Teams style is included with the Teams Sample Design.)
- For each control (text box, button, etc.), assign a CSS Class Name from the drop-down menu. To see a list of Teams style classes and examples for each, refer to the CSS Class Reference in the UCI Styles topic.
Tip: The Teams style CSS classes automatically apply the colors, fonts, and control style information to match the Microsoft Teams Rooms aesthetic.
- Save and run the Teams Sample Design to the Core, which now includes your Q-SYS room controls UCI.
- On the Teams Room console, switch to Room Controls by tapping the fader icon in the bottom right corner. The Q-SYS UCI should display.
Tip: If you are in a call, you can switch to Room Controls by tapping the . . . icon at the bottom of the screen and then tapping Room Controls.
The Teams Sample Design includes an Advanced Configurations section for tweaking the audio, video, and control components for your specific room. Double-click a component's icon to understand the effects of changing its controls.
Note: The Q-SYS sample design file includes audio signal flow and processing settings that meet Microsoft Teams Rooms certification. We recommend using this design file. If you cannot, you should ensure that the signal integrity and gain structure is maintained to meet Microsoft Teams Rooms performance expectations.
Name
The Name may contain ASCII letters 'a' through 'z' (case-insensitive), the digits '0' through '9', and the hyphen. Names cannot begin or end with a hyphen. No other symbols, punctuation characters, or blank spaces are permitted.
Location
User-defined name that groups the component with other components in the same physical location, or in the same organizational scheme.
UCI Assignment
When set to Static (default), only the UCI as specified in Properties is displayed on the Teams Room console. When set to Dynamic, you can select the UCI while the design is running.
UCI
This field displays only when the UCI Assignment is set to Static. Use the pull-down list to select the UCI assigned to display on the Teams Room console. The UCI selection cannot be changed while the design is running.
Status
Component status is conveyed with the Status LED and Status box, which uses both color and text to indicate the current condition:
- OK: The device is functioning normally.
- Initializing: The device is in the process of a firmware or configuration update, or the design is starting.
- Compromised: The device is functioning, but a non-fatal problem exists. Refer to the Status box for details.
- Missing: The device cannot be discovered.
- Fault: The device is malfunctioning or is not properly configured. Refer to the Status box for details.
- Unknown: This status appears during a Core reboot (for example, during a firmware update), or when a design is being uploaded to the Core and before it has started running.
- Not Present: If applicable to the device, this status appears when the device is not connected to the network and its Is Required component property is set to 'No'. This status also appears if the device component's Dynamically Paired property is set to 'Yes', pairing has not been assigned in Core Manager, and the device component's Is Required property is set to 'Yes'. See Dynamic Pairing.
IP Address / Host
Specify the IP address of the PC that is running the Microsoft Teams Rooms software.
UCI
If the UCI Assignment property is set to Dynamic, select the UCI from the design file to display on the Teams Room console. If the UCI Assignment property is set to Static, this control only shows the selected UCI as configured in the UCI property.
Page
Select the UCI page to display on the Teams Room console.
UCI Visible
LED indicates whether the Room Controls screen is active on the Microsoft Teams Room console.
Show
When triggered, the Room Controls screen is shown with the currently assigned UCI on the Microsoft Teams Room console.
Hide
Hide functionality is supported with Q-SYS Designer Software version 9.5 and later and the Q-SYS Control for MTR app version 9.5 and later. When triggered, the Room Controls screen is hidden on the Microsoft Teams Room console.
Note: There is a brief delay between pressing the Hide button and the UCI Visible LED indicating the current status.
Pin Name |
Value |
String |
Position |
Pins Available |
---|---|---|---|---|
Current Page |
(text) |
Input / Output |
||
Current UCI |
(text) |
Output |
||
Hide UCI |
(trigger) |
Input / Output |
||
MTR IP Address |
- |
nnn.nnn.nnn.nnn |
- |
Input / Output |
Show UCI |
(trigger) |
Input / Output |
||
Status |
0 1 2 3 4 5 |
OK (Green) Compromised (Orange) Fault (Red) Not Present (Gray) Missing (Red) Initializing (Blue) |
- |
Output |
UCI Visible |
0 1 |
false true |
0 1 |
Output |