Introduction

Welcome to the Proximie SDK documentation. This version of the documentation is specifically for version 0.17.0 of the Proximie SDK. For information about changes in this release, see the current release notes.

What is the Proximie SDK?

The Proximie SDK is intended to provide your C++ application(s) with the ability to interact with Proximie services, such as media streaming, session management, and more. See SDK features for more information.

A diagram showing the Proximie SDK in context

The Proximie SDK in context

Contents

This documentation is divided into the following high level sections:

  • The Getting Started section provides a step-by-step guide to setting up your development environment, obtaining the SDK, and building the sample applications provided alongside the SDK.

  • The Development guide section has an overview of the key concepts and how to use them to develop an application using the Proximie SDK.

  • There is also a Glossary of terms explaining Proximie SDK terminology.

  • The SDK is current pre-release and is under very active development. The Upcoming developments section outlines upcoming changes and developments, including proposals and discussions on these plans.

  • Finally, the SDK reference is a detailed reference into the SDK’s classes and APIs.