The PCoIP Ultra Collaboration feature enables a user to share their PCoIP session with a remote collaborator using a PCoIP Software Client. While connected, the collaborator can view the screen output and hear the audio output of the shared PCoIP session.
When discussing this feature, we'll refer to the first user as the session owner, and the second user who joins the session as the collaborator.
Feature Support, Requirements and Limitations
The PCoIP Ultra Collaboration feature is supported when connecting from any PCoIP software client that supports PCoIP Ultra to any PCoIP agent.
PCoIP Software Clients running on Apple Silicon, iOS mobile clients, and Android mobile clients do not currently support PCoIP Ultra, and will not connect to Collaboration sessions.
When connecting to a PCoIP standard agent, PCoIP Ultra CPU Offload is required.
When connecting to a PCoIP graphics agent 22.07 or later, PCoIP Ultra CPU Offload, GPU Offload, and Auto Offload are supported.
Collaboration Mouse Visibility only works when the session owner and all collaborators are using a PCoIP Client in Standard Client mode, or in the next-generation high performance client mode (technical preview). The high performance client mode does not support mouse visiblity.
The features described on this page are only supported when both PCoIP Clients and PCoIP Agents are running on version 22.07 or later.
Enabling and Hosting a Collaboration Session¶
For information and steps on how to enable collaboration, and how to host a collaboration session, see the PCoIP Agent documentation linked below. The instructions for enabling and hosting collaboration will vary based on the PCoIP Agent you use. You should select the instructions that apply to the PCoIP Agent that you are connecting to:
Important: User input control
PCoIP Collaboration sessions support user input control, which allows the session host to transfer control of keyboard and mouse input to the collaborator. This feature is disabled by default. Instructions for enabling input control, and guidance on usage, are also available in the PCoIP agent documents linked above.
Joining a Collaboration Session¶
The collaborator can join the PCoIP session once they have received the invite link and invite code from the session owner. Invite links and codes are generated on the remote PCoIP agent machine; for instructions, refer to the agent administrators' guides linked above.
Open a web browser and go to the invite link shared with you (you may be able to click this link directly, depending on how it was shared with you).
The web browser will warn you that the link is attempting to open the PCoIP Client application. Allow the browser to open the PCoIP Client.
When the PCoIP Client opens, it will prompt you for your name and the Collaboration Invitation Code. The value you enter for your name is used to tell the host who is joining; the Collaboration Invitation Code is the six digit number provided by the host. Enter both values and click Submit.
Once the session owner accepts your connection request, the Collaboration screen share will start.
To leave the collaboration session, select Connection > Disconnect from the PCoIP Client menu.
Collaboration Mouse Visibility allows the collaborator to see the host's mouse cursor movements within a collaboration session. This feature is only available when both collaborators are using a PCoIP client 22.07 or newer, and the PCoIP agent is also version 22.07 or later.
Currently, mouse visibility only works in the default standard client mode. High performance client mode does not support mouse visibility. See High Performance Client for instructions to enable or disable high performance client mode.
Future releases will add the ability for the Collaborator to take control of the session mouse and keyboard.