Class: shaka.ads.SvtaInterstitialParser

Constructor

new SvtaInterstitialParser()

Source:

Members

KEY :string

The HLS attribute, and asset list field, that carries the signaling.
Type:
  • string
Source:

Methods

createDeferredPod_(podnon-null, startTime, id, networkingEnginenon-null) → {shaka.extern.DeferredInterstitial}

Parameters:
Name Type Description
pod shaka.extern.AdCreativeSignaling.Pod
startTime number
id string
networkingEngine shaka.net.NetworkingEngine
Source:
Returns:
Type
shaka.extern.DeferredInterstitial

decodeMetadata(metadata) → {*}

Parameters:
Name Type Description
metadata shaka.extern.HLSMetadata
Source:
Returns:
The decoded signaling, or null if there is none.
Type
*

decorateInterstitial(interstitialnon-null, data, podopt, nullable)

Attaches validated slot metadata to media identified by another format, if the signaling describes a single slot. SVTA does not supply the URI or change stitching decisions.
Parameters:
Name Type Attributes Default Description
interstitial shaka.extern.AdInterstitial
data *
pod shaka.extern.AdCreativeSignaling.Pod <optional>
<nullable>
 null
Source:

isArray_(value, validate) → {boolean}

Parameters:
Name Type Description
value *
validate function(?Object): boolean
Source:
Returns:
Type
boolean

isPod_(valuenullable, remoteFields) → {boolean}

Parameters:
Name Type Attributes Description
value Object <nullable>
remoteFields boolean
Source:
Returns:
Type
boolean

isRemote_(valuenullable, enabled) → {boolean}

Remote fields are URLs, only allowed when the envelope declares them.
Parameters:
Name Type Attributes Description
value Object <nullable>
enabled boolean
Source:
Returns:
Type
boolean

isSlot_(valuenullable, remoteFields) → {boolean}

Parameters:
Name Type Attributes Description
value Object <nullable>
remoteFields boolean
Source:
Returns:
Type
boolean

isTime_(value) → {boolean}

Parameters:
Name Type Description
value *
Source:
Returns:
Type
boolean

isTrackingEvent_(valuenullable) → {boolean}

Parameters:
Name Type Attributes Description
value Object <nullable>
Source:
Returns:
Type
boolean

isValidMetadata(metadata) → {boolean}

Parameters:
Name Type Description
metadata shaka.extern.HLSMetadata
Source:
Returns:
Type
boolean

isValidRegion(region) → {boolean}

Parameters:
Name Type Description
region shaka.extern.TimelineRegionInfo
Source:
Returns:
Type
boolean

makeInterstitial_(slotnon-null, podnullable, anchor, id, groupId, podSize, podPosition) → {shaka.extern.AdInterstitial}

Parameters:
Name Type Attributes Description
slot shaka.extern.AdCreativeSignaling.Slot
pod shaka.extern.AdCreativeSignaling.Pod <nullable>
anchor number
id string
groupId string
podSize number
podPosition number
Source:
Returns:
Type
shaka.extern.AdInterstitial

parseEnvelope(data, expectedTypeopt) → {shaka.extern.AdCreativeSignaling.CarriageEnvelope}

Validates an envelope before any of its payload is used. The version is not checked, so earlier signaling without version, envelope type, slot type or identifiers is accepted.
Parameters:
Name Type Attributes Description
data *
expectedType string <optional>
Source:
Returns:
Type
shaka.extern.AdCreativeSignaling.CarriageEnvelope

parseInterstitials(data, anchor, id, networkingEngineopt, nullable) → {shaka.ads.SvtaInterstitialParser.Result}

Parameters:
Name Type Attributes Default Description
data *
anchor number
id string
networkingEngine shaka.net.NetworkingEngine <optional>
<nullable>
 null Used to resolve remote pod slots. Without it, pods with remote slots are ignored.
Source:
Returns:
Type
shaka.ads.SvtaInterstitialParser.Result

parseMetadata(metadata, networkingEngineopt, nullable) → {shaka.ads.SvtaInterstitialParser.Result}

Parameters:
Name Type Attributes Default Description
metadata shaka.extern.HLSMetadata
networkingEngine shaka.net.NetworkingEngine <optional>
<nullable>
 null Used to resolve remote pod slots. Without it, pods with remote slots are ignored.
Source:
Returns:
Type
shaka.ads.SvtaInterstitialParser.Result

parseRegion(region, networkingEngineopt, nullable) → {shaka.ads.SvtaInterstitialParser.Result}

Parameters:
Name Type Attributes Default Description
region shaka.extern.TimelineRegionInfo
networkingEngine shaka.net.NetworkingEngine <optional>
<nullable>
 null Used to resolve remote pod slots. Without it, pods with remote slots are ignored.
Source:
Returns:
Type
shaka.ads.SvtaInterstitialParser.Result

Type Definitions

Result

Type:
Properties:
Name Type Description
interstitials Array<shaka.extern.AdInterstitial> Interstitials ready to be scheduled.
deferred Array<!shaka.extern.DeferredInterstitial> Pods whose slots must be resolved before they can be scheduled.
Source: