Optimization for Microsoft Teams
Important:
Optimization for Microsoft Teams requires a minimum of Microsoft Teams version 1.2.00.31357.
Citrix delivers optimization for desktop-based Microsoft Teams using Citrix Virtual Apps and Desktops and Citrix Workspace app. By default, we bundle all the necessary components into the Citrix Workspace app and the Virtual Delivery Agent (VDA).
Our optimization for Microsoft Teams contains VDA-side HDX services and API to interface with the Microsoft Teams hosted app to receive commands. These components open a control virtual channel (CTXMTOP) to the Citrix Workspace app-side media engine. The endpoint decodes and renders the multimedia locally, moving the Citrix Workspace app window back into the hosted Microsoft Teams app.
Authentication and signaling occurs natively on the Microsoft Teams-hosted app, just like the other Microsoft Teams services (for example chat or collaboration). Audio/video redirection doesn’t affect them.
CTXMTOP is a command and control virtual channel. That means that media is not exchanged between the Citrix Workspace app and the VDA.
Only Client-fetch/client-render is available.
This video demo gives you an idea of how Microsoft Teams works in a Citrix virtual environment.
Microsoft Teams installation
Note:
We recommend installing the VDA before installing Teams in the golden image. This installation order is necessary for the ALLUSER=1 flag to take effect. If the virtual machine had Teams installed before the VDA was installed, uninstall and reinstall Teams. If you are using App Layering, see the App Layering instructions at the end of this section for more details.
We recommend you follow the Microsoft Teams machine-wide installation guidelines and avoid using the .exe installer that installs Teams in AppData. Instead, install in C:\Program Files (x86)\Microsoft\Teams by using the ALLUSER=1 flag from the command line.
msiexec /i <path_to_msi> /l*v <install_logfile_name> ALLUSER=1 ALLUSERS=1
This example also uses the ALLUSERS=1 parameter. When you set this parameter, the Teams Machine-Wide Installer appears in Programs and Features in the Control Panel and in Apps & features in Windows Settings for all users of the computer. All users can then uninstall Teams if they have administrator credentials. It’s important to understand the difference between ALLUSERS=1 and ALLUSER=1. You can use the ALLUSERS=1 parameter in non-VDI and VDI environments. Use the ALLUSER=1 parameter only in VDI environments to specify a per-machine installation.
In ALLUSER=1 mode, the Teams application doesn’t auto-update whenever there is a new version. We recommend this mode for non-persistent environments. For example, hosted shared apps or desktops out of a Windows Server or Windows 10 random/pooled catalogs. For more information, see Install Microsoft Teams using MSI (VDI Installation section).
You have Windows 10 dedicated persistent VDI environments. You want the Teams application to auto-update and would prefer Teams to install per-user under Appdata/Local, use the .exe installer or the MSI without ALLUSER=1.
For App Layering:
WARNING:
Editing the registry incorrectly can cause serious problems that might require you to reinstall your operating system. Citrix cannot guarantee that problems resulting from the incorrect use of Registry Editor can be solved. Use Registry Editor at your own risk. Be sure to back up the registry before you edit it.
Create an empty registry key named PortICA (leave the default Name, Type, and Data).
If using Citrix App Layering to manage VDA and Microsoft Teams installations in different layers, deploy this registry key on Windows before installing Teams with ALLUSER =1:
HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\PortICA
Or
HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Citrix\PortICA
Profile Management recommendations
We recommend using the machine-wide installer for Windows Server and Pooled VDI Windows 10 environments.
When the ALLUSER =1 flag is passed to the MSI from the command line (the machine-wide installer), the Teams app installs under C:\Program Files (x86) (~300 MB). The app uses AppData\Local\Microsoft\TeamsMeetingAddin for logs and AppData\Roaming\Microsoft\Teams (~600–700 MB) for user specific configurations, caching of elements in the user interface, and so forth.
Machine wide installer
The following is an example of folders, desktop shortcuts, and registries created by installing Teams machine-wide installer on a Windows Server 2016 64-bit VM:
Folder:
C:\Program Files (x86)\Microsoft\TeamsC:\Users\<username>\AppData\Roaming\Microsoft\Teams
Desktop Shortcut:
C:\Program Files (x86)\Microsoft\Teams\current\Teams.exe
Registry:
HKEY_LOCAL_MACHINE \SOFTWARE\WOW6432Node\Microsoft\Windows\CurrentVersion\RunHKEY_LOCAL_MACHINE \SOFTWARE\Microsoft\Windows\CurrentVersion\RunHKEY_CURRENT_USER \SOFTWARE\Microsoft\Windows\CurrentVersion\Run
Recommendations
- We recommend disabling auto-start by deleting the Teams registry keys. Doing so prevents “8AM logon storms” from spiking up the VM’s CPU.
- If the Virtual Desktop does not have a GPU/vGPU, we recommend setting Disable GPU hardware acceleration in the Teams Settings to improve performance. This setting (
"disableGpu":true) is stored in%Appdata%\Microsoft\Teamsinside thedesktop-config.jsonfile. You can use a logon script to edit that file and set the value to true. - If using Citrix Workspace Environment Management (WEM), enable CPU Spikes Protection to manage processor consumption for Teams.
Important:
If you don’t pass the ALLUSER=1 flag, the MSI places the Teams.exe installer and
setup.jsonunderC:\Program Files (x86)\Teams Installer. A registry key (TeamsMachineInstaller) is added under:HKEY_LOCAL_MACHINE \SOFTWARE\WOW6432Node\Microsoft\Windows\CurrentVersion\RunA subsequent user logon triggers the final installation in AppData instead.
Per-user installer
When using the .exe installer, the installation process changes significantly, and all the files are placed in AppData.
Folder:
C:\Users\<username>\AppData\Local\Microsoft\TeamsC:\Users\<username>\AppData\Local\Microsoft\TeamsPresenceAddinC:\Users\<username>\AppData\Local\Microsoft\TeamsMeetingAddinC:\Users\<username>\AppData\Local\SquirrelTempC:\Users\<username>\AppData\Roaming\Microsoft\Teams
Desktop Shortcut:
C:\Users\<username>\AppData\Local\Microsoft\Teams\Update.exe --processStart "Teams.exe"
Registry:
HKEY_CURRENT_USER \SOFTWARE\Microsoft\Windows\CurrentVersion\Run
Best Practices
The best practice recommendations are based on the use case scenarios. Using Teams with a non-persistent setup requires a profile caching manager for efficient Teams runtime data synchronization. Having a profile caching manager ensures that the appropriate user-specific information (for example, user data, profile, and settings) is cached during the user session. Make sure you synchronize the data in these two folders:
C:\Users\<username>\AppData\Local\Microsoft\IdentityCacheC:\Users\<username>\AppData\Roaming\Microsoft\Teams
Teams cached content exclusion list for non-persistent setup:
Exclude the following items from the Teams caching folder, %AppData%/Microsoft/Teams. Excluding these items helps reduce the user caching size to further optimize your non-persistent setup.
Exclusion list – files
- Roaming\Microsoft\Teams\* .txt
Exclusion list – directories
- Roaming\Microsoft\Teams\Logs
- Roaming\Microsoft\Teams\media-stack
- Roaming\Microsoft\Teams\Service Worker\CacheStorage
- Roaming\Microsoft\Teams\Application Cache
- Roaming\Microsoft\Teams\Cache
- Roaming\Microsoft\Teams\GPUCache
- Roaming\Microsoft\Teams\meeting-addin\Cache (Critical for issues where the Add-in is missing in Outlook)
Use case: single session scenario:
In this scenario, the end user uses Microsoft Teams in one location at a time. There is no need to run Teams in two different Windows sessions simultaneously. For instance, in a common virtual desktop deployment, each user is assigned to one desktop and Teams is deployed inside the virtual desktop as one application. We recommend enabling Citrix Profile container and redirect the previously mentioned per-user directories into the container.
- Deploy the Microsoft Teams machine wide installer (ALLUSER=1) in the golden image.
- Enable Citrix Profile Management and set up the user profile store with the proper permissions.
-
Enable the following Profile Management policy setting: File system > Synchronization > Profile container – List of folders to be contained in profile disk.
List all the previously mentioned folders into this configuration. Alternatively, you can also configure these settings using the Citrix Workspace Environment Management (WEM) service.
- Apply the settings to the correct Delivery Group.
- Log in to validate the deployment.
System requirements
Minimum recommended version - Delivery Controller (DDCs) 1906.2 (If you’re using an earlier version, see Enable optimization of Microsoft Teams):
Supported operating systems:
- Windows Server 2019, 2016, 2012R2 Standard and Datacenter Editions, and with the Server Core option
Minimum version - Virtual Delivery Agents (VDAs) 1906.2:
Supported operating systems:
- Windows 10 64-bit, versions 1607 and higher. (VM hosted apps are not supported).
- Windows Server 2019, 2016, and 2012 R2 (Standard and Datacenter Editions).
Requirements:
- BCR_x64.msi - the MSI that contains the Microsoft Teams optimization code and starts automatically from the GUI. If you’re using the command line interface for the VDA installation, don’t exclude it.
Recommended version – Citrix Workspace app 2006.1 for Windows and Minimum version - Citrix Workspace app 1907 for Windows:
- Windows 7, 8, and 10 (32-bit and 64-bit editions, including Embedded editions)
- Windows 10 IoT Enterprise 2016 LTSB (v1607) and 2019 LTSC (v1809)
- Processor (CPU) architectures supported: x86 and x64 (ARM is not supported)
- Endpoint requirement: Approximately 2.2–2.4 GHz dual core CPU that can support 720p HD resolution during a peer-to-peer video conference call.
- Dual or quad-core CPUs with lower base speeds (~1.5 GHz) equipped with Intel Turbo Boost or AMD Turbo Core that can boost up to at least 2.4 GHz.
- HP Thin Clients verified: t630/t640, t730/t740, mt44/mt45.
- Dell Thin Clients verified: 5070, 5470 Mobile TC.
- 10ZiG Thin Clients verified: 4510 and 5810q.
- For a complete list of verified endpoints, see Thin Clients.
- Citrix Workspace app requires a minimum of 600 MB free disk space and 1 GB RAM.
- Microsoft .NET Framework minimum requirement is version 4.6.2. Citrix Workspace app automatically downloads and installs .NET Framework if it is not present in the system.
Minimum version - Citrix Workspace app 2006 for Linux:
For more information, see Optimization for Microsoft Teams in Citrix Workspace app for Linux documentation.
Software:
- GStreamer 1.0 or later or Cairo 2
- libc++-9.0 or later
- libgdk 3.22 or later
- OpenSSL 1.1.1d
- x64 Linux distribution
Hardware:
- Minimum 1.8 GHz dual-core CPU that can support 720p HD resolution during a peer-to-peer video conference call.
- Dual or quad-core CPU with a base speed of 1.8 GHz and a high Intel Turbo Boost speed of at least 2.9 GHz.
For more information, see Prerequisites to install Citrix Workspace app.
Minimum version - Citrix Workspace app 2012 for Mac:
Supported operating systems
- macOS Catalina (10.15)
- macOS Big Sur Beta 8 in test environments only. Do not use in production environments.
Features supported:
- Audio
- Video
- Screen sharing optimization (incoming and outgoing)
Teams optimization works by default if the user has Citrix Workspace app 2012 or later and macOS 10.15.
If you want to disable Teams optimization, run this command in terminal and restart Workspace app:
defaults write com.citrix.receiver.nomas mtopEnabled -bool NO
Enable optimization of Microsoft Teams
To enable optimization for Microsoft Teams, use the Studio policy described in Microsoft Teams redirection policy (it is ON by default). In addition to this policy being enabled, HDX checks to verify that the version of the Citrix Workspace app is equal to or greater than the minimum required version. If you enabled the policy and the Citrix Workspace app version is supported, HKEY_CURRENT_USER\Software\Citrix\HDXMediaStream\MSTeamsRedirSupport is set to 1 automatically on the VDA. The Microsoft Teams application reads the key to load in VDI mode.
Note:
If you are using version 1906.2 VDAs or higher with older Controller versions (for example, version 7.15), which do not have the policy available in Studio, you can still be optimized because HDX optimization for Microsoft Teams is enabled by default in the VDA.
If you click About > Version, the Citrix HDX Optimized legend displays:
If you see Citrix HDX Not Connected instead, the Citrix API is loaded in Teams (which is the first step towards redirection), but there was an error in the subsequent parts of the stack. The error is most likely in the VDA services or the Citrix Workspace app).
If you don’t see any legend, Teams failed to load the Citrix API. Exit Teams by right-clicking on the notification area icon and restart. Make sure the Studio policy is not set to Prohibited, and that the Citrix Workspace app version is supported.
Network requirements
Microsoft Teams relies on Media Processor servers in Office 365 for meetings or multiparty calls. Microsoft Teams relies on Office 365 Transport Relays for these scenarios:
- Two peers in a point-to-point call do not have direct connectivity
- A participant does not have direct connectivity to the media processor.
Therefore, the network health between the peer and the Office 365 cloud determines the performance of the call.
We recommend evaluating your environment to identify any risks and requirements that can influence your overall cloud voice and video deployment. Use the Skype for Business Network Assessment Tool to test if your network is ready for Microsoft Teams. For support information, see Support.
Summary of key network recommendations for Real Time Protocol (RTP) traffic:
- Connect to the Office 365 network as directly as possible from the branch office.
- If you must use any of the following at the branch office, ensure that RTP/UDP Teams traffic is unhindered. HdxTeams.exe doesn’t honor explicit proxies configured on the endpoint.
- Bypass proxy servers
- Network SSL intercept
- Deep packet inspection devices
- VPN hairpins (use split tunneling if possible)
- Plan and provide sufficient bandwidth.
- Check each branch office for network connectivity and quality.
The WebRTC media engine in the Workspace app (HdxTeams.exe) uses the Secure Real-time Transport Protocol (SRTP) for multimedia streams that are offloaded to the client. SRTP provides confidentiality and authentication to RTP by using symmetric keys (128 bit) to encrypt media and control messages, and uses the AES encryption cipher in counter mode.
The following metrics are recommended for guaranteeing a positive user experience:
| Metric | Endpoint to Office 365 |
|---|---|
| Latency (one way) | < 50 msec |
| Latency (RTT) | < 100 msec |
| Packet Loss | <1% during any 15s interval |
| Packet inter-arrival jitter | <30ms during any 15s interval |
For more information, see Prepare your organization’s network for Microsoft Teams.
In terms of bandwidth requirements, optimization for Microsoft Teams can use a wide variety of codecs for audio (OPUS/G.722/PCM G711) and video (H264/VP9).
The peers negotiate these codecs during the call establishment process using the Session Description Protocol (SDP) Offer/Answer. Citrix minimum recommendations per user are:
| Type | Bandwidth | Codec |
|---|---|---|
| Audio (each way) | ~ 90 kbps | G.722 |
| Audio (each way) | ~ 60 kbps | Opus* |
| Video (each way) | ~ 700 kbps | H264 360p @ 30 fps 16:9 |
| Video (each way) | ~ 2,500 kbps | VP9 720p @ 30 fps 16:9 |
| Screen sharing | ~ 300 kbps | H264 1080p @ 15 fps |
* Opus supports constant and variable bitrate encoding from 6 kbps up to 510 kbps.
Opus and VP9 are the preferred codecs for peer-to-peer calls between two optimized VDI users.
G.722 and H264 are the preferred codecs for a VDI user joining a meeting.
Citrix Gateway
The presence of an on-premises Citrix Gateway or Citrix Gateway service as an HDX proxy doesn’t have an impact on Microsoft Teams optimization. This is because there is only a command-and-control virtual channel established between the Workspace app and the VDA.
All the audio or video streams are offloaded to the client for local processing. As a result, there is no server-side rendering.
Depending on the configuration in your environment, the command-and-control virtual channel flows through the Citrix Gateway using either of the following:
- TLS for TCP
- DTLS for EDT
If you’re also using the Citrix Gateway for VPN, make sure you’re allowing the client machine to reach the O365 Microsoft Teams servers directly. You can achieve this through split tunneling or other methods.
Proxy servers
Depending on the location of the proxy, consider the following:
-
Proxy configuration on the VDA:
If you configure explicit proxy server in the VDA and route connections to localhost through a proxy, redirection fails. To configure the proxy correctly, you must select the Bypass proxy servers for local address setting in Internet Options > Connections > LAN Settings > Proxy Servers and make sure
127.0.0.1:9002is bypassed.If you use a PAC file, your VDA proxy configuration script from the PAC file must return DIRECT for
wss://127.0.0.1:9002. If not, optimization fails. To ensure that the script returns DIRECT, useshExpMatch(url, "wss://127.0.0.1:9002/*"). -
Proxy configuration on Citrix Workspace app:
If the branch office is configured to access the Internet through a proxy, Citrix Workspace app for Windows version 2012 (Negotiate/Kerberos, NTLM, Basic, and Digest), Citrix Workspace app for Linux version 2101 (anonymous authentication), and Citrix Workspace app for Mac version 2104 (anonymous authentication) support proxy servers. Client devices with earlier releases of Citrix Workspace app cannot read proxy configurations. These devices send traffic directly to Office 365 TURN servers.
Important:
Verify that the client device can connect to the DNS server to perform DNS resolutions. A client device must be able to resolve three Microsoft Teams TURN server’s FQDNs:
worldaz.turn.teams.microsoft.com,usaz.turn.teams.microsoft.com, andeuaz.turn.teams.microsoft.com.
Call establishment and media flow paths
When possible, the HDX media engine in the Citrix Workspace app (HdxTeams.exe) tries to establish a direct network Secure Real-time Transport Protocol (SRTP) connection over User Datagram Protocol (UDP) in a peer-to-peer call. If the UDP ports are blocked, the media engine falls back to TCP 443.
The HDX media engine supports ICE, Session Traversal Utilities for NAT (STUN), and Traversal Using Relays around NAT (TURN) for candidate discovery and connection establishment.
If there is no direct path between the two peers or between a peer and a conference server (if the user is joining a multi-party call or meeting), HdxTeams.exe uses a Microsoft Teams transport relay server in Office 365 to reach the other peer or the media processor (where meetings are hosted). The user’s client machine must have access to two Office 365 subnet IP address ranges and 4 UDP ports. For more information, see the Architecture diagram in the “Call setup” section further down and Office 365 URLs and IP address ranges ID 11.
| ID | Category | Addresses | Destination Ports |
|---|---|---|---|
| 11 | Optimize required | 13.107.64.0/18, 52.112.0.0/14, 52.120.0.0/14 | UDP: 3478, 3479, 3480, 3481, TCP: 443 (fallback) |
These ranges contain both Transport Relays and media processors. The Teams Transport Relays provide STUN and TURN functionality, but they are not ICE endpoints. Also, the Teams Transport Relays do not terminate media nor perform any transcoding. They can bridge TCP (if HdxTeams.exe uses TCP) to UDP when they forward traffic to other peers or media processors.
HdxTeams.exe contacts the closest Microsoft Teams Transport Relay in the Office 365 cloud. HdxTeams.exe uses anycast IP and port 3478–3481 UDP (different UDP ports per workload, though multiplexing can happen) or 443 TCP TLSv1.2 for fallbacks. Call quality depends on the underlying network protocol. Because UDP is always recommended over TCP, we advise you to design your networks to accommodate UDP traffic in the branch office.
If Teams loaded in optimized mode and HdxTeams.exe is running on the endpoint, Interactive Connectivity Establishment (ICE) failures might cause a call setup failure or one-way-only audio/video. When a call cannot be completed or media streams are not full duplex, check the Wireshark trace on the endpoint first.
Note:
If the endpoints don’t have internet access, it might still be possible for the user to make a peer-to-peer call only if they are on the same LAN. Meetings fail. In this case, there is a 30 second timeout before the call setup begins.
Call setup
Use this architecture diagram as a visual reference for the call flow sequence. The corresponding steps are indicated in the diagram.
Architecture:
- Launch Microsoft Teams.
- Teams authenticates to O365. Tenant policies are pushed down to the Teams client, and relevant TURN and signaling channel information is relayed to the app.
- Teams detects that it is running in a VDA and makes API calls to the Citrix JavaScript API.
- Citrix JavaScript in Teams opens a secure WebSocket connection to WebSocketService.exe running on the VDA (127.0.0.1:9002), which spawns WebSocketAgent.exe inside the user session.
- WebSocketAgent.exe instantiates a generic virtual channel by calling into the Citrix HDX Teams Redirection Service (CtxSvcHost.exe).
- Citrix Workspace app’s wfica32.exe (HDX engine) spawns a new process called HdxTeams.exe, which is the new WebRTC engine used for Teams optimization.
-
HdxTeams.exe and Teams.exe have a 2-way virtual channel path and can start processing multimedia requests.
—–User calls——
- Peer A clicks the call button. Teams.exe communicates with the Teams services in Office 365 establishing an end-to-end signaling path with Peer B. Teams asks HdxTeams for a series of supported call parameters (codecs, resolutions, and so forth, which is known as a Session Description Protocol (SDP) offer). These call parameters are then relayed using the signaling path to the Teams services in Office 365 and from there to the other peer.
- The SDP offer/answer (single-pass negotiation) takes place through the signaling channel, and the ICE connectivity checks (NAT and Firewall traversal using Session Traversal Utilities for NAT (STUN) bind requests) complete. Then, Secure Real-time Transport Protocol (SRTP) media flows directly between HdxTeams.exe and the other peer (or Office 365 conference servers if it is a meeting).
Microsoft Phone System
Phone System is Microsoft’s technology that enables call control and PBX capabilities in the Office 365 cloud with Microsoft Teams. Optimization for Microsoft Teams supports Phone System, using Office 365 Calling Plans or Direct Routing. With Direct Routing, you connect your own supported session border controller to the Microsoft Phone System directly without any additional on-premises software.
Firewall considerations
When users initiate an optimized call using the Microsoft Teams client for the first time, they might notice a warning with the Windows firewall settings. The warning asks for users to allow communication for HdxTeams.exe (HDX Overlay Teams).
The following four entries are added under Inbound Rules in the Windows Defender Firewall > Advanced Security console. You can apply more restrictive rules if desired.
Microsoft Teams and Skype for Business Coexistence
You can deploy Microsoft Teams and Skype for Business side by side, as two separate solutions with overlapping capabilities. For more information, see Understand Microsoft Teams and Skype for Business coexistence and interoperability.
Citrix RealTime Optimization Pack and HDX optimization for Teams multimedia engines then honor whatever configuration is set in your environment (for example, island modes, Skype for Business with Teams collaboration, Skype for Business with Teams collaboration and meetings).
Peripheral access can be granted only to a single application at the time. For example, webcam access by the RealTime Media Engine during a call locks the imaging device during a call. When the device is released, it becomes available for Teams.
Citrix SD-WAN: optimized network connectivity for Microsoft Teams
Optimal audio and video quality require a network connection to the Office 365 cloud that has low latency, low jitter, and low packet loss. Backhauling of Microsoft Teams audio-video RTP traffic from Citrix Workspace app users at branch office locations to a data center before going to the internet can add excessive latency and might also cause congestion on WAN links. Citrix SD-WAN optimizes connectivity for Microsoft Teams following Microsoft Office 365 network connectivity principles. Citrix SD-WAN uses the Microsoft REST-based Office 365 IP address and web service and proximate DNS to identify, categorize, and steer Microsoft Teams traffic.
Business broadband internet connections in many areas suffer from intermittent packet loss, periods of excessive jitter, and outages.
Citrix SD-WAN offers two solutions to preserve Microsoft Teams audio-video quality when network health is variable or degraded.
- If you use Microsoft Azure, a Citrix SD-WAN virtual appliance (VPX) deployed in the Azure VNET provides advanced connectivity optimizations. These optimizations include seamless link failover and audio packet racing.
- Alternatively, Citrix SD-WAN customers can connect to Office 365 through the Citrix Cloud Direct service. This service provides reliable and secure delivery for all internet-bound traffic.
If the quality of the branch office internet connection is not a concern, it might be sufficient to minimize latency by steering Microsoft Teams traffic directly from the Citrix SD-WAN branch appliance to the nearest Office 365 front door. For more information, see Citrix SD-WAN Office 365 optimization.
Gallery view and active speakers in Microsoft Teams
Microsoft Teams supports Gallery, Large gallery, and Together mode layouts.
Microsoft Teams displays a 2x2 grid with video streams of four participants (known as Gallery). In this case, Teams sends 4 individual video streams to the client device for decoding. When there are more than four participants sharing video, only the last four most active speakers appear on the screen.
Microsoft Teams also provides the large gallery view with a grid up to 7x7. As a result, the Teams conference server composites a single video feed and sends it to the client device for decoding, resulting in lower CPU consumption. This single “Hollywood square” feed might include user’s self-preview video as well.
Lastly, Microsoft Teams supports Together mode, which is part of the new meeting experience. Using AI segmentation technology to digitally place participants in a shared background, Teams puts all participants in the same auditorium.
The user can control these modes during a conference call by selecting Gallery, Large gallery, or Together mode layouts in the ellipses menu.
Screen sharing in Microsoft Teams
Microsoft Teams relies on video-based screen sharing (VBSS), effectively encoding the desktop being shared with video codecs like H264 and creating a high-definition stream. With HDX optimization, incoming screen sharing is treated as a video stream. Therefore, if you are in the middle of a video call and the other peer starts to share the desktop, that original camera video feed is paused. Instead, the screen sharing video feed displays. The peer must then manually resume the camera sharing.
Outgoing screen sharing is also optimized and offloaded to the Citrix Workspace app (version 1907 or higher). In this case, HdxTeams.exe captures and transmits only the Citrix Desktop Viewer (CDViewer.exe) window. If you want to share a local application running in your client machine, you can overlay it on top of CDViewer and it is also captured.
Multi-monitor: In cases where the CDViewer is in full screen mode and spanning across multi-monitor setups, only the primary monitor is shared. Users must drag the application of interest inside the virtual desktop to the primary monitor for the other peer on the call to see it.
Note:
If you are publishing Teams as a stand-alone seamless application, screen sharing captures the local desktop of your physical endpoint in Citrix Workspace app minimum version 1909.
Peripherals in Microsoft Teams
When optimization for Microsoft Teams is active, the Citrix Workspace app accesses the peripherals (headset, microphone, cameras, speakers, and so forth). Then the peripherals are properly enumerated in the Microsoft Teams UI (Settings > Devices).
Microsoft Teams does not access the devices directly. Instead, it relies on HdxTeams.exe for acquiring, capturing, and processing the media. Microsoft Teams lists the devices for the user to select.
Recommendations:
- Microsoft Teams certified headsets with built-in echo cancellation. In setups with multiple peripherals, where microphone and speakers are on separate devices an echo might be present. For example, a webcam with a built-in microphone, and a monitor with speakers. When using external speakers, place them as far as possible from the microphone and from any surface that might refract the sound into the microphone.
- Microsoft Teams certified cameras, although Skype for Business certified peripherals are compatible with Microsoft Teams.
- HdxTeams.exe cannot take advantage of CPU offloading with webcams that perform on-board H.264 encoding -UVC 1.1 and 1.5.
Note:
HdxTeams.exe supports only these specific audio device formats (channels, bit depth, and sample rate):
- Playback Devices: up to 2 channels, 16 bit, frequencies up to 96,000 Hz
- Recording Devices: up to 4 channels, 16 bit, frequencies up to 96,000 Hz
Even if one speaker or microphone does not match the expected settings, device enumeration in Teams fails and None displays under Settings > Devices.
Webrpc logs in HdxTeams.exe show this type of information:
Mar 27 20:58:22.885 webrtcapi.WebRTCEngine Info: init. initializing...
Mar 27 20:58:23.190 webrtcapi.WebRTCEngine Error: init. couldn't create audio module!As a workaround, open the Sound Control Panel (mmsys.cpl), select the playback or recording device, go to Properties > Advanced and change the settings to a supported mode. Alternatively, disable the specific device.
Fallback mode
If Microsoft Teams fails to load in optimized VDI mode, the VDA falls back to legacy HDX technologies like Webcam redirection and client audio and microphone redirection. In the unoptimized mode, the peripherals are mapped to the VDA. The peripherals appear to the Microsoft Teams app as if they were locally attached to the virtual desktop.
You can now granularly control the fallback mechanism by setting one of the following registry DWORD values in the VDA:
HKLM\SOFTWARE\Microsoft\Teams\DisableFallback
HKCU\SOFTWARE\Microsoft\Office\Teams\DisableFallback
To disable fallback mode, set the value to 1. To enable audio only, set the value to 2. If the value isn’t present or is set to 0, fallback mode is enabled. This feature requires Teams version 1.3.0.13565 or later.
To determine if you are in optimized or unoptimized mode when looking at the Settings > Devices tab in Teams, the most significant difference is the camera name. If Microsoft Teams loaded in unoptimized mode, legacy HDX technologies launch. The webcam name has the Citrix HDX suffix as shown in the following graphic. The speaker and microphone device names might be slightly different (or truncated) when compared to the optimized mode.
When legacy HDX technologies are used, Microsoft Teams doesn’t offload audio, video, and screen sharing processing to the endpoint’s Citrix Workspace app WebRTC media engine. Instead, HDX technologies use server-side rendering. Expect high CPU consumption on the VDA when you turn on video. Real time audio performance might not be optimal.
Known limitations
Citrix limitations
Limitations on Citrix Workspace app:
- DTMF tones are not supported.
- HID buttons - Answer and end call are not supported. Volume up and down are supported.
- When doing screen sharing in multi-monitor setups, only the main monitor is shared.
- We support only one video stream from an incoming camera or screen share stream. When there’s an incoming screen share, that screen share is shown it instead of the video of the dominant speaker.
- Secondary ringer (Teams > Settings > Devices) is not supported.
- QoS settings in Admin Center for Microsoft Teams do not apply for VDI users.
- App protection add-on feature for the Citrix Workspace app prevents outgoing screen sharing.
- The zoom in and zoom out function in Teams is not supported.
Limitation on the VDA:
- When you configure the Citrix Workspace app High DPI setting to Yes or to No, use the native resolution, the redirected video window appears out of place when the monitor’s DPI scaling factor is set to anything above 100%.
Limitations on Citrix Workspace app and the VDA:
- Outgoing screen sharing: Application sharing is not supported.
- You can only control the volume of an optimized call using the volume bar on the client machine – not on the VDA.
Microsoft limitations
- The options to blur or customize the background aren’t supported.
- A 3x3 gallery view is not supported. Teams dependency – contact Microsoft for when to expect a 3x3 grid.
- Interoperability with Skype for Business is limited to audio calls, no video modality.
- Incoming and outgoing video stream maximum resolution is 720p. Teams dependency – contact Microsoft for when to expect 1080p.
- PSTN call ringback tone is not supported.
- Media bypass for Direct Routing is not supported.
Citrix and Microsoft limitations
- When doing screen sharing, the option include system audio is not available.
- Pop out chat (also known as multi-window chat or the new meeting experience) is not supported.
- Breakout rooms are supported for VDI participants. Teams doesn’t support breakout rooms if the organizer is a VDI user.
- Give control and take control: Not supported during a desktop screen sharing or application sharing session. Supported only during a PowerPoint sharing session.
- E911 and Location-Based Routing are not supported.
Upcoming Microsoft Teams Single-Window EOL
On January 31, 2024, Microsoft will retire the Microsoft Teams support for Single-window UI when using VDI Microsoft Teams optimization and support only the Multi-Window experience. Microsoft gave notice of this deprecation on 9/8/2023 in the M365s Admin Center (Post ID: MC674419). Public details about the Multi-Window feature can be found in the Tech Community article: New Meeting and Calling Experience in Microsoft Teams.
You must upgrade your VDA and Citrix Workspace app to the supported versions to continue using Microsoft Teams in optimized mode for video and screen sharing. If you don’t upgrade your infrastructure and endpoints to support multi-window, you can only establish audio calls. You will not be able to use the optimized video and screensharing functionality.
The following table illustrates the minimum, LTSR, and recommended versions of VDA and Citrix Workspace app required to continue using optimized calling in Microsoft Teams on Citrix VDI:
| Component | Minimum version | LTSR supported version | Recommnded version |
|---|---|---|---|
| Microsoft Teams | 1.5.00.11865 | Not applicable | Latest |
| VDA | 1912 CU6 LTSR, 2112 CR | 1912 CU7+, 2203 CU2+ | 2308 CR+ |
| Citrix Workspace app for Windows | 2205 CR | 2203 CU2+ | 2309 CR+ |
| Citrix Workspace app for Mac | 2209 CR | Not applicable | 2308 CR+ |
| Citrix Workspace app for Linux | 2209 CR | Not applicable | 2308 CR+ |
| Citrix Workspace app for ChromeOS or HTML5 | 2303 CR | Not applicable | 2309 CR+ |
Deprecation announcement of the SDP format (Plan B) from WebRTC
Citrix is planning to deprecate the current SDP format (Plan B) support from WebRTC in future releases. You must use Unified Plan in WebRTC to support optimized Microsoft Teams functionalities.
Products that are affected
In one of the future releases of the Citrix Workspace Application, calls between endpoints with the upcoming release for the Citrix Workspace app and endpoints with Citrix Workspace app 2108 or older versions will not be supported. This calling incompatibility includes 1912 LTSR Citrix Workspace app clients (CWA). The following CWA clients are impacted:
- Citrix Workspace app for Windows
- Citrix Workspace app for Linux
- Citrix Workspace app for Mac
- Citrix Workspace app for Chrome
Replacement for Plan B
If you are running the Citrix Workspace app version older than 2109, you must upgrade to a supported version (preferably the latest CR release). Otherwise, any calls with a future release or newer endpoints fail to connect. Calls between future releases and your federated communication partners might also fail to complete if the federated partner has not upgraded their Citrix Workspace.
Citrix Workspace app version 2108 has completed its’ support date in March 2023 and must be upgraded to a newer version. For more information, see Workspace App for details on Citrix Workspace app version support.
For more information on the Plan B deprecation, see the WebRTC documentation.
Additional information
In this article
- Microsoft Teams installation
- Profile Management recommendations
- System requirements
- Enable optimization of Microsoft Teams
- Network requirements
- Proxy servers
- Call establishment and media flow paths
- Microsoft Phone System
- Firewall considerations
- Microsoft Teams and Skype for Business Coexistence
- Citrix SD-WAN: optimized network connectivity for Microsoft Teams
- Gallery view and active speakers in Microsoft Teams
- Screen sharing in Microsoft Teams
- Peripherals in Microsoft Teams
- Fallback mode
- Known limitations
- Upcoming Microsoft Teams Single-Window EOL
- Deprecation announcement of the SDP format (Plan B) from WebRTC
- Additional information