Skip to content

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

  1. Provide an explicit source.type.
  2. Provide source.url or source.file depending on the type.
  3. Add a stable contentId when progress, metadata, subtitles, or offline exist.
  4. Use createDefaultConfig to make default values visible.
  5. Install the Shaka engine only if HLS, DASH, DRM, or advanced ABR are required.
  6. Pass HTTP/storage/telemetry ports when an external provider or remote config depends on them.
  7. Add plugins in attach, not only in package.json.