VideoControlsConfiguration

@objc(PBMVideoControlsConfiguration)
@objcMembers
public class VideoControlsConfiguration : NSObject

A class representing the configuration for video controls in an ad. This includes properties for video duration, mute status, and button positioning and visibility. Configuration values can be initialized from bid response or set directly by the user.

  • This property indicates maximum video duration. Obtained from the field ext,prebid.passthrough[].adConfiguration.maxvideoduration.

    Declaration

    Swift

    private(set) public var maxVideoDuration: NSNumber? { get }

  • This property indicates whether the ad should run playback with sound or not. Obtained from the field ext,prebid.passthrough[].adConfiguration.ismuted or set by user.

    Declaration

    Swift

    public var isMuted: Bool

  • This property indicates the area which the close button should occupy on the screen. Obtained from the field ext,prebid.passthrough[].adConfiguration.closebuttonarea or set by user.

    Declaration

    Swift

    public var closeButtonArea: Double { get set }

  • This property indicates the position of the close button on the screen. Obtained from the field ext,prebid.passthrough[].adConfiguration.closebuttonposition or set by user.

    Declaration

    Swift

    public var closeButtonPosition: Position { get set }

  • This property indicates the area which the skip button should occupy on the screen. Obtained from the field ext,prebid.passthrough[].adConfiguration.skipbuttonarea or set by user.

    Declaration

    Swift

    public var skipButtonArea: Double { get set }

  • This property indicates the position of the skip button on the screen. Obtained from the field ext,prebid.passthrough[].adConfiguration.skipbuttonposition or set by user.

    Declaration

    Swift

    public var skipButtonPosition: Position { get set }

  • This property indicates the number of seconds which should be passed from the start of playback until the skip or close button should be shown. Obtained from the field ext,prebid.passthrough[].adConfiguration.skipdelay or set by user.

    Declaration

    Swift

    public var skipDelay: Double

  • This property indicates whether mute controls is visible on the screen.

    Declaration

    Swift

    public var isSoundButtonVisible: Bool

  • Indicates whether a non-rewarded full-screen video without a companion ad closes automatically when playback completes.

    The default value is true, preserving the SDK’s existing auto-close behavior. Set this property to false to keep the interstitial open and display a Watch Again button until the user closes the ad. Rewarded ads use the rwdd.close.action configuration instead. Obtained from ext.prebid.passthrough[].adConfiguration.isautocloseoncompletionenabled or set by the user.

    Declaration

    Swift

    public var isAutoCloseOnCompletionEnabled: Bool

  • Use to initialize video controls with server values.

    Declaration

    Swift

    public func initialize(with ortbAdConfiguration: ORTBAdConfiguration?)