C++ SDK for Mixer Interactivity
Clone or download
k-rutkowski and JoshSnider Fix argument type of string property setter (#97)
Signature of function interactive_control_set_property_string in interactivity.h differs from one in source file. Therefore using this function in client code leads to link error.

This corrects the type of argument property from char* to const char*.
Latest commit 240ffba Dec 4, 2018

README.md

Mixer Interactivity C++ SDK

The C++ Interactivity SDK supports client-side development with Mixer Interactivity. If you have not read through our Interactive Reference Documentation now is a great time to do that.

Documentation

Checkout the Project's Wiki for documentation, including a Getting Started guide.

Quick Start

Clone the interactive-cpp repository.

$ git clone https://github.com/mixer/interactive-cpp.git interactive-cpp

Copy the source directory into your C++ game project (you will likely want to rename it). Add interactivity.cpp to your compilation list and include interactivity.h to get started.

See the InteractiveSample for an example of how you might handle authorization and connect to an interactive session.

Authorization

If you don't plan on handling authorization yourself you can use the provided authorization helper functions. To do so you will need an OAuth client ID which you can obtain here: https://mixer.com/lab/oauth

Design choices

This source code was designed to be easily consumed by any game project. Some of major design decisions include:

  • A single header and unity build style cpp file.
  • An extern "C" interface.
  • No dependencies exposed in the header, all usage of STL and other libraries are quarantined from your game.
  • Callbacks on the caller's thread for easy memory management and managed language interop.
  • All interactive functions assume UTF-8 strings for input and output parameters.

Release Notes

The interactive-cpp repository is currently in a pre-release state. Please refer to the release notes for more information.

Contribute Back!

Is there a feature missing that you'd like to see, or have you found a bug that you have a fix for? Do you have an idea or just interest in helping out in building the library? Let us know and we'd love to work with you. For a good starting point on where we are headed and feature ideas, take a look at our requested features and bugs or backlog.

Big or small we'd like to take your contributions to help improve the Mixer Interactivity API for everyone.

Legacy SDK

If you are looking for the previous version of the SDK it is preserved here.

Having Trouble?

We'd love to get your review score, whether good or bad, but even more than that, we want to fix your problem. If you submit your issue as a Review, we won't be able to respond to your problem and ask any follow-up questions that may be necessary. The most efficient way to do that is to open an issue in our issue tracker.

Quick Links

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.