OOVASTVMAPAdSpot Class Reference

Defines all information around an Ad Spot as it was defined in a VMAP XML. More...

#import <OOVASTVMAPAdSpot.h>

+ Inheritance diagram for OOVASTVMAPAdSpot:

Instance Methods

(instancetype) - initWithOffset:duration:repeatAfter:breakType:breakId:sourceId:allowMultipleAds:followRedirects:element:
 
(instancetype) - initWithOffset:duration:repeatAfter:breakType:breakId:sourceId:allowMultipleAds:followRedirects:vastUrl:
 
(BOOL) - isRepeatable
 return true if VMAP ad is repeatable, otherwise not More...
 
(void) - markAsPlayed
 mark the ad spot as played More...
 
(void) - markAsUnplayed
 mark the ad spot as unplayed More...
 
- Instance Methods inherited from OOVASTAdSpot
(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...
 

Properties

OOVASTOffsettimeOffset
 
NSString * breakType
 
NSString * breakId
 
NSString * adSourceId
 
BOOL allowMultipleAds
 
BOOL followRedirects
 
- Properties inherited from OOVASTAdSpot
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:
 
- Protected Attributes inherited from OOVASTAdSpot
NSString * signature
 The signature for the vast request. More...
 
NSInteger expires
 The expires for the vast request. More...
 
NSMutableArray * ads
 The actual ads. More...
 

Detailed Description

Defines all information around an Ad Spot as it was defined in a VMAP XML.

Method Documentation

- (instancetype) initWithOffset: (OOVASTOffset *)  timeOffset
duration: (NSInteger)  duration
repeatAfter: (Float64)  repeatAfter
breakType: (NSString *)  breakType
breakId: (NSString *)  breakId
sourceId: (NSString *)  sourceId
allowMultipleAds: (BOOL)  allowMultipleAds
followRedirects: (BOOL)  followRedirects
element: (OOTBXMLElement *)  element 
- (instancetype) initWithOffset: (OOVASTOffset *)  timeOffset
duration: (NSInteger)  duration
repeatAfter: (Float64)  repeatAfter
breakType: (NSString *)  breakType
breakId: (NSString *)  breakId
sourceId: (NSString *)  sourceId
allowMultipleAds: (BOOL)  allowMultipleAds
followRedirects: (BOOL)  followRedirects
vastUrl: (NSURL *)  vastUrl 
- (BOOL) isRepeatable

return true if VMAP ad is repeatable, otherwise not

- (void) markAsPlayed

mark the ad spot as played

- (void) markAsUnplayed

mark the ad spot as unplayed

Property Documentation

- (NSString*) adSourceId
readnonatomicassign
- (BOOL) allowMultipleAds
readnonatomicassign
- (NSString*) breakId
readnonatomicassign
- (NSString*) breakType
readnonatomicassign
- (BOOL) followRedirects
readnonatomicassign
- (OOVASTOffset*) timeOffset
readnonatomicassign

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