Adaptive Media Player

AmpMediaAnalytics Docs

AmpMediaAnalyticsManager

public class AmpMediaAnalyticsManager: NSObject, PlayerEventObserver

Class in charge of managing the integration between the AMP SDK and the Media Analytics SDK

  • The AmpPlayer associated with an AmpMediaAnalyticsManager

    Declaration

    Swift

    public weak var ampPlayer: AmpPlayer?
  • The url used for retrieving the Media Analytics configuration

    Declaration

    Swift

    public let configUrl: String?
  • Constructor

    Declaration

    Swift

    public init(ampPlayer: AmpPlayer, configurationUrl: String, dimensions: [String:String] = [:], viewerId: String = "AMP IOS")

    Parameters

    ampPlayer

    The AmpPlayer associated with an AmpMediaAnalyticsManager.

    configurationUrl

    The url used for retrieving the Media Analytics configuration.

    dimensions

    The custom dimensions that should be sent to Media Analytics. Default: Empty dictionary.

    Return Value

    A configured instance of an AmpMediaAnalyticsManager.

  • Constructor

    Declaration

    Swift

    public init?(ampPlayer: AmpPlayer)

    Parameters

    ampPlayer

    The AmpPlayer associated with an AmpMediaAnalyticsManager.

  • Add a custom dimension.

    Declaration

    Swift

    public func addDimension(key: String, value: String)

    Parameters

    key

    The dimension’s name.

    value

    The dimension’s value.

  • Enable Media Analytics logs.

    Declaration

    Swift

    public func enableLogging()
  • Disable Media Analytics logs.

    Declaration

    Swift

    public func disableLogging()
  • An API to complete the current visit

    Declaration

    Swift

    public func handleVisit()
  • Enables server ip tracking.

    Declaration

    Swift

    public func enableServerIpLookup()
  • Disables server ip tracking.

    Declaration

    Swift

    public func disableServerIpLookup()
  • Enable location tracking which by default turned on

    Declaration

    Swift

    public func enableLocationSupport()
  • Disable location tracking

    Declaration

    Swift

    public func disableLocationSupport()
  • Stop the module entirely.

    Declaration

    Swift

    public func stop()