OOPulseVideoAd Protocol Reference

Conforms to OOPulseAd
Declared in OOPulseVideoAd.h

Overview

This is the protocol for video ads owned by a OOPulseSession.

This protocol is used to notify the session about events regarding this ad, and provides access to relevant properties.

You must notify this object of the following events:

Depending on your application some of the other methods may need to be called in response to user interaction.

Ad event notifications

– adStarted required method

Notify the session that the ad has started playing.

- (void)adStarted

Discussion

This should only be called after your delegate has been instructed to play the ad through [OOPulseSessionDelegate startAdPlaybackWithAd:timeout:].

Declared In

OOPulseVideoAd.h

– adFinished required method

Notify the session that the ad has played to completion.

- (void)adFinished

Discussion

After this, one of the following delegate methods may be triggered:

Declared In

OOPulseVideoAd.h

– adSkipped required method

Notify the session that the ad was skipped by the user.

- (void)adSkipped

Discussion

After this, one of the following delegate methods may be triggered:

Declared In

OOPulseVideoAd.h

– adPositionChanged: required method

Notify the session that the ad playback position has changed, either as a result of seeking or normal playback.

- (void)adPositionChanged:(NSTimeInterval)position

Parameters

position

The ad position in seconds since start.

Declared In

OOPulseVideoAd.h

– adPaused required method

Notify the session that the ad has paused.

- (void)adPaused

Declared In

OOPulseVideoAd.h

– adResumed required method

Notify the session that the ad has resumed playback.

- (void)adResumed

Declared In

OOPulseVideoAd.h

– adFailedWithError: required method

Notify the session that, due to an error, the ad could not be played or that playback could not continue.

- (void)adFailedWithError:(OOPulseAdError)error

Parameters

error

The OOPulseAdError that best describes the problem.

Declared In

OOPulseVideoAd.h

Ad properties

– mediaFiles required method

Returns an array of media files for this ad.

- (NSArray<OOMediaFile*> *)mediaFiles

Return Value

A NSArray of OOMediaFile instances.

Discussion

Your application should choose the best media file to display based on size bandwidth, and format considerations.

If none of the media files are supported by your video player, you should call [OOPulseVideoAd adFailedWithError:] with OOPulseAdErrorNoSupportedMediaFile.

Declared In

OOPulseVideoAd.h

– isSkippable required method

Determine whether or not a skip button for the ad may be displayed.

- (BOOL)isSkippable

Discussion

If true, check the value of [OOPulseVideoAd skipOffset], which is the amount of seconds from the start of the ad at which the button should first be displayed.

When the viewer activates this button, call [OOPulseVideoAd adSkipped].

Declared In

OOPulseVideoAd.h

– skipOffset required method

The amount of seconds from the start of the ad at which the button should first be displayed.

- (NSTimeInterval)skipOffset

Discussion

If an OOPulseVideoAd is playing, and a call to [OOPulseVideoAd isSkippable] returns YES, show a skip button after this amount of seconds has passed.

Declared In

OOPulseVideoAd.h

– variant required method

The ad variant type.

- (OOPulseAdVariant)variant

See Also

Declared In

OOPulseVideoAd.h

– identifier required method

The ad id.

- (NSString *)identifier

Declared In

OOPulseVideoAd.h

– isReady required method

Indicates whether the ad is ready to be displayed.

- (BOOL)isReady

Declared In

OOPulseVideoAd.h

– maximumPreparationTime required method

The maximum time in seconds the SDK waits for a ‘lazy’ ad to load (including potential passback candidate requests).

- (NSTimeInterval)maximumPreparationTime

Declared In

OOPulseVideoAd.h

– startTimeout required method

The maximum time in seconds the end user should be allowed to wait for an ad to load before the ad must be discarded.

- (NSTimeInterval)startTimeout

Declared In

OOPulseVideoAd.h

– candidateNum required method

The candidate ad number in the passback chain.

- (NSInteger)candidateNum

Declared In

OOPulseVideoAd.h

– customIdentifier required method

The custom ad identifier set in the Ooyala Pulse UI.

- (NSString *)customIdentifier

Declared In

OOPulseVideoAd.h

– campaignIdentifier required method

The Identifier of the campaign to which the ad belongs; supplied by Ooyala Pulse.

- (NSString *)campaignIdentifier

Declared In

OOPulseVideoAd.h

– customCampaignIdentifier required method

The custom Identifier of the campaign to which the ad belongs; set in the Ooyala Pulse UI.

- (NSString *)customCampaignIdentifier

Declared In

OOPulseVideoAd.h

– goalIdentifier required method

The Identifier of the goal to which the ad belongs; supplied by Ooyala Pulse.

- (NSString *)goalIdentifier

Declared In

OOPulseVideoAd.h

– customGoalIdentifier required method

The custom Identifier of the goal to which the ad belongs; set in the Ooyala Pulse UI.

- (NSString *)customGoalIdentifier

Declared In

OOPulseVideoAd.h

– partOfAnExclusiveCampaign required method

Whether or not the ad is part of an exclusive campaign.

- (BOOL)partOfAnExclusiveCampaign

Declared In

OOPulseVideoAd.h

– showCountdown required method

Whether or not to display a remaining time countdown when this ad is being displayed.

- (BOOL)showCountdown

Declared In

OOPulseVideoAd.h

– hasPassback required method

Returns YES if this ad has passback ad sources available.

- (BOOL)hasPassback

Declared In

OOPulseVideoAd.h

– isConditionalAd required method

A Boolean value that identifies a conditional ad. A value of true indicates that the ad is conditional and should be used in all cases where the inline executable unit (such as VPAID) is not an ad but is instead a framework for finding an ad; a value of false is the default value and indicates that an ad is available.

- (BOOL)isConditionalAd

Declared In

OOPulseVideoAd.h

– survey required method

A URL to any resource relating to an integrated survey.

- (NSURL *)survey

Declared In

OOPulseVideoAd.h

– surveys required method

An array containing all the OOSurvey elements, containing any resource relating to an integrated survey.

- (NSArray *)surveys

Declared In

OOPulseVideoAd.h

– title required method

A string that provides a common name for the ad.

- (NSString *)title

Declared In

OOPulseVideoAd.h

– advertiser required method

A string that provides the name of the advertiser as defined by the ad serving party.

- (NSString *)advertiser

Declared In

OOPulseVideoAd.h

– adDescription required method

A string value that describes a longer description of the ad.

- (NSString *)adDescription

Declared In

OOPulseVideoAd.h

– adPricing required method

Used to provide a value that represents a price that can be used by real-time bidding (RTB) systems.

- (OOAdPricing *)adPricing

Declared In

OOPulseVideoAd.h

– categories required method

An array of OOAdCategory objects containing the categories of the Ad and their responsible authorities.

- (NSArray *)categories

Declared In

OOPulseVideoAd.h

– adVerifications required method

An array containing the OOAdVerification elements, which are used to initiate a controlled container where code can be executed for collecting data to verify ad playback details.

- (NSArray *)adVerifications

Declared In

OOPulseVideoAd.h

– adSystem required method

Information about the system that serves the ad.

- (OOAdSystem *)adSystem

Declared In

OOPulseVideoAd.h

– companions required method

Returns an array of companion banners for this ad.

- (NSArray<id<OOPulseCompanionAd> > *)companions

Return Value

A NSArray of objects conforming to the OOPulseCompanionAd protocol.

Discussion

Your application should choose the proper companion banner to display based on their zone identifier.

Declared In

OOPulseVideoAd.h