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.

build

fun build(): SessionConfiguration

defaultTrackingRequestInterval

fun defaultTrackingRequestInterval(value: Double): SessionConfiguration.Builder

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.

disableNoninteractiveClientSideBeaconing

fun disableNoninteractiveClientSideBeaconing(value: Boolean): SessionConfiguration.Builder

Whether non-interactive client-side beaconing should be disabled for the MediaTailor session. If it is left unspecified, the default value is false (i.e., all beaconing remains enabled).

incomingAdCountdownInterval

fun incomingAdCountdownInterval(value: Double): SessionConfiguration.Builder

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

originParams

fun originParams(value: Map<String, String>): SessionConfiguration.Builder

Parameters (key/value pairs) for origin interaction.

palNonceRequestParams

fun palNonceRequestParams(value: PalNonceRequestParams): SessionConfiguration.Builder

Parameters for Google PAL SDK to request for a nonce with. This field will be ignored if the {@link palNonceString} field is specified.

palNonceString

fun palNonceString(value: String): SessionConfiguration.Builder

The nonce string generated by Google PAL SDK, which should be specified only if the step to request for a nonce is already completed elsewhere.

playerParams

fun playerParams(value: Map<String, String>): SessionConfiguration.Builder

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

sessionFeatures

fun sessionFeatures(value: SessionFeatures): SessionConfiguration.Builder

MediaTailor features for the session.

sessionInitHeaders

fun sessionInitHeaders(value: Map<String, String>): SessionConfiguration.Builder

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

sessionInitTimeout

fun sessionInitTimeout(value: Long): SessionConfiguration.Builder

The request timeout (in milliseconds) for MediaTailor session initialization. If set to 0, no timeout is applied. Defaults to 30000 milliseconds if unspecified.

sessionInitUrl

fun sessionInitUrl(value: String): SessionConfiguration.Builder

The absolute URL for MediaTailor session initialization.

trackingUrl

fun trackingUrl(value: String): SessionConfiguration.Builder

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