Represents all VAST information from a root VAST XML file. More...

#import <OOVASTAdSpot.h>

+ Inheritance diagram for OOVASTAdSpot:

Instance Methods

(instancetype) - initWithOffset:duration:element:
 
(instancetype) - initWithTime:duration:clickURL:trackingURLs:vastURL:
 Initialize a OOVASTAdSpot using the VAST URL. More...
 
(instancetype) - initWithDictionary:api:duration:
 
(OOReturnState) - updateWithDictionary:
 
(BOOL) - fetchPlaybackInfo
 
- Instance Methods inherited from OOAdSpot
(instancetype) - initWithTime:
 Initialize an ad spot with time. More...
 
(NSComparisonResult) - compare:
 compare two ad spots based on their time * More...
 

Protected Attributes

NSString * signature
 The signature for the vast request. More...
 
NSInteger expires
 The expires for the vast request. More...
 
NSMutableArray * ads
 The actual ads. More...
 

Properties

NSURL * vastURL
 The url for the vast request. More...
 
NSMutableArray * vmapAdSpots
 The vmap ad spots. More...
 
NSInteger contentDuration
 The duration of the ad. More...
 
NSMutableDictionary * errors
 The errors of ads. More...
 
- Properties inherited from OOManagedAdSpot
NSURL * clickURL
 The URL which should be opened when the OOAdSpot is clicked. More...
 
NSArray * trackingURLs
 The Array of URLs which should be pinged when the OOAdSpot plays. More...
 
- Properties inherited from OOAdSpot
NSNumber * time
 time to play the ad in second More...
 
int priority
 the priority to distinguish ad spots of same time, adspot having a smaller priority will be played first More...
 

Additional Inherited Members

- Class Methods inherited from OOManagedAdSpot
(OOManagedAdSpot *) + adSpotFromDictionary:api:duration:
 

Detailed Description

Represents all VAST information from a root VAST XML file.

May have multiple vast XMLs as part of the ad hierarchy.

Method Documentation

- (BOOL) fetchPlaybackInfo
- (instancetype) initWithDictionary: (NSDictionary *)  data
api: (OOPlayerAPIClient *)  theAPI
duration: (NSInteger)  duration 
- (instancetype) initWithOffset: (NSInteger)  timeoffset
duration: (NSInteger)  duration
element: (OOTBXMLElement *)  e 
- (instancetype) initWithTime: (NSNumber *)  theTime
duration: (NSInteger)  duration
clickURL: (NSURL *)  theClickURL
trackingURLs: (NSArray *)  theTrackingURLs
vastURL: (NSURL *)  theVASTURL 

Initialize a OOVASTAdSpot using the VAST URL.

Parameters
[in]theTimethe time at which to play the ad
[in]theClickURLthe clickthrough URL
[in]theTrackingURLsthe tracking URLs
[in]theVASTURLthe VAST URL to initialize the OOVASTAdSpot with
Returns
the initialized OOVASTAdSpot
- (OOReturnState) updateWithDictionary: (NSDictionary *)  data

Member Data Documentation

- (NSMutableArray *) ads
readnonatomicassignprotected

The actual ads.

- (NSInteger) expires
readnonatomicassignprotected

The expires for the vast request.

- (NSString *) signature
readnonatomicassignprotected

The signature for the vast request.

Property Documentation

- (NSInteger) contentDuration
readnonatomicassign

The duration of the ad.

- (NSMutableDictionary*) errors
readnonatomicassign

The errors of ads.

- (NSURL*) vastURL
readnonatomicassign

The url for the vast request.

- (NSMutableArray*) vmapAdSpots
readnonatomicassign

The vmap ad spots.


The documentation for this class was generated from the following file: