APSVASTSkipButtonConfiguration

Objective-C

@interface APSVASTSkipButtonConfiguration : NSObject <NSCopying>

Swift

class APSVASTSkipButtonConfiguration : NSObject, NSCopying

Holds all configuration parameters for the skip button displayed on top of video ads

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

    See APSMediaOverlayPosition for possible values. Defaults to kAPSMediaOverlayPositionBottomRight.

    Declaration

    Objective-C

    @property (nonatomic) APSMediaOverlayPosition position;

    Swift

    var position: APSMediaOverlayPosition { get set }

  • The default interval of time that needs to pass before the skip overlay is activated for tapping.

    The default value is -1, which makes the skip button invisible.

    Declaration

    Objective-C

    @property (nonatomic) int defaultSkipOffset;

    Swift

    var defaultSkipOffset: Int32 { get set }

  • The text that should be displayed in the skip button.

    Defaults to “Skip”.

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nullable text;

    Swift

    var text: String? { get set }

  • The color of the text diplayed in the skip button.

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

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nullable textColor;

    Swift

    var textColor: String? { get set }

  • Defines where inside the skip overlay should the progress circle be rendered.

    See APSSkipOverlayProgressPosition for more details. Defaults to kAPSSkipOverlayProgressPositionRight.

    Declaration

    Objective-C

    @property (nonatomic) APSSkipOverlayProgressPosition progressPosition;

    Swift

    var progressPosition: APSSkipOverlayProgressPosition { get set }

  • Defines the color of the progress bar indicating the elapsed time since ad has started.

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

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nullable progressCircleColor;

    Swift

    var progressCircleColor: String? { get set }

  • Defines the color of the text in the middle of the progress circle, indicating the number of seconds left until skip activation.

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

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nullable progressCircleTextColor;

    Swift

    var progressCircleTextColor: String? { get set }

  • Defines the color of the progress bar indicating the total duration of the ad.

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

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nullable progressCircleTrackColor;

    Swift

    var progressCircleTrackColor: String? { get set }

  • The internal padding that the skip overlay should apply to its content.

    Defaults to 5.

    Declaration

    Objective-C

    @property (nonatomic) int padding;

    Swift

    var padding: Int32 { get set }

  • The color of the border for the skip overlay.

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

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nullable borderColor;

    Swift

    var borderColor: String? { get set }

  • The corner radius of the border for the skip overlay.

    Defaults to 5.

    Declaration

    Objective-C

    @property (nonatomic) int borderRadius;

    Swift

    var borderRadius: Int32 { get set }

  • The background color for the skip overlay.

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

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nullable backgroundColor;

    Swift

    var backgroundColor: String? { get set }

  • The width of the skip overlay.

    Defaults to @“75”.

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nonnull width;

    Swift

    var width: String { get set }

  • The height of the skip overlay.

    Defaults to @“30”.

    Declaration

    Objective-C

    @property (nonatomic) NSString *_Nonnull height;

    Swift

    var height: String { get set }