Web SDK installation and setup
MeshStream Web SDK adds P2P acceleration to HLS and DASH playback without replacing the existing player. MP4 and MP3 acceleration is enabled only when Service Worker is available. The player keeps manifest parsing, ABR, decoding, and rendering; the SDK owns playback sessions and acceleration handling.
Before you start
- An SDK Key created in the console.
- A playable HLS
.m3u8, DASH.mpd, or an MP4/MP3 URL with Range support. - A
<video>or<audio>element in the page.
Install the SDK:
npm install @meshstream/p2p-web
Browser and player integration choices
Choose the transport path from browser capability, then choose the integration API from player ownership. getCapability() can power an integration hint; whether P2P is actually enabled still depends on the runtime and service policy.
| Environment | HLS / DASH integration | P2P path | Notes |
|---|---|---|---|
| Chromium browsers, including Chrome and Edge | Use attach for a new page; see attachToHls, Shaka, and dash.js adapters in Advanced Usage for existing players | MSE + WebRTC preferred | Recommended Web P2P environment. |
| Firefox | Use attach or the relevant player adapter | Enabled when both MSE and WebRTC are available | Use the runtime capability result. |
| macOS Safari | Use attach and rely on runtime capability detection; DASH depends on the host player | Standard MSE + WebRTC when MSE is available; Service Worker can also be forced for controlled rollout | Do not make a static decision by browser name; check getCapability() first. |
| iPhone/iPad Safari | Native <video> for HLS with a same-origin Service Worker | Native player + Service Worker P2P | iOS/iPadOS Safari has no MSE HLS P2P path. P2P is enabled after the Worker activates and controls the page; otherwise playback falls back to CDN. |
| Direct MP4 / MP3 playback | Deploy the same-origin Worker script; Advanced Usage can explicitly configure its path and scope | Same-origin Service Worker + Range P2P only | The SDK attempts Worker registration by default. If the Worker is inactive, HTTPS is unavailable, or the origin lacks Range support, playback continues through CDN. |
Existing players do not need to migrate: use attachToHls for hls.js, attachToShaka for Shaka, attachToDashJs for dash.js, attachToVhs for Video.js VHS, and attachToRxPlayer for RxPlayer. Initialization order and capability boundaries are in Advanced Usage.
Next step
After completing the setup above, continue to Quick integration to create a session, connect your player, and release playback resources.