Interface MediaFile

  • All Implemented Interfaces:

    
    public interface MediaFile
    
                        

    The MediaFile API represents metadata of an media file with ad content.

    • This metadata is retrieved from the VAST file.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public final class MediaFile.Builder

      The builder for MediaFile.

    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract String getDelivery() The delivery type.
      abstract String getResourceURI() The URI of the VAST content.
      abstract String getType() The MIME type for the file container.
      abstract Integer getHeight() The native height of the video file, in pixels.
      abstract Integer getWidth() The native width of the video file, in pixels.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • getDelivery

         abstract String getDelivery()

        The delivery type.

        • Currently we only support progressive.

        • It should be either 'progressive' or 'streaming'.

        Default: Empty string.

        Returns:

        The delivery type. (NonNull)

      • getResourceURI

         abstract String getResourceURI()

        The URI of the VAST content.

        Default: Empty string.

        Returns:

        The URI of the VAST content. (NonNull)

      • getType

         abstract String getType()

        The MIME type for the file container.

        Default: Empty string.

        Returns:

        The MIME type. (NonNull)

      • getHeight

         abstract Integer getHeight()

        The native height of the video file, in pixels.

        Returns:

        The video file native height, in pixels.

      • getWidth

         abstract Integer getWidth()

        The native width of the video file, in pixels.

        Returns:

        The video file native width, in pixels.