evmux JavaScript SDK
Build apps that run inside the evmux studio. The SDK is an npm package that lets your JavaScript read and control evmux.
What the SDK is
The evmux JavaScript SDK is an npm package, evmux-app-framework. It lets you access and manage evmux functionality through API calls in your own JavaScript code.
npm install evmux-app-framework
import EvmuxAppsApi from 'evmux-app-framework/src/EvmuxAppsApi/EvmuxAppsApi'
const evmuxApi = new EvmuxAppsApi()
const { response: settings } = await evmuxApi.getSettings()
await evmuxApi.reportLoaded()
What you can build
Widget apps
A widget app is an app that can be installed on an evmux stream. It appears as a layer in the scene, like the trivia, wheel and poll apps in the App Market.
With the SDK, your app communicates with the streams it is installed on and can access and manage them. See the widget app overview.
Dashboard apps
A dashboard app is an app that can be installed on an evmux project or session.
With the SDK, your app communicates with the project or session it is installed on and can access and manage it.
Permissions
To use evmux APIs, an app needs the user’s explicit permission for the operations it performs. The user grants it when they install the app on their stream, project or session.
Each app declares the permissions it needs in the Developer Center. Ask only for what your app uses.
From idea to the App Market
- Set up the SDK in a web project, or start from the sample app.
- Create your app in the Developer Center.
- Upload a zip of your build and test it in your own studio.
- Submit the version for review. Once it is approved, it can be published to every evmux user.
The Developer Center is in beta. If you do not see it in your dashboard, request access.
Getting started
Widget apps
API reference
Stuck, or found a mistake in these docs? Tell us.