Skip to main content
This page walks through installing the Streampixel Web SDK from GitHub, importing it, and confirming the install works.

​
Install the SDK

The SDK is hosted on GitHub. Make sure you have access to the repository before running the install command.
npm install git+https://github.com/infinity-void-metaverse/Streampixel-Web-SDK.git#latest

​
Import

import { StreamPixelApplication } from 'streampixelsdk';
That’s it — you’re ready to use the SDK.

​
Quick verify

import { StreamPixelApplication } from 'streampixelsdk';

const { appStream, pixelStreaming } = await StreamPixelApplication({
  appId: 'YOUR_PROJECT_ID',
  AutoConnect: true,
});
If this runs without errors, the SDK is installed correctly.

​
Using the example app

The fastest way to get started is to clone the example app, which comes pre-configured.
1

Clone the example repository

git clone https://github.com/infinity-void-metaverse/Streampixel-SDK-Example.git
2

Install dependencies

cd Streampixel-SDK-Example
npm install
3

Start the dev server

npm start
Open http://localhost:3000/YOUR_PROJECT_ID in your browser.

​
Next steps

Quick start

Build a minimal working integration in a single HTML file.

Initialization and configuration

Learn the configuration options accepted by StreamPixelApplication.