Client SDK for Windows Developers' Guide

Windows Build Procedure

External Dependencies

Boost and Qt are external dependencies that the SDK expects to be installed on the system on which the example code is being built.

  1. The SDK package has 5 directories. The headers are inside include/, libraries are inside lib/ and bin/ and the cmake modules required for finding and importing dependencies are inside cmake/.

  2. In order to build the examples provided inside examples/, cd into any of the examples directories.

  3. Create a folder called build/ and cd into build/.

  4. To configure the build system run:

    cmake -A x64 path/to/source/code
    
  5. To build the example run:

    cmake --build .
    
  6. Now the build/ directory should have the built examples as a .exe which you can launch from the command line or double click depending on what you have built.

  7. Ensure the CMakeLists.txt file present inside the directory has the path to the SDK directory appended to CMAKE_PREFIX_PATH so that the installed version of cmake on the system is able to locate the cmake modules for finding the dependencies:

    list(APPEND CMAKE_PREFIX_PATH "localpath/to/sdk/")
    
    find_package(PCoIPSoftClientSDK REQUIRED)
    
  8. At this point, you can link your application to the core library using the CMake command:

    target_link_libraries(your_application PRIVATE PCoIPSoftClientSDK:pcoip_core)
    
  9. You can link any other required libraries similarly by appending it to the above command.

Updating SDK Components

Updating the SDK to a new version can be done by replacing the old binaries with new versions in place. There is no special upgrade path.


Last updated: Thursday, July 18, 2024