APSVASTCountdownConfiguration

Objective-C

@interface APSVASTCountdownConfiguration : NSObject <NSCopying>

Swift

class APSVASTCountdownConfiguration : NSObject, NSCopying

Holds all configuration parameters for the coundown overlay displayed on top of video ads.

  • Indicates whether the countdown until the next media starts should be displayed during video ads.

    Defaults to YES;

    Declaration

    Objective-C

    @property (nonatomic) BOOL show;

    Swift

    var show: Bool { get set }

  • The position of the countdown overlay, relative to the player surface.

    See APSMediaOverlayPosition for possible values. Defaults to kAPSMediaOverlayPositionBottomLeft.

    Declaration

    Objective-C

    @property (nonatomic) APSMediaOverlayPosition position;

    Swift

    var position: APSMediaOverlayPosition { get set }

  • The text to be displayed in the countdown overlay. Use the “remaining” placeholder for the number of seconds.

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nullable text;

    Swift

    var text: String? { get set }

  • The width of the countdown overlay.

    Defaults to @“64%”.

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nonnull width;

    Swift

    var width: String { get set }
    • The height of the countdown overlay.

    Defaults to @“30”.

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nonnull height;

    Swift

    var height: String { get set }

  • The font family to be used for the text in the countdown overlay.

    Defaults to @“Helvetica”.

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nullable font;

    Swift

    var font: String? { get set }

  • The size of the font to be used for the text in the countdown overlay.

    Defaults to 13.

    Declaration

    Objective-C

    @property (nonatomic) int size;

    Swift

    var size: Int32 { get set }

  • The color of the font to be used for the text in the countdown overlay.

    Set this to a NSString containing the hex color reprezentation. Defaults to [UIColor whiteColor].

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nullable color;

    Swift

    var color: String? { get set }