Interface HlsInterstitial

Representation of an HLS interstitial ad.

interface HlsInterstitial {
    adCreativeSignaling?: any;
    assetList?: HlsInterstitialAssetList;
    assetListUri?: string;
    assetUri?: string;
    customAttributes?: {
        [key: string]: any;
    };
    duration?: number;
    end: number;
    id: string;
    jumpPolicy?: JumpPolicy;
    plannedDuration?: number;
    playoutLimit?: number;
    restrict?: RestrictValue[];
    resumeOffset?: number;
    seekingRestriction?: NO_SEEKING;
    start: number;
    triggerPolicy?: TriggerPolicy[];
}

Hierarchy (view full)

Properties

adCreativeSignaling? assetList? assetListUri? assetUri? customAttributes? duration? end id jumpPolicy? plannedDuration? playoutLimit? restrict? resumeOffset? seekingRestriction? start triggerPolicy?

Properties

Optional adCreativeSignaling

adCreativeSignaling?: any

Ad creative signaling data, if present. The data could be present either on ASSET-LIST level or DATE-RANGE level based on SVTA spec.

Optional assetList

assetList?: HlsInterstitialAssetList

Asset list data, if present. The parsed JSON object returned by the URL in assetListUri.

Optional assetListUri

assetListUri?: string

The URL to a JSON object containing a list of interstitials “ASSETS”. Parsed from X-ASSET-LIST. If defined, this takes precedence over assetUri.

Optional assetUri

assetUri?: string

An absolute URL for a single interstitial asset. Parsed from X-ASSET-URI. If assetListUri is defined, this property should be ignored.

Optional customAttributes

customAttributes?: {
    [key: string]: any;
}

Any attributes that is not known in the HLS interstitial spec. The tracking information could be present here, X-AD-CREATIVE-SIGNALING in case of SVTA.

Type declaration

  • [key: string]: any

Optional duration

duration?: number

The actual duration of the interstitial in seconds, if known, otherwise undefined. May differ from end - start, as the end time is always populated with a default of +1.

end

end: number

The end time for the ad in seconds.

id

id: string

The unique identifier for the ad.

Optional jumpPolicy

jumpPolicy?: JumpPolicy

Jump policy for the ad. Determines if at least one ad must play when jumping over multiple ads. Converted from X-RESTRICT attribute by HlsInterstitialsProvider.

Optional plannedDuration

plannedDuration?: number

The expected duration in seconds of the interstitial if duration is not yet known. Usually populated if the interstitial is dynamically updated or features an asset list.

Optional playoutLimit

playoutLimit?: number

Value from X-PLAYOUT-LIMIT header. Defines how long the interstitial is expected to play for, in seconds. Should be intended as a way to exit an interstitial early.

Optional restrict

restrict?: RestrictValue[]

Values from X-RESTRICT header (enumerated-string-list). Defines restrictions on seeking/playback behavior during the interstitial. Can contain multiple restriction values (e.g., [SKIP, JUMP]).

Optional resumeOffset

resumeOffset?: number

Value from X-RESUME-OFFSET header. Defines how much content should be replaced by the interstitial ad. If undefined, the duration of the ad(s) should be used.

Optional seekingRestriction

seekingRestriction?: NO_SEEKING

Seeking restriction for the ad. Determines if seeking is allowed during ad playback. Converted from X-RESTRICT attribute by HlsInterstitialsProvider.

start

start: number

The scheduled start time for the ad in seconds.

Optional triggerPolicy

triggerPolicy?: TriggerPolicy[]

Trigger policy for the interstitial. Defines when the interstitial should be triggered. Converted from CUE attribute by HlsInterstitialsProvider.

Settings

Member Visibility

Theme

On This Page

adCreativeSignalingassetListassetListUriassetUricustomAttributesdurationendidjumpPolicyplannedDurationplayoutLimitrestrictresumeOffsetseekingRestrictionstarttriggerPolicy