stomypx / sps-apis

Public APIs for Scalable Pixel Streaming

Scalable Pixel Streaming APIs

This repository contains definitions and Go packages for consuming the public APIs exposed by Scalable Pixel Streaming that are versioned independently of SPS itself. (Note that the REST API is currently versioned alongside SPS and is not included in this repository.)

The following APIs are currently available:

• Authentication Plugin Plugin API: used to provide authentication for Pixel Streaming applications.

• Instance Customisation Plugin API: used to dynamically modify the runtime options of individual instances of a Pixel Streaming application.

Instance Customisation Plugin API Docs

• Overview
• What can I customise
  • Plugin Options
  • Runtime Options
• Using the API
  • Generating code
  • Adding customisation package
  • Importing the package
  • Implementing the API
• Deploying the plugin
  • Building a container
  • Deploying to the cluster
• Configure Application
  • Dashboard

Legal

Copyright © 2022, TensorWorks Pty Ltd. Licensed under the MIT License, see the file LICENSE for details.