Interface SessionConfiguration

The object of MediaTailor session configurations.

interface SessionConfiguration {
    adTrackingUpdateMode?: "full" | "playhead" | "pagination";
    defaultTrackingRequestInterval?: number;
    incomingAdCountdownInterval?: number;
    originParams?: {
        [key: string]: string;
    };
    palNonceManager?: any;
    palNonceRequestParams?: PalNonceRequestParams;
    playerParams?: {
        [key: string]: string;
    };
    sessionFeatures?: {
        adSignaling?: "on";
        availSuppression?: "on";
        overlayAvails?: "on";
        reportingMode?: "server";
    };
    sessionInitHeaders?: {
        [key: string]: string;
    };
    sessionInitUrl?: string;
    trackingUrl?: string;
}

Properties

adTrackingUpdateMode? defaultTrackingRequestInterval? incomingAdCountdownInterval? originParams? palNonceManager? palNonceRequestParams? playerParams? sessionFeatures? sessionInitHeaders? sessionInitUrl? trackingUrl?

Properties

Optional adTrackingUpdateMode

adTrackingUpdateMode?: "full" | "playhead" | "pagination"

The mode which controls how client-side tracking requests are managed. If set to playhead, the current playhead position will be included as a request query parameter to allow the server sending only the tracking info for ads close to the current playhead position. If set to pagination, a pagination token will be included as a request query parameter to allow the server to avoid resending tracking info that was already transmitted. If set to full, the server would send tracking info for all ads that exist in the manifest window. If left unspecified, the pagination mode would be chosen by default.

In order to use the playhead mode, the customer needs to open a support ticket with AWS to enable the feature in the MediaTailor Playback Configuration. When enabled, the server would return up to two avails that are closest to the current playhead position.

Optional defaultTrackingRequestInterval

defaultTrackingRequestInterval?: number

The default interval (in seconds) between consecutive client-side tracking requests. If it is set to 0 or left unspecified, the built-in default value will be used. If it is set to a negative value, the periodic ad tracking info polling will be suspended.

Optional incomingAdCountdownInterval

incomingAdCountdownInterval?: number

Emit UI event AD_INCOMING if the next ad will start within this interval (in seconds).

Optional originParams

originParams?: {
    [key: string]: string;
}

Parameters (key/value pairs) for origin interaction.

Type declaration

  • [key: string]: string

Optional palNonceManager

palNonceManager?: any

The NonceManager object created by Google PAL SDK, which should be specified only if the step to request for a nonce (and create such an object) is already completed elsewhere.

Optional palNonceRequestParams

palNonceRequestParams?: PalNonceRequestParams

Parameters for Google PAL SDK to request for a nonce with. This field will be ignored if the palNonceManager field is specified.

Optional playerParams

playerParams?: {
    [key: string]: string;
}

Parameters (key/value pairs) for the ad server.

Type declaration

  • [key: string]: string

Optional sessionFeatures

sessionFeatures?: {
    adSignaling?: "on";
    availSuppression?: "on";
    overlayAvails?: "on";
    reportingMode?: "server";
}

MediaTailor features for the session.

Type declaration

  • Optional adSignaling?: "on"

    TODO: add description

  • Optional availSuppression?: "on"

    TODO: add description

  • Optional overlayAvails?: "on"

    TODO: add description

  • Optional reportingMode?: "server"

    To enable hybrid tracking (server-side beaconing).

Optional sessionInitHeaders

sessionInitHeaders?: {
    [key: string]: string;
}

Extra HTTP headers (key/value pairs) for MediaTailor session initialization.

Type declaration

  • [key: string]: string

Optional sessionInitUrl

sessionInitUrl?: string

The absolute URL for MediaTailor session initialization.

Optional trackingUrl

trackingUrl?: string

The absolute URL of the client-side tracking API. This field should be set only if the MediaTailor session is already initialized elsewhere.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc