APSVASTBannerConfiguration

Objective-C

@interface APSVASTBannerConfiguration : NSObject <NSCopying>

Swift

class APSVASTBannerConfiguration : NSObject, NSCopying

Holds all configuration parameters for the banner ads displayed.

  • The maximum allowed size for a non-linear ad. Non-linear ads that define sizes larger than this will be truncated.

    Defaults to CGSizeMake(320, 50).

    Declaration

    Objective-C

    @property (nonatomic) CGSize maxSize;

    Swift

    var maxSize: CGSize { get set }

  • Defines if non-linear ads should be stretched to the defined bannerMaxSize, should they declare a size smaller than that.

    Defaults to NO;

    Declaration

    Objective-C

    @property (nonatomic) BOOL stretchToMaxSize;

    Swift

    var stretchToMaxSize: Bool { get set }

  • Defines how a non-linear banner overlay should be placed relative to the player surface.

    See APSMediaOverlayPosition for possible values. Defaults to kAPSMediaOverlayPositionBottom.

    Declaration

    Objective-C

    @property (nonatomic) APSMediaOverlayPosition position;

    Swift

    var position: APSMediaOverlayPosition { get set }

  • Defines the fade-in animation duration for non-linear ads.

    Defaults to 0.5.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat fadeInDuration;

    Swift

    var fadeInDuration: CGFloat { get set }

  • Defines the default number of seconds that a non-linear ad will be kept on display. This can be overridden by VAST ad configuration.

    Defaults to 10.

    Declaration

    Objective-C

    @property (nonatomic) int defaultAdBreakDuration;

    Swift

    var defaultAdBreakDuration: Int32 { get set }

  • Defines the default number of seconds after which the non-linear ad close button becomes active.

    Defaults to 3.

    Declaration

    Objective-C

    @property (nonatomic) int skipOffset;

    Swift

    var skipOffset: Int32 { get set }

  • Indicates whether a close button should be displayed on top of non-linear ads.

    Defaults to YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL showCloseButton;

    Swift

    var showCloseButton: Bool { get set }

  • Defines the image that should be displayed in the non-linear ads close button, instead of the default progress wheel.

    Declaration

    Objective-C

    @property (nonatomic) UIImage *_Nullable closeButtonImage;

    Swift

    var closeButtonImage: UIImage? { get set }

  • Defines the background color for the close button displayed on top of non-linear ads.

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

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nullable closeButtonBackgroundColor;

    Swift

    var closeButtonBackgroundColor: String? { get set }

  • Defines the color for the X symbol in the center of the close button.

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

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nullable closeButtonXColor;

    Swift

    var closeButtonXColor: String? { get set }

  • Indicates the lenght of a side of the non-linear ads close button square.

    Defaults to 20.

    Declaration

    Objective-C

    @property (nonatomic) int closeButtonSize;

    Swift

    var closeButtonSize: Int32 { get set }

  • Indicates the opacity of the non-linear ads close button before it is activated for receiving taps.

    Defaults to 0.5.

    Declaration

    Objective-C

    @property (nonatomic) float closeButtonInitialAlpha;

    Swift

    var closeButtonInitialAlpha: Float { get set }

  • Indicates the opacity of the non-linear close button after it has been activated for receiving taps.

    Defaults to 0.7.

    Declaration

    Objective-C

    @property (nonatomic) float closeButtonFinalAlpha;

    Swift

    var closeButtonFinalAlpha: Float { get set }

  • The color of the circular bar that indicates the currently elapsed time until the close button can be tapped.

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

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nullable closeButtonProgressColor;

    Swift

    var closeButtonProgressColor: String? { get set }

  • The color of the circular bar that indicates the total time until the close button can be tapped.

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

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nullable closeButtonTrackColor;

    Swift

    var closeButtonTrackColor: String? { get set }

  • Defines the offset that the non-linear ads close button should have from the top-right edge of the banner itself.

    Declaration

    Objective-C

    @property (nonatomic) CGPoint closeButtonOffset;

    Swift

    var closeButtonOffset: CGPoint { get set }