Installation

This page helps developers set up the Streampixel WebSDK in their frontend project.

Installing the SDK

npm install https://github.com/infinity-void-metaverse/Streampixel-Web-SDK

Installing via the direct GitHub URL (e.g. npm install https://github.com/infinity-void-metaverse/Streampixel-Web-SDK) will always fetch the latest version of the WebSDK from the latestbranch.

This is great for getting new features — but be aware that if you run this again a few months later, the SDK may have changed. While we strive to maintain backward compatibility, it's possible that newer versions introduce breaking changes.

✅ Recommendation: For production or version-locked environments, install using a specific release tag like this: npm install https://github.com/infinity-void-metaverse/Streampixel-Web-SDK#release/v1.0.0

📁 Folder Structure (Recommended)

Create your React (or other framework) component and import the SDK as shown:

/src
  └── components/
        └── StreamPixelApp.js
  └── App.js
  └── index.js

✅ Importing the SDK

import { StreamPixelApplication } from 'streampixelsdk';

You’ll call StreamPixelApplication() to initiate the connection, control video output, and expose runtime handlers like UIControl and PixelStreaming.

🔐 Requirements

• ✅ Node.js v16 or later

• ✅ Modern browser (Chrome, Firefox, Edge)

• ✅ An active App ID from the StreamPixel Dashboard

• ✅ Your project must be deployed over HTTPS for audio/microphone support

WebSDK is for advance user. If you want basic integeration without much work you can refer ot our iframe integeration documentation