Package com.pubmatic.sdk.video.vastmodels

Class POBNonLinear

  • All Implemented Interfaces:
    com.pubmatic.sdk.video.xmlserialiser.POBXMLNodeListener 
    
public class POBNonLinear
extends POBVastCreative

    Instance of this modal class saves the data of Non-Linear video ads. NonLinear ads are the overlay ads that display as an image or rich media on top of video content during playback.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description
      POBNonLinear()

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      void build(@NonNull() POBNodeBuilder builder) POBXMLParser calls this method to build model class object with node builder
      int getWidth() Returns the width of placement slot
      int getHeight() Returns the height of placement slot
      int getExpandedWidth() The maximum pixel width of the creative in its expanded state
      int getExpandedHeight() The maximum pixel height of the creative in its expanded state
      String getMinSuggestedDuration() The minimum suggested duration that the creative should be displayed.
      boolean getScalable() A Boolean value that indicates whether the media file is meant to scale to larger dimensions.
      boolean getMaintainAspectRatio() A Boolean value that indicates whether aspect ratio for media file dimensions should be maintained when scaled to new dimensions.
      List<POBResource> getResource() List of resources to be displayed
      String getClickThroughURL() A URI to open when companion ad is clicked.
      List<String> getClickTrackers() A URI to notify the player that ad was clicked.
      List<POBTracking> getTrackingEvents() List of event tracker URL's
      POBVastCreative.CreativeType getVastCreativeType() Getter method, provides type of creative which is implemented at child classes specific event type classes
      String getUniversalAdId() A unique creative identifier

      • Methods inherited from class com.pubmatic.sdk.video.vastmodels.POBVastCreative

        getCreativeExtensions, getPubMaticExtension, getTrackingEventUrls, getTrackingEvents, setCreativeExtensions

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • POBNonLinear

        POBNonLinear()

    • Method Detail

      • build

         void build(@NonNull() POBNodeBuilder builder)

        POBXMLParser calls this method to build model class object with node builder

        Parameters:
        builder - Instance of POBNodeBuilder, to be used for building the model class object

      • getWidth

         int getWidth()

        Returns the width of placement slot

        Returns:

        width of ad

      • getHeight

         int getHeight()

        Returns the height of placement slot

        Returns:

        height of ad

      • getExpandedWidth

         int getExpandedWidth()

        The maximum pixel width of the creative in its expanded state

        Returns:

        maximum width of ad

      • getExpandedHeight

         int getExpandedHeight()

        The maximum pixel height of the creative in its expanded state

        Returns:

        maximum height of ad

      • getMinSuggestedDuration

        @Nullable() String getMinSuggestedDuration()

        The minimum suggested duration that the creative should be displayed. The duration is in the format HH:MM:SS.mmm (mmm is optional)

        Returns:

        MinSuggestedDuration boolean value

      • getScalable

         boolean getScalable()

        A Boolean value that indicates whether the media file is meant to scale to larger dimensions.

        Returns:

        scalable boolean value

      • getMaintainAspectRatio

         boolean getMaintainAspectRatio()

        A Boolean value that indicates whether aspect ratio for media file dimensions should be maintained when scaled to new dimensions.

        Returns:

        maintainAspectRatio boolean value