BCOVIMAAdsRequestPolicy Class Reference

Inherits from NSObject
Declared in BCOVIMAAdsRequestPolicy.h

Overview

Policy object to generate IMAAdsRequests for use by a given input playback session.

+ videoPropertiesVMAPAdTagUrlAdsRequestPolicy

Returns an ads request policy that checks the BCOVVideo object in each playback session for the VMAP ad tag URL to request. If the video object’s properties contains an entry whose key is kBCOVIMAAdTag, the value of that entry is assumed to be a NSString containing the VMAP ad tag URL. That URL will be used to construct a VMAP IMAAdsRequest for that playback session.

+ (instancetype)videoPropertiesVMAPAdTagUrlAdsRequestPolicy

Return Value

An ads request policy that generates VMAP IMAAdsRequests from information in each playback session’s BCOVVideo.properties.

Discussion

Returns an ads request policy that checks the BCOVVideo object in each playback session for the VMAP ad tag URL to request. If the video object’s properties contains an entry whose key is kBCOVIMAAdTag, the value of that entry is assumed to be a NSString containing the VMAP ad tag URL. That URL will be used to construct a VMAP IMAAdsRequest for that playback session.

Use this policy when you want the ability to specify a different VMAP ad tag URL for different videos.

Declared In

BCOVIMAAdsRequestPolicy.h

+ adsRequestPolicyWithVMAPAdTagUrl:

Returns an ads request policy that generates a VMAP IMAAdsRequest with the specified ad tag URL and companion slots for every playback session.

+ (instancetype)adsRequestPolicyWithVMAPAdTagUrl:(NSString *)VMAPAdTagUrl

Parameters

VMAPAdTagUrl

The ad tag URL to include in the IMAAdsRequest this policy generates. Currently, only VMAP ad tag URLs are supported.

Return Value

An ads request policy that generates VMAP IMAAdsRequests from the specified parameters.

Discussion

Returns an ads request policy that generates a VMAP IMAAdsRequest with the specified ad tag URL and companion slots for every playback session.

Use this policy when you want to use the same VMAP ad tag URL for all videos.

Declared In

BCOVIMAAdsRequestPolicy.h

+ adsRequestPolicyWithVASTAdTagsInCuePointsAndAdsCuePointProgressPolicy:

Returns an ads request policy that checks each BCOVVideo for BCOVCuePoints of type ‘kBCOVIMACuePointTypeAd’. If the cuepoint object’s properties contains an entry whose key is kBCOVIMAAdTag, the value of that entry is assumed to be a NSString containing the VAST ad tag URL. That URL will be used to construct a VAST IMAAdsRequest for that playback session.

+ (instancetype)adsRequestPolicyWithVASTAdTagsInCuePointsAndAdsCuePointProgressPolicy:(BCOVCuePointProgressPolicy *)adsCuePointProgressPolicy

Parameters

adsCuePointProgressPolicy

The cue point progress policy specified for VAST ads requests cue points. If this parameter is nil, +[BCOVCuePointProgressPolicy progressPolicyProcessingCuePoints:BCOVProgressPolicyProcessAllCuePoints resumingPlaybackFrom:BCOVProgressPolicyResumeFromContentPlayhead ignoringPreviouslyProcessedCuePoints:NO] will be used as default.

Return Value

An ads request policy that generates VAST IMAAdsRequests from information in each playback video’s BCOVCuePoint.properties.

Discussion

Returns an ads request policy that checks each BCOVVideo for BCOVCuePoints of type ‘kBCOVIMACuePointTypeAd’. If the cuepoint object’s properties contains an entry whose key is kBCOVIMAAdTag, the value of that entry is assumed to be a NSString containing the VAST ad tag URL. That URL will be used to construct a VAST IMAAdsRequest for that playback session.

Use this policy when you want the ability to specify a different VAST ad tag URL for different cuepoints.

Declared In

BCOVIMAAdsRequestPolicy.h

+ adsRequestPolicyFromCuePointPropertiesWithAdTag:adsCuePointProgressPolicy:

Returns an ads request policy that checks each BCOVVideo for BCOVCuePoints of type ‘kBCOVIMACuePointTypeAd’. The cuepoint properies will be appended on ad tag as query parameters. That URL will be used to construct a VAST IMAAdsRequest for that playback session.

+ (instancetype)adsRequestPolicyFromCuePointPropertiesWithAdTag:(NSString *)adTag adsCuePointProgressPolicy:(BCOVCuePointProgressPolicy *)adsCuePointProgressPolicy

Parameters

adTag

The ad tag URL to include in the IMAAdsRequest this policy generates.
adsCuePointProgressPolicy

The cue point progress policy specified for VAST ads requests cue points. If this parameter is nil, +[BCOVCuePointProgressPolicy progressPolicyProcessingCuePoints:BCOVProgressPolicyProcessAllCuePoints resumingPlaybackFrom:BCOVProgressPolicyResumeFromContentPlayhead ignoringPreviouslyProcessedCuePoints:NO] will be used as default.

Return Value

An ads request policy that generates VAST IMAAdsRequests from adTag and information in each playback video’s BCOVCuePoint.properties.

Discussion

Returns an ads request policy that checks each BCOVVideo for BCOVCuePoints of type ‘kBCOVIMACuePointTypeAd’. The cuepoint properies will be appended on ad tag as query parameters. That URL will be used to construct a VAST IMAAdsRequest for that playback session.

Use this policy when you want to use the same VAST ad tag URL for all cuepoints.

Declared In

BCOVIMAAdsRequestPolicy.h