PCoIP Client Parameters¶

The following table outlines command line parameters that are available to use and customize:

For example, running the --help command will have the following format:

pcoip-client --help

Customizable Session Features¶

The following PCoIP session features can be customized:

• Session Menu Bar Visibility
• Disable Hot Keys
• Windowed or Fullscreen Mode
• Set Host Resolution
• Image Scaling
• Maintain Aspect Ratio

Session Menu Bar Visibility¶

To enhance the user experience the PCoIP Session Client enables the menu bar by default, however some use cases may require that it be disabled, or hidden, in order to prevent the user from accessing menu functionality. To disable the menu bar feature use the parameter disable-menubar.

Disable Hot Keys¶

To improve usability, session hot keys, such as Ctrl+Delete+F12 (which disconnects a PCoIP session) are available to users by default. The parameter for this feature is disable-hotkeys.

Windowed or Fullscreen Mode¶

Depending on your application needs, you can display the PCoIP session in either windowed or fullscreen mode. Fullscreen mode allows the display topology to support multiple monitors as an extended desktop; windowed mode gives you the flexibility to display multiple application windows in parallel and switch between them quickly. Windowed mode improves the user experience, as well as resulting in an increase in performance. Windowed mode is the default mode, and to activate fullscreen mode use the full-screen parameter.

Set Host Resolution¶

Normally, the session client opens with arbitrary window dimensions. In some cases, you may wish to lock the resolution of your host application displays. This ensures the user’s viewing experience is consistent across different monitors and their native resolutions. The parameter for this feature is set-host-resolution.

• Host Resolution Limitations: It is only possible to specify one target resolution for all displays. The host resolution will not perform to its optimal capability if you have monitors with different resolutions.

Image Scaling¶

The image scaling feature enables scaling on the client without having to specify the desktop resolution. You can apply image scaling when the resolution of the client monitor is not the same as the resolution provided by the host. This feature provides a smoother process for image scaling on the client. The parameter for this feature is enable-scaling.

Maintain Aspect Ratio¶

If the host and client aspect ratios do not match, and this parameter is not used then the display will be stretched to fit. The parameter for this feature is maintain-aspect-ratio. If the native aspect ratios of the host’s display and the client’s display do not match, the host’s aspect ratio will be preserved and will appear in the client with black bars either on the sides or top and bottom of the display.

Launching PCoIP Software Client with a URI¶

It is possible to launch the PCoIP Software Client with a URI. The Teradici URI uses JSON Web Tokens (JWT). For more information on the use of JWT, see here. The URI is defined as the following:

pcoip://[broker]/connect[?data={jwt}]

When additional parameters are passed through the encoded JWT a session can be launched:

The table below details supported optional JWT payload claims:

Below is an example of a JWT payload:

{
    "usr": "username",
    "dom": "mydomain.com",
    "vm": "mydesktopname"
}

pcoip://fake.broker.com/connect?data=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c3IiOiJ1c2VybmFtZSIsImRvbSI6Im15ZG9tYWluLmNvbSIsInZtIjoibXlkZXNrdG9wbmFtZSJ9.Mf3uoeZT8VQbVq7Gp0QQGbh8EqYtrIlp_E9jF2iI31Q