Package com.ooyala.pulse

Interface PulseCompanionAd

  • public interface PulseCompanionAd
    This interface is used to handle companion banners, and notify the PulseSession about events regarding the companion banner.

    As a minimum, the session object must be notified that the companion banner was displayed: adDisplayed().

    Depending on your application, you may also need the clickthrough URL (getClickThroughURL()) to respond to viewers tapping a companion banner.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void adDisplayed()
      Notify the session that the companion has been displayed
      java.net.URL getClickThroughURL()
      Returns a URL for a web page that should be displayed to the user when they tap the companion ad.
      java.lang.String getCustomIdentifier()
      The custom companion ad id set in the Ooyala Pulse UI.
      int getHeight()
      The companion's height.
      java.lang.String getIdentifier()
      The companion ad id assigned by Ooyala Pulse.
      java.lang.String getResourceType()
      Returns the MIME type of the resource for this companion ad.
      java.net.URL getResourceURL()
      Returns the URL where the companion's resource is located.
      int getWidth()
      The companion's width.
      java.lang.String getZoneIdentifier()
      Returns the zone identifier assigned to this companion ad.

    • Method Detail

      • adDisplayed

        void adDisplayed()
        Notify the session that the companion has been displayed

      • getResourceURL

        java.net.URL getResourceURL()
        Returns the URL where the companion's resource is located.
        Returns:
        the resource URL for this companion.

      • getResourceType

        java.lang.String getResourceType()
        Returns the MIME type of the resource for this companion ad.
        Returns:
        The resource type.

      • getZoneIdentifier

        java.lang.String getZoneIdentifier()
        Returns the zone identifier assigned to this companion ad.
        Returns:
        The zone identifier.

      • getClickThroughURL

        java.net.URL getClickThroughURL()
        Returns a URL for a web page that should be displayed to the user when they tap the companion ad.
        Returns:
        the URL to be displayed.

      • getIdentifier

        java.lang.String getIdentifier()
        The companion ad id assigned by Ooyala Pulse.
        Returns:
        the companion id.

      • getCustomIdentifier

        java.lang.String getCustomIdentifier()
        The custom companion ad id set in the Ooyala Pulse UI.
        Returns:
        the custom companion id.

      • getWidth

        int getWidth()
        The companion's width.
        Returns:
        the width of companion.

      • getHeight

        int getHeight()
        The companion's height.
        Returns:
        the height of companion.