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 latest
branch.
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
Last updated