Core SDK API Documentation

Class: MediaFile

MediaFile

new MediaFile()

Represents a resource file used to display a linear creative.

Members

<static> ApiFramework :string

Indicates the API framework required to display a given MediaFile.

Type:
  • string
Properties:
Name Type Default Description
VPAID string VPAID

<static> DeliveryMethod :string

Indicates the delivery method of a given media file.

Type:
  • string
Properties:
Name Type Default Description
PROGRESSIVE string progressive
STREAMING string streaming

adParameters :string

Ad parameters should, when they exist, be sent to the (executable) asset, but they are only sent if the API framework property identifies a
framework that is recognized as one that receives ad parameters.
The most common case is when the MediaFile represents a VPAID (API framework is set to videoplaza.adresponse.MediaFile.ApiFramework.VPAID).

Type:
  • string

apiFramework :videoplaza.adresponse.MediaFile.ApiFramework

String value indicating the the API needed to execute the file.

Type:

bitRate :number

The bitrate of the media file.

Type:
  • number

deliveryMethod :videoplaza.adresponse.MediaFile.DeliveryMethod

Delivery method of the asset.

Type:

height :number

Height of the asset in pixels.

Type:
  • number

mimeType :string

Asset mime type.

Type:
  • string

url :string

URL to mediaFile.

Type:
  • string

width :number

Width of the asset in pixels.

Type:
  • number