Overview

Anyware Client SDK for macOS 25.03

The Client SDK for macOS provides developers tools to create a custom Anyware client with a unique user interface and workflow, or to embed a PCoIP session into another program or solution. Clients built with the SDK can connect to remote desktops using Anyware agents or Remote Workstation Cards.

The SDK is provided as part of HP Anyware by special agreement with HP.

Establishing a PCoIP Session

Establishing a PCoIP Session

Brokered Session Connection

If you are using a brokered session, this is handled by the broker libraries automatically.

Before you can establish a PCoIP session with a host desktop, gather the following host desktop details:

Frequently Asked Questions

Frequently Asked Questions

The following are answers to commonly asked questions when contemplating how to develop custom Anyware Clients using the Teradici Anyware Client SDK.

Q: Can I brand the pre-session client with my company logo and colors?

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

Creating a Branding Package

Creating a Branding Package

In order to customize your session client, you must create a client branding package using the HP Custom Branding Package Utility. The HP Custom Branding Package Utility is located in the following location:

  • macOS clients: "path-to-unzipped-sdk-package"/sdk/usr/bin/TeradiciBrandingPackageUtility

To create a custom branding package:

System Precedence

The following section outlines the scope precedence commands between the System Scope and User Scope. If you are updating individual user settings then the user scope locations and parameters can be followed. Due to this order of precedence where by the system scope setting takes precedence over the user scope setting, a change in the user settings may not take effect if the system scope setting has been updated.

System Scope

HID Local Termination Blacklist

HID Local Termination Blacklist

Local Termination of Wacom tablets provides the best user experience in networks with high latency. However, some features of the tablet may not be fully supported with local termination. A HID Local Termination Blacklist has been added to override the preferred local termination mode.

Branding Your Session Client

Branding Your Session Client

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 following elements can be customized in the session client:

About PCoIP Sessions

About PCoIP Sessions

Establishing a PCoIP session involves a number of key components, including system actors, PCoIP session phases, and connection brokers as discussed next.

System Actors

There are at least three components that work together to create a PCoIP session: