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
- Custom Client Branding
- Image Scaling
- Maintain Aspect Ratio
- USB Auto Forward
- USB VID/PID Auto Forward
- Disable USB
- Locale
- Session Log ID
- Log Level
- Log Folder
- Log Prefix
- Force Native Resolution
Examples show command-line usage
The examples shown here invoke the session client via the command line. You can also set these properties when invoking the session client programmatically.
Disable 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.
Custom Client Branding¶
You can customize the branding of your custom session client in several ways by
creating a client branding package. These customizations affect the user’s experience
once they have connected to their PCoIP session. The parameters for this feature are
branding-package
and branding-hash
.
The following elements can be customized in the session client:
- The OS application title and logo
- The session client toolbar title and logo
- The logo displayed in the OS taskbar
- The following default menu item label:
- About PCoIP Client
- Quit PCoIP Client
- The content shown in the About dialog:
- Replace the dialog text
- Provide hyperlinks to corporate resources and product information
- Add a custom logo
- Customize a client alert and message window titles.
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.
USB Auto-Forward¶
Automatic bridging enables you to auto bridge all non-HID USB devices. Use the usb-auto-forward
parameter.
USB Vendor ID/Product ID Auto-Forward¶
You can automatically forward up to 20 USB devices to the host at the start of the
session by calling the session client executable with vidpid-auto-forward
and the
required VID/PID pairs. Devices that are auto-forwarded will appear in the USB
Devices dialog box, enabling users to connect or disconnect them from the host.
The following rules apply to VID and PID values:
- VID/PID values are comma-separated:
xxx
,yyy
- VID/PID pairs are space-separated:
aaa, bbb
ccc,ddd
- VID/PID pairs with invalid values will be discarded. Discarded rules appear in the event log.
- Up to 20 devices will be passed; if more than 20 are attempted, the first 20 will be accepted and rest ignored. Ignored rules appear in the event log.
Disable USB¶
You can disable USB functionality in the client with the disable-usb
parameter.
Locale¶
The Local feature enables you to use the appropriate localized user interface for the
client session. This feature will make the session GUI more flexible to accomodate a
wide range of languages. You can choose the language translation you require by
setting the locale
parameter. The following table states the available language
translations and codes:
Locale Code | Language |
---|---|
de | German |
es | Spanish |
fr | French |
it | Italian |
ja | Japanese |
ko | Korean |
pt | Portuguese (EU) |
pt_BR | Portuguese (Brazil) |
ru | Russian |
tr | Turkish |
zh_CN | Chinese (Simplified) |
zh_TW | Chinese (Traditional) |
Default Language
By default, the language is set to English.
Session Log-ID¶
log-id
is a UUID that uniquely indentifies the session in all PCoIP log files.
Log Level¶
log-level
is the log level parameter. It is possible to over-ride the default log-level,
which is 2, by specifying a different log-level parameter. All messages at the specified
level or lower will be logged.The following parameters apply:
- 0 = Critical
- 1 = Error
- 2 = Info
- 3 = Debug
Troubleshooting and Support
When reproducing issues for the purposes of troubleshooting and support, set the log level to Debug.This will enable you to capture a log of all information messages and errors.
Log Folder¶
log-folder
is he Log Folder parameter. This is the user defined folder for log files.
Log Prefix¶
log-prefix
is the Log Prefix parameter. This is the log filename that the SDK will add time information to for each log file. The resulting log file will be [log-folder]/[log-prefix][timeinformation].
Force Native Resolution¶
The resolution of the client monitor can be set to the native resolution when the
session client is launched using the force-native-resolution
parameter