ImaSettings

@objc(BMPImaSettings)
@objcMembers
public class ImaSettings : NSObject, NSCopying, @unchecked Sendable

The ImaSettings class stores SDK wide settings.

  • Publisher Provided Identification (PPID) sent with ads request.

    Declaration

    Swift

    public var ppid: String?

  • Language specification used for localization. Language must be formatted as a canonicalized IETF BCP 47 language identifier such as would be returned by Locale.preferredLanguages. Setting this property after it has been sent to the IMAAdsLoader will be ignored and a warning will be logged.

    Declaration

    Swift

    public var language: String

  • Specifies maximum number of redirects after which subsequent redirects will be denied, and the ad load aborted. The number of redirects directly affects latency and thus user experience. This applies to all VAST wrapper ads. If the number of redirects exceeds |maxRedirects|, the ad request will fail with error code 302. The default value is 4.

    Declaration

    Swift

    public var maxRedirects: UInt

  • Enable background audio playback for the SDK. The default value is false.

    Declaration

    Swift

    public var enableBackgroundPlayback: Bool

  • Specifies whether to update the MPNowPlayingInfoCenter content with the title “Advertisement”. If disabled, MPNowPlayingInfoCenter is untouched. The default value is false.

    Note

    When NowPlayingConfig.isNowPlayingInfoEnabled is true, this flag is automatically treated as true.

    Declaration

    Swift

    @available(*, deprecated, message: "To enable the Now Playing information use `NowPlayingConfig.isNowPlayingInfoEnabled`")
public var disableNowPlayingInfo: Bool

  • The partner specified player version that is integrating with the SDK.

    Declaration

    Swift

    public var playerVersion: String?

  • The session ID to identify a single user session. This should be a UUID. It is used exclusively for frequency capping across the user session.

    Declaration

    Swift

    public var sessionId: String?

  • Controls whether Same App Key is enabled. The value set persists across app sessions. The key is enabled by default. This property is not available on tvOS.

    Declaration

    Swift

    @available(tvOS, unavailable)
public var sameAppKeyEnabled: Bool { get set }