OMIDVASTProperties

Objective-C

@interface OMIDVASTProperties : NSObject

Swift

class OMIDVASTProperties : NSObject

This object is used to capture key VAST properties so this can be shared with all registered verification providers.

  • Declaration

    Objective-C

    @property(nonatomic, readonly, getter = isSkippable) BOOL skippable

    Swift

    var isSkippable: Bool { get }

  • Declaration

    Objective-C

    @property(nonatomic, readonly) CGFloat skipOffset

    Swift

    var skipOffset: CGFloat { get }

  • Declaration

    Objective-C

    @property(nonatomic, readonly, getter = isAutoPlay) BOOL autoPlay

    Swift

    var isAutoPlay: Bool { get }

  • Declaration

    Objective-C

    @property(nonatomic, readonly) OMIDPosition position

    Swift

    var position: OMIDPosition { get }

  • This method enables the media player to create a new VAST properties instance for skippable media ad placement.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSkipOffset:(CGFloat)skipOffset
                                  autoPlay:(BOOL)autoPlay
                                  position:(OMIDPosition)position;

    Swift

    init(skipOffset: CGFloat, autoPlay: Bool, position: OMIDPosition)

    Parameters

    skipOffset

    The number of seconds before the skip button is presented.
    autoPlay

    Determines whether the media will auto-play content.
    position

    The position of the media in relation to other content.

    Return Value

    A new instance of VAST properties.

  • This method enables the media player to create a new VAST properties instance for non-skippable media ad placement.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithAutoPlay:(BOOL)autoPlay
                                position:(OMIDPosition)position;

    Swift

    init(autoPlay: Bool, position: OMIDPosition)

    Parameters

    autoPlay

    Determines whether the media will auto-play content.
    position

    The position of the media in relation to other content.

    Return Value

    A new instance of VAST properties.

  • Unavailable

    Declaration

    Objective-C

    - (null_unspecified instancetype)init NS_UNAVAILABLE;

  • For OM SDK internal use only.

    Declaration

    Objective-C

    - (NSDictionary *_Nonnull)toJSON;

    Swift

    func toJSON() -> [AnyHashable : Any]