Client SDK for Windows Developers' Guide

Anyware Client SDK for Windows 24.10

The Client SDK for Windows 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.

The Client SDK for Windows includes the following components:

  • Code Examples
  • Programming Guide
  • Broker Client Example Code
  • Collaboration Broker Client Example Code ` Broker Client library
  • PCoIP Core Binary

Supported Platforms

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

  • Windows 10 (64-bit)
  • Windows 10 IoT 64 21H2 Enterprise LTSC
  • Windows 11

What Can You Build With the Anyware Client SDK?

With complete control over how a Anyware 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 Anyware 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 Anyware client.

This guide will break down how to use the session client executable and how to use the broker 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 Anyware client. In this guide, you will learn about:

  • PCoIP session components and considerations
  • Customizing the PCoIP session
  • Setting up a Anyware 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 customizing the client session, see the topics listed under "Session Client Customization".

If you are looking for development specific instructions and information around using the Core Libraries and API, see the topics listed under "Core API".

Last updated: Wednesday, October 30, 2024