IMAAdsManager.h

//
//  IMAAdsManager.h
//  GoogleIMA3
//
//  Copyright (c) 2013 Google Inc. All rights reserved.
//
//  Declares IMAAdsManager interface that manages ad playback.
//  The interface represents an abstract API. There can be one or more ads
//  managed by a single ads manager.
//  The implementing code should respond to the callbacks as defined in
//  IMAAdsManagerDelegate.
//
//  A typical ad playback session:
//    1. Ads manager is retrieved. Delegate is set.
//    2. [adsManager initialize...];  - ad is initialized and loads.
//    3. delegate.didReceiveAdEvent is called with a kIMAAdEventLoaded event.
//    4. [adsManager start];
//    5. delegate.adsManagerDidRequestContentPause: is called. The content
//       playback should pause now.
//    6. Ad display container master view is unhidden and playback starts.
//    7. delegate.didReceiveAdEvent is called with ad events.
//    8. Ad finishes.
//    9. delegate.adsManagerDidRequestContentResume: is called. The content
//       playback should resume now.
//    10. delegate.didReceiveAdEvent: is called with the
//        kIMAAdEvent_ALL_ADS_COMPLETED event.
//        It is possible to detach the delegate and destroy the ads manager.
//
//  If multiple ads are managed by the ads manager, steps 5-9 may repeat several
//  times. Step 5 will happen at times predetermined by the ads server.
//  The implementing code should listen to callbacks until
//  kIMAAdEvent_ALL_ADS_COMPLETED is received.

#import <Foundation/Foundation.h>

@class IMAAdDisplayContainer;
@class IMAAdError;
@class IMAAdEvent;
@class IMAAdsRenderingSettings;

#import "IMAAdPlaybackInfo.h"
#import "IMAContentPlayhead.h"

@class IMAAdsManager;

#pragma mark IMAAdsManagerDelegate

@protocol IMAAdsManagerDelegate

- (void)adsManager:(IMAAdsManager *)adsManager didReceiveAdEvent:(IMAAdEvent *)event;

- (void)adsManager:(IMAAdsManager *)adsManager didReceiveAdError:(IMAAdError *)error;

- (void)adsManagerDidRequestContentPause:(IMAAdsManager *)adsManager;

- (void)adsManagerDidRequestContentResume:(IMAAdsManager *)adsManager;

@optional

- (void)adsManager:(IMAAdsManager *)adsManager
    adDidProgressToTime:(NSTimeInterval)mediaTime
              totalTime:(NSTimeInterval)totalTime;

- (void)adsManagerAdPlaybackReady:(IMAAdsManager *)adsManager;

- (void)adsManagerAdDidStartBuffering:(IMAAdsManager *)adsManager;

- (void)adsManager:(IMAAdsManager *)adsManager adDidBufferToMediaTime:(NSTimeInterval)mediaTime;

@end

#pragma mark - IMAAdsManager

@interface IMAAdsManager : NSObject

@property(nonatomic, weak) NSObject<IMAAdsManagerDelegate> *delegate;

@property(nonatomic, copy, readonly) NSArray *adCuePoints;

@property(nonatomic, strong, readonly) id<IMAAdPlaybackInfo> adPlaybackInfo;

@property(nonatomic, assign) float volume;

- (void)initializeWithAdsRenderingSettings:(IMAAdsRenderingSettings *)adsRenderingSettings;

- (instancetype)init NS_UNAVAILABLE;

- (void)start;

- (void)pause;

- (void)resume;

- (void)skip;

- (void)clicked;

- (void)destroy;

- (void)discardAdBreak;

@end