Configuration Overview¶
NGXSP configuration is separated into four blocks.
| Block | Object | Responsibility |
|---|---|---|
| Media | PlayerSource |
Describes what must be loaded: type, URL, file, DRM, sidecars, metadata. |
| Experience | PlayerConfig |
Describes progress, UI, resilience, subtitles, metadata, ads, playlist, and offline. |
| Runtime | PlayerFacade |
Attaches the video, installs plugins, ports, and engines, then loads the configuration. |
| Integration | Angular or custom shell | Provides the UI and maps runtime events to the product. |
Checklist¶
- Provide an explicit
source.type. - Provide
source.urlorsource.filedepending on the type. - Add a stable
contentIdwhen progress, metadata, subtitles, or offline exist. - Use
createDefaultConfigto make default values visible. - Install the Shaka engine only if HLS, DASH, DRM, or advanced ABR are required.
- Pass HTTP/storage/telemetry ports when an external provider or remote config depends on them.
- Add plugins in
attach, not only inpackage.json.