The Broker Client API Example

The Broker Client Example

The SDK package comes with a sample command line pre-session client called the Broker Client example, which calls the included broker client libraries and establishes a PCoIP connection. The Broker Client API example demonstrates the success path for establishing new PCoIP sessions.

Do not Use the Broker Client Example in Production

Using the Branding Package

Using the Branding Package

Once you have created the branding package, it can be used by the session client. The pre-session client is responsible for verifying the package and passing it to the session client executable.

To use the branding package:

Enabling PCoIP Ultra

PCoIP Ultra

The Anyware Client provides support for PCoIP Ultra, the latest protocol enhancements from HP. PCoIP Ultra is optimized for truly lossless support with bit-exact color accuracy and preservation of content detail at the highest frame rates.

Mapping Function Keys

You can enable Function keys on the Anyware Session Client SDK by going to Apple> System Settings> Keyboard> and selecting the function keys you wish to use as standard keys. When the system is configured to not use function keys the Anyware Software Client does not get the function key codes from the system when the keys are pressed. In this instance the function keys are usd for other system features such as turning the volume up and down.

Adding a Custom Logo

The Software Client for macOS can be configured in the Pre-Session mode to place a custom logo beside the Anyware logo. For best results, the logo should be a .png file with a transparent background, and ideally be of size 245x100 or smaller. The image is named "customlogo.png".

macOS location: ~/Library/Preferences/Teradici/PCoIPClient/

Connecting to a USB Device

Connecting to a USB Device

Remote hosts using the Anyware Standard Agent or the Anyware Graphics Agent can use USB devices that are attached to the client. When you connect a local USB device to your remote host it will be disabled on the client machine.

USB device connections do not persist across multiple PCoIP sessions. You must connect your USB device each time you connect.