Tracking

Configuration

HLS interstitial ad tracking is opt-in.
Tracking is enabled by configuring HlsConfig.interstitialsConfig with an InterstitialsConfig.

If provided, a CustomAttributesMappingHandler is invoked for each of the following elements that contain custom X- attributes:

  • EXT-X-DATERANGE tags
  • ASSET-LIST root objects
  • ASSET entries

This handler allows translating metadata into click-through URLs and tracking beacons through the InterstitialCustomAttributesMappingRegistry.

Use CustomAttributesMappingPresets.adCreativeSignaling to automatically decode SVTA X-AD-CREATIVE-SIGNALING payloads.


Tracking Events

Tracking beacons are represented as InterstitialTrackingEvent instances.
They are stored inside an asset-scoped InterstitialTrackingRegistry.

Beacons are dispatched when the corresponding InterstitialTrackingEventTrigger fires during playback.
Supported triggers include:

  • Impression
  • Quartiles
  • Skip
  • Error
  • Other playback-related events

Macro Expansion

Before any tracking request is sent, macros inside tracking URLs are expanded.
Macro values can be customized using an InterstitialMacroValueProvider.

This provider extends the default replacements for:

  • CACHEBUSTING
  • TIMESTAMP
  • ERRORCODE

This allows controlled overrides of macro behaviour when integrating interstitial tracking.