Adaptive Media Player

AmpNielsen Docs

AmpNielsenManager

open class AmpNielsenManager : NSObject, NielsenAppApiDelegate
extension AmpNielsenManager:PlayerEventObserver

Class in charge of manage the Nielsen DCR integration.

  • The native player.

    Declaration

    Swift

    public let ampPlayer: AmpPlayer?
  • This property contains the plugin version.

    Declaration

    Swift

    @objc
    public var version: String { get }
  • Creates a new instance of the AmpNielsenManager.

    Declaration

    Swift

    public init?(player: AmpPlayer, appInfo: String)

    Parameters

    player

    Instance of the player that is going to be linked to Nielsen.

    appInfo

    String with the Nielsen init info: appid, appversion, appname, sfcode on JSON Format.

  • Creates a new instance of the AmpNielsenManager.

    Declaration

    Swift

    public init(appInfo: [String : AnyObject])

    Parameters

    appInfo

    Dictionary with the Nielsen init info: appid, appversion, appname, sfcode.

  • Creates a new instance of the AmpNielsenManager.

    Declaration

    Swift

    public init(player: AmpPlayer, appInfo: [String : AnyObject])

    Parameters

    player

    Instance of the player that is going to be linked to Nielsen.

    appInfo

    Dictionary with the Nielsen init info: appid, appversion, appname, sfcode.

  • Set debug mode on or off.

    Declaration

    Swift

    open func enableDebugMode(value: Bool)

    Parameters

    value

    The Bool value

  • Get the URL of the web page that is used for giving user a chance to opt out from the Nielsen measurements.

    Declaration

    Swift

    open func getOptOutURL() -> String?

    Return Value

    opt out URL.

  • Set the URL of the web page that is used for giving user a chance to opt out from the Nielsen measurements.

    Declaration

    Swift

    open func userOptOut(_ optOut: String) -> Bool

    Parameters

    optOut

    The opt out URL.

  • Registers an observer to be notified of plugin events.

    Declaration

    Swift

    open func registerObserver(_ observer: AmpNielsenObserver) -> Int

    Parameters

    observer

    The observer to be registered.

    Return Value

    The id of the registered observer.

  • Set the channel info.

    Declaration

    Swift

    open func set(channelInfo: String)

    Parameters

    channelInfo

    a JSON formatted object that includes metadata of the channel.

  • Set the content metadata.

    Declaration

    Swift

    open func set(metaData: String)

    Parameters

    metaData

    a JSON formatted object that includes video’s metadata. Refer to Configure Metadata

  • Set a DAR tag.

    For more information click here

    Declaration

    Swift

    open func set(nielsenDARTag: String)

    Parameters

    nielsenDARTag

    The DAR tag.

  • Stop Nielsen measurenment and remove references.

    Declaration

    Swift

    open func unload()