-
- All Implemented Interfaces:
-
com.theoplayer.android.api.event.EventDispatcher
public interface VerizonMediaAd implements EventDispatcher<VerizonMediaAdEvent>
The Verizon Media ad API.
-
-
Method Summary
Modifier and Type Method Description abstract double
getStartTime()
The start time of the ad, in seconds. abstract double
getEndTime()
The end time of the ad, in seconds. abstract double
getDuration()
The duration of the ad, in seconds. abstract String
getApiFramework()
The API framework, if any. abstract String
getCreative()
The identifier of the creative. abstract String
getMimeType()
The creative's mime type. abstract double
getWidth()
The width of the ad. abstract double
getHeight()
The height of the ad. abstract HashMap<String, List<String>>
getEvents()
A HashMap of all VAST 3.0 tracking events for this ad. abstract List<VerizonMediaAd>
getCompanions()
List of all companion ads of the ad. abstract List<Object>
getExtensions()
List of VAST extensions returned by the ad server. abstract HashMap<String, String>
getFreeWheelParameters()
A HashMap of FreeWheel-defined creative parameters. -
-
Method Detail
-
getStartTime
abstract double getStartTime()
The start time of the ad, in seconds.
-
getEndTime
abstract double getEndTime()
The end time of the ad, in seconds.
-
getDuration
abstract double getDuration()
The duration of the ad, in seconds.
-
getApiFramework
@Nullable() abstract String getApiFramework()
The API framework, if any.
- If the value is 'VPAID', then the ad is a VPAID ad.
- Otherwise the ad is an Uplynk CMS asset.
-
getCreative
@NonNull() abstract String getCreative()
The identifier of the creative.
- Either a VPAID URL, if the API framework is 'VPAID'.
- Otherwise an asset ID from the Uplynk CMS.
-
getMimeType
@NonNull() abstract String getMimeType()
The creative's mime type.
- Either 'application/javascript' if the API framework is 'VPAID'.
- Otherwise 'uplynk/m3u8'.
-
getWidth
abstract double getWidth()
The width of the ad.
- Returns zero if the ad is not a companion-ad.
-
getHeight
abstract double getHeight()
The height of the ad.
- Returns zero if the ad is not a companion-ad.
-
getEvents
@NonNull() abstract HashMap<String, List<String>> getEvents()
A HashMap of all VAST 3.0 tracking events for this ad. Each entry contains all related tracking URLs.
-
getCompanions
@NonNull() abstract List<VerizonMediaAd> getCompanions()
List of all companion ads of the ad.
-
getExtensions
@NonNull() abstract List<Object> getExtensions()
List of VAST extensions returned by the ad server.
-
getFreeWheelParameters
@NonNull() abstract HashMap<String, String> getFreeWheelParameters()
A HashMap of FreeWheel-defined creative parameters. Each entry contains the parameter name together with the associated value.
-
-
-
-