Skip to content

Installation

Install the Runtime

npm i @ngxsp/core

@ngxsp/core carries types, the facade, errors, ports, plugins, and the native engine. It must not depend on Angular.

Add an Adaptive Engine

npm i @ngxsp/engine-shaka shaka-player

Shaka is required for most HLS, DASH, DRM, ABR, and advanced track needs. The native engine remains useful for simple files or browser fallback.

Add Adapters

npm i @ngxsp/adapter-http-fetch
npm i @ngxsp/adapter-storage-local
npm i @ngxsp/adapter-storage-indexeddb

Adapters connect the runtime to host capabilities: HTTP, local storage, IndexedDB, logs, or telemetry.

Add Plugins and Providers

npm i @ngxsp/plugin-offline @ngxsp/telemetry-core

Metadata, subtitles, ads, and offline support must stay optional to keep the core small.

Add the Angular Shell

npm i @ngxsplayer/ngx-smart-player

The Angular component consumes @ngxsp/* contracts. It must not become the public boundary of the whole ecosystem.