Package com.brightcove.ssai.event

Class SSAIEventType

java.lang.Object
com.brightcove.ssai.event.SSAIEventType
public final class SSAIEventType extends Object
Identifies SSAI event types used and emitted within the SSAI plugin. Also provides parameter keys for use in event handlers.

  • Field Details

    • AD_DATA_READY

      public static final String AD_DATA_READY
      Indicate that the ad data response is ready either to support the OnceUX functions or to provide an error indication on why not. Properties included are either error information (VMAP_ERRORS, a String) or data (VMAP_RESPONSE, bound to a VMAP object, and VMAP_TIMELINE, bound to a SparseArray<List<Event>> object associating playhead positions with the event list.)
      See Also:

    • START_AD

      public static final String START_AD
      Indicate that a VAST <Ad> is starting. Properties includes the Ad data binding (VAST_AD is the key).
      See Also:

    • END_AD

      public static final String END_AD
      Indicate that a VMAP <Ad> is ending. Properties includes the Ad data binding (VAST_AD is the key).
      See Also:

    • START_AD_BREAK

      public static final String START_AD_BREAK
      Indicate that a VMAP <AdBreak> is starting. Properties includes the AdBreak data binding (VMAP_AD_BREAK).
      See Also:

    • END_AD_BREAK

      public static final String END_AD_BREAK
      Indicate that a VMAP <AdBreak> is ending.
      See Also:

    • START_COMPANION

      public static final String START_COMPANION
      Indicate that a VMAP <Companion> is at available to be displayed. Properties includes the Companion data binding (VMAP_COMPANION is the key).
      See Also:

    • RENDERED_COMPANION

      public static final String RENDERED_COMPANION
      Indicate that a companion add has been successfully shown
      See Also:

    • END_COMPANION

      public static final String END_COMPANION
      Indicate that a VMAP <Companion> is finished. Properties includes the Companion data binding (VMAP_COMPANION is the key).
      See Also:

    • START_LINEAR

      public static final String START_LINEAR
      Indicate that a VMAP <Linear> is starting. Properties includes the Linear data binding (VAST_LINEAR).
      See Also:

    • END_LINEAR

      public static final String END_LINEAR
      Indicate that a VMAP <AdBreak> is ending. Properties includes the Linear data binding (VAST_LINEAR).
      See Also:

    • SEND_IMPRESSION

      public static final String SEND_IMPRESSION
      Indicate that an impression tracking beacon has been sent. Properties includes the Impression data binding (IMPRESSION).
      See Also:

    • SEND_TRACKING_BEACON

      public static final String SEND_TRACKING_BEACON
      Indicate that a tracking beacon has been sent. Properties includes the Tracking beacon (VMAP_TRACKING).
      See Also:

    • CLICK_LINEAR_CREATIVE

      public static final String CLICK_LINEAR_CREATIVE
      Indicates the action that the linear creative has been clicked by the user.
      See Also:

    • SKIP_AD

      public static final String SKIP_AD
      Indicate the action to Skip an Ad triggered by the user.
      See Also:

  • Constructor Details

    • SSAIEventType

      public SSAIEventType()