Skip to main content

Ad Policy

Ad policies are rule sets that can be enforced while handling seek events with media containing adverts. The following are the rules and behaviours defined.

PlaybackFastForwardRule

Ad playback policy applicable with fast forward operation.

RuleDescription
TRICK_FW_PLAY_ALLIt enforces the rule that the player will replay all the ad breaks that were leaped over by the user during trick mode fast forward operation. This is the default rule.
TRICK_FW_PLAY_FIRSTIt enforces the rule that the player will replay only the first ad break that was leaped over by the user during trick mode fast forward operation.
TRICK_FW_PLAY_LASTIt enforces the rule that the player will replay only the last ad break that was leaped over by the user during trick mode fast forward operation.
TRICK_FW_SKIP_ALLIt enforces the rule that the player will skip all the ad breaks that were leaped over by the user during trick mode fast forward operation.

PlaybackRewindRule

Ad playback policy applicable with rewind operation.

RuleDescription
TRICK_RW_PLAY_ALLIt enforces the rule that the player will replay all the ad breaks that were leaped over by the user during trick mode rewind operation. This is the default rule.
TRICK_RW_PLAY_FIRSTIt enforces the rule that the player will replay only the first ad break that was leaped over by the user during trick mode rewind operation.
TRICK_RW_PLAY_LASTIt enforces the rule that the player will replay only the last ad break that was leaped over by the user during trick mode rewind operation.
TRICK_RW_SKIP_ALLIt enforces the rule that the player will skip all the ad breaks that were leaped over by the user during trick mode rewind operation.

PlaybackAutoSeekRule

Ad playback policy applicable with playback starting from a initial playback position.

RuleDescription
AUTO_SEEK_SKIP_ALLIt enforces the rule that the player will start the content without forcing the user to watch any ads that are available from the start of the content to the bookmarked time.
AUTO_SEEK_PLAY_PREROLLIt enforces the rule that the player will force the user to watch the PREROLL ads, while any MIDROLL ads, that are available from the start of the content to the bookmarked time, will be skipped.
AUTO_SEEK_PLAY_MIDROLLIt enforces the rule that the player will force a user to watch at least one MIDROLL ad, while the PREROLL ads will be skipped. Whether the user has to watch all triggered MIDROLL ads, or only one, is determined by the PlaybackFastForwardRule policy value.
AUTO_SEEK_PLAY_ALLIt enforces the rule that the player will force a user to watch the PREROLL ads, then one or more MIDROLL ads. Whether the user has to watch all triggered MIDROLL ads, or only one, is determined by the PlaybackFastForwardRule policy value. This is the default rule.

PlaybackRepeatedRule

Ad playback policy applicable with repeated ad playback in a single playback session.

RuleDescription
REPEAT_ALWAYS_PLAYIt enforces the rule that the player will repeatedly play the ad break, with a given ID, in a single playback session whenever the ad break is triggered.
REPEAT_PLAY_ONCEIt enforces the rule that the player will play the ad break, with a given ID, only once in a single playback session whenever the ad break is triggered. This is the default rule.

AdPolicy with SSAI

The ad policy rules can be set while initialising YoSession.

// create ad playback policy 
let fastForwardRule = flPlayerInterface.PlaybackFastForwardMode.TRICK_FW_PLAY_ALL; // 100
let rewindRule = flPlayerInterface.PlaybackRewindMode.TRICK_RW_PLAY_ALL; // 200
let autoSeekRule = flPlayerInterface.PlaybackAutoSeekMode.AUTO_SEEK_PLAY_PREROLL; // 301
let repeatedRule = flPlayerInterface.PlaybackRepeatedMode.REPEAT_ALWAYS_PLAY; // 400

PlayerModule.setAdsPlaybackPolicies({
fastForwardMode: fastForwardRule,
rewindMode: rewindRule,
autoSeekMode: autoSeekRule,
repeatMode: repeatedRule
})

// create yospace init data
const yospaceInitializationData = {
contentURL: playbackAsset.contentUrl,
playbackMode: playbackMode
}

// initialize the session with the AdPlaybackPolicy

const adYospace = await yospaceAdsSession.initialize(yospaceInitializationData, PlayerModule.getAdsPlaybackPolicies());
playbackAsset.contentUrl = adYospace.url;

Yospace Fallback Handling

yospaceAdsSession.initialize(...) method resolves with PlaybackUrl, SessionStatus and Reason for Failure which provides detailed information on each sessionState.

yospaceSessionStateStatusPlayback UrlReason
INITIALISEDsuccess${ContentURl with yospace}NA
NO_ANALYTICSfallback${fallback url from yospace}Yospace Session initialization Failed with Status : fallback and errorCode : 0
FAILEDerror${origin url}Yospace Session initialization Failed with Status : error and errorCode : -1

const adYospace = await yospaceAdsSession.initialize(yospaceInitializationData, PlayerModule.getAdsPlaybackPolicies());
playbackAsset.contentUrl = adYospace.url;

// This can be used for reporting yospace status and reason for fallback/error.
let yospaceStatus = adYospace.status;
let yospaceReason = adYospace.reason;