Alternative for the Session Client API

Rate this Article
No votes yet

In version 23.04, the Session Client API was removed from the PCoIP Client SDK. If you have used the Session Client API in your projects, going forward, we recommend that you use the Command-line Interface PCoIP Client application to establish PCoIP sessions programmatically. This procedure is described in the topic "How to Establish a PCoIP Session" in the PCoIP Client SDK guides.

The Broker Client Example, which is included in the SDK package, demonstrates how the Command-line Interface is used in place of the API to invoke the PCoIP client using the SDK.

The Broker Client Example does the following: 

  • Brokers a PCoIP session
  • Calls the PCoIP Client executable with the necessary Command-line parameters for starting a session

When the example is run and the brokering is completed, the PCoIP Client executable will be launched using the Command-line Interface. This call will be printed to stdout.

The following snippet is an example of establishing a session by invoking the PCoIP client on Windows:

pcoip_client.exe -i connect-tag= SCS1WsopFJ3iz1l48PTJMXFkcD4b6M9aiakHXH3ellLhUROBceWAifSSn%2b4AV1FC 8IihWVmsISmYFKeA25AtzFrdMpdaCtqlic0zfxAA address=10.64.60.115 session-id=2305843009213693961 log-id=a1ff3a80-8801-1038-a9bd-00505680a
The PCoIP Client SDK guides contain instructions on using the Command-line Interface to establish PCoIP sessions, as well as using the Broker Client Example. Use the table below to find OS-specific documentation & examples.