Package com.akamai.amp.analytics.comscorestreamsense

Interface AmpComscoreStreamsenseAnalyticsTracker

All Known Implementing Classes:
StreamsenseEventsHandler
public interface AmpComscoreStreamsenseAnalyticsTracker
Analytics Tracker for Comscore Streamsense Analytics.

Automatically sends beacons to the comscore streamsense backend, reacting to the player's events (like start playback, stop playback, start buffering, stop buffering and many others)

  • Method Summary

    Modifier and Type Method Description
    void expectPreroll()
    This method is used to notify the tracker the current playback currently playing contains pre rolls.
    UserConsent getUserConsent()
    This method returns the current User consent selection.
    void notifyHiddenEvent()
    This method fires a hidden event defined by Comscore.
    void notifyHiddenEvent​(java.util.Map<java.lang.String,​java.lang.String> params)
    This method fires hidden events defined by Comscore.
    void notifyLabelChange​(java.lang.String key, java.lang.String value)
    This method is used to manually notify a label change.
    void notifyViewEvent()
    This method fires a view event defined by Comscore.
    void notifyViewEvent​(java.util.Map<java.lang.String,​java.lang.String> params)
    This method fires view events defined by Comscore.
    void setContentMetadata​(ContentMetadata contentMetadata)
    This method is used to set the content Metadata for the session.
    void setUserConsent​(UserConsent userConsent)
    This method is used to override the current User consent selection.

  • Method Details

    • notifyHiddenEvent

      void notifyHiddenEvent()
      This method fires a hidden event defined by Comscore.

      (Using this method can cause duplicate reactions: its usage is already handled correctly by the tracker, however, there could be corner cases where it is required to manually call it, caused by corner cases or by a specific request from a customer).

    • notifyHiddenEvent

      void notifyHiddenEvent​(java.util.Map<java.lang.String,​java.lang.String> params)
      This method fires hidden events defined by Comscore.

      (Using this method can cause duplicate reactions: its usage is already handled correctly by the tracker, however, there could be corner cases where it is required to manually call it, caused by corner cases or by a specific request from a customer).

    • notifyViewEvent

      void notifyViewEvent()
      This method fires a view event defined by Comscore.

      (Using this method can cause duplicate reactions: its usage is already handled correctly by the tracker, however, there could be corner cases where it is required to manually call it, caused by corner cases or by a specific request from a customer).

    • notifyViewEvent

      void notifyViewEvent​(java.util.Map<java.lang.String,​java.lang.String> params)
      This method fires view events defined by Comscore.

      (Using this method can cause duplicate reactions: its usage is already handled correctly by the tracker, however, there could be corner cases where it is required to manually call it, caused by corner cases or by a specific request from a customer).

    • getUserConsent

      UserConsent getUserConsent()
      This method returns the current User consent selection.
      Returns:
      an instance of the UserConsent selected.

    • setUserConsent

      void setUserConsent​(UserConsent userConsent)
      This method is used to override the current User consent selection.
      Parameters:
      userConsent - an instance of the UserConsent selected.

    • notifyLabelChange

      void notifyLabelChange​(java.lang.String key, java.lang.String value)
      This method is used to manually notify a label change.
      Parameters:
      key - key of the label.
      value - value of the label.

    • setContentMetadata

      void setContentMetadata​(ContentMetadata contentMetadata)
      This method is used to set the content Metadata for the session.
      Parameters:
      contentMetadata - instance of the ContentMetadata created.

    • expectPreroll

      void expectPreroll()
      This method is used to notify the tracker the current playback currently playing contains pre rolls.