ATVAdSchedule

@interface ATVAdSchedule : NSObject <NSCopying>

Ad container holds all the ad breaks that will be played in the video player.

  • Preroll ads in sorted order

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSMutableArray<ATVAd *> *preRolls;

    Swift

    var preRolls: NSMutableArray! { get }

  • Midroll ads in sorted order

    Declaration

    Objective-C

    @property (readonly, nonatomic)
    NSMutableArray<NSMutableArray<ATVAd *> *> *midRolls;

    Swift

    var midRolls: NSMutableArray! { get }

  • Postroll ads in sorted order

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSMutableArray<ATVAd *> *postRolls;

    Swift

    var postRolls: NSMutableArray! { get }

  • Midroll offsets in sorted order

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSMutableArray<NSNumber *> *midRollOffsets;

    Swift

    var midRollOffsets: NSMutableArray! { get }

  • Customize the ad loading text.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) NSString *adLoadingText;

    Swift

    var adLoadingText: String! { get set }

  • Customize the ad countdown text. Remember to have a %d placehold to show the number of seconds left for that video ad.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) NSString *adCountdownText;

    Swift

    var adCountdownText: String! { get set }

  • Customize the ad pod countdown text. Remember to have %1$d, %2$d and %3$d to show the number of seconds left for recently playing video ad, the number of recently playing video ad and the total count of video ads respectively.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) NSString *adpodCountdownText;

    Swift

    var adpodCountdownText: String! { get set }

  • Ad countdown text font.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) int *adCountdownFont;

    Swift

    var adCountdownFont: UnsafeMutablePointer<Int32>! { get set }

  • Ad countdown text text color.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) int *adCountdownTextColor;

    Swift

    var adCountdownTextColor: UnsafeMutablePointer<Int32>! { get set }

  • Ad countdown text stroke color.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) int *adCountdownStrokeColor;

    Swift

    var adCountdownStrokeColor: UnsafeMutablePointer<Int32>! { get set }

  • Ad countdown text stroke width.

    Note that the countdown text is in two layers: stroke and foreground text. The stroke width should be doubled as inner half of the stroke is covered by the foreground text.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) CGFloat adCountdownStrokeWidth;

    Swift

    var adCountdownStrokeWidth: CGFloat { get set }

  • Add a ad break to the container.

    It will organize the ad break when inserting.

    Declaration

    Objective-C

    - (void)addAdBreak:(ATVAd *)adBreak;

    Swift

    func addAdBreak(_ adBreak: ATVAd!)

    Parameters

    adBreak

    ad break to be added

  • Copy object.

    Declaration

    Objective-C

    - (id)copyWithZone:(NSZone *)zone;

    Swift

    func copy(with zone: NSZone!) -> Any!

    Parameters

    zone

    This parameter is ignored. Memory zones are no longer used by Objective-C.

    Return Value

    a new instance that’s a copy of the receiver