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

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

Last updated