Installation

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:

git clone https://github.com/infinity-void-metaverse/Streampixel-SDK-Example.git
cd Streampixel-SDK-Example
npm install
npm start

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

Next Steps

Quick StartInitialization and Configuration