Package com.longtailvideo.jwplayer.media.ads

Class AdCompanion

  • public class AdCompanion
extends java.lang.Object
    An Ad Companion.

    • Constructor Summary

      Constructors 
      Constructor Description
      AdCompanion​(java.lang.String click, int height, int width, java.lang.String resource, AdCompanionType type, java.util.List<java.lang.String> creativeViews)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getClick()
      URL to link to when clicking the companion.
      java.util.List<java.lang.String> getCreativeViews()
      A List of included creativeview event tracking pixels
      int getHeight()
      The height of the companion in pixels.
      java.lang.String getResource()
      The URL to the static/iframe resource, or the raw HTML content.
      AdCompanionType getType()
      The type of the creative: static, iframe, or HTML.
      int getWidth()
      The width of the companion in pixels.
      static AdCompanion parseJson​(org.json.JSONObject json)
      Construct AdCompanion object.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AdCompanion

        public AdCompanion​(java.lang.String click,
                   int height,
                   int width,
                   java.lang.String resource,
                   AdCompanionType type,
                   java.util.List<java.lang.String> creativeViews)

    • Method Detail

      • getClick

        public java.lang.String getClick()
        URL to link to when clicking the companion. Only available if the type is static.
        Returns:
        link URL.

      • getHeight

        public int getHeight()
        The height of the companion in pixels.
        Returns:
        height.

      • getWidth

        public int getWidth()
        The width of the companion in pixels.
        Returns:
        width.

      • getResource

        public java.lang.String getResource()
        The URL to the static/iframe resource, or the raw HTML content.
        Returns:
        static webpage or iframe URL.

      • getType

        public AdCompanionType getType()
        The type of the creative: static, iframe, or HTML.
        Returns:
        'static', 'iframe', or 'HTML'.

      • getCreativeViews

        public java.util.List<java.lang.String> getCreativeViews()
        A List of included creativeview event tracking pixels

      • parseJson

        public static AdCompanion parseJson​(org.json.JSONObject json)
        Construct AdCompanion object.
        Parameters:
        json - from onAdCompanions event.
        Returns:
        parsed json object.