Skip to content

PCoIP Client SDK for macOS 23.04

The Client SDK for macOS provides developers tools to create a custom PCoIP 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 PCoIP agents or PCoIP Remote Workstation Cards.

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

The Client SDK for macOS includes the following components:

  • Code Examples
  • Programming Guide
  • Session Client Source Code
  • Session Client Libraries and API Headers
  • Session Client API Documentation
  • Broker Client Example Code
  • Broker Client Libraries and API Headers
  • PCoIP Core Libraries and API Headers
  • PCoIP Core Binary

Supported Platforms

The Client SDK for macOS can be used on the following operating systems:

  • macOS 12 (Monterey)
  • macOS 13 (Ventura)

What Can You Build With the PCoIP Client SDK?

With complete control over how a PCoIP client is built, you can create clients that incorporate customizations in both pre-session and in-session phases of a PCoIP connection. For example, the following customizations are all typical use cases:

Pre-Session Customizations

  • Customizing the client user interface to create a branded, end-to-end solution using company assets such as corporate logos, slogans or trademarks, and corporate colors and iconography.

  • Developing customized authentication workflows, either directly or using a broker.

  • Automatically connecting users to specific desktops or applications, based on an identified user type or task.

  • Embedding a remote workload into an application.

In-Session Customizations

  • Client branding, including:
    • Menu item labels
    • Window titles
    • Application icons
    • Company logos
  • Automatic bridging of USB devices.
  • In-session menu bar visibility.
  • Disabling hot keys.
  • Client display size in windowed and fullscreen mode.
  • Configuring resolutions.
  • Securely using local and bridged USB devices.

Complete control of the in-session user experience is possible using the PCoIP Core API.

Who Should Read This Guide?

This guide provides information for software developers and systems integrators with an understanding of SDK integrations and virtualization systems who are developing customized PCoIP clients. Readers should already understand the PCoIP protocol, how it is used, and the difference between brokered and non-brokered sessions.

This guide is not intended for users who do not require a custom PCoIP client.

This guide will break down how to use the session client executable and how to use the broker client API, session client API and core API. This document is not intended for users who are unfamiliar with SDK integrations, or for HP Anyware users who do not require a customized PCoIP client. In this guide, you will learn about:

  • PCoIP session components and considerations
  • Customizing the PCoIP session
  • Setting up a PCoIP agent test environment
  • Setting up a development environment
  • Troubleshooting issues related to setting up, developing, and building the SDK

Developing with the Session API and Core API

If you are looking for development specific instructions and information around using the Session API, see Session API Development.

If you are looking for development specific instructions and information around using the Core Libraries and API, see Core API Development.