com.appscend.media

Class APSMediaBuilder

java.lang.Object

com.appscend.media.APSMediaBuilder

public class APSMediaBuilder
extends java.lang.Object

The APSMediaBuilder assists in creating playlists of fully configurable APSMediaUnits, together with attached, configurable APSMediaOverlays, using JSON files or using a HashMap, both following the same structure.

The media builder also has class methods that assist with the generation of individual APSMediaUnit and APSMediaOverlay objects from corresponding JSON or HashMap structures.

Plugins can be attached to a media builder. Each plugin can dynamically insert, edit or remove units and/or overlays from the generated playlist.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	APSMediaBuilder.APSResolvMultipleAdsConflictsBy The VMAP standard permits allowing only one ad from a certain ad source.
static class	APSMediaBuilder.APSWebviewDismissedAction Defines the action that the player should take when resuming playback after an interruption caused by user interaction, that determined the display of the in-app web browser.
static class	APSMediaBuilder.getDataAsync Helper class that is used to get data from an URL asynchronous
static class	APSMediaBuilder.MPMovieControlStyle

Field Summary

Fields

Modifier and Type	Field and Description
java.util.ArrayList<APSVastAdBreak>	adBreaks
APSVastAdBreak	adBreakTemplate
java.util.ArrayList<APSMediaUnit>	bumperUnits Array containing APSMediaUnits that will be scheduled before ones in contentUnits in the generated playlist.
java.util.ArrayList<APSMediaUnit>	contentUnits Array containing the main content APSMediaUnits that will make up the playlist.
boolean	debugMode
java.util.ArrayList<java.lang.String>	defaultAdBreakPositions
java.util.ArrayList<APSMediaUnit>	exitUnits
static java.lang.String	kAPSMarlinDRMEncoding
static java.lang.String	kAPSMetadataDrmEncodingType
static java.lang.String	kAPSMetadataDrmUrl
java.lang.String	userAgent
java.lang.String	vastOffset
java.lang.String	vastType
java.lang.String	vastURL
java.lang.String	vmapURL

Constructor Summary

Constructors

Constructor and Description
APSMediaBuilder()

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<APSVastAdBreak>	adBreaksForVMAP()
boolean	configureFromData(java.lang.String data) Configures the builder from a String object.
boolean	configureFromDictionary(java.util.HashMap<java.lang.String,java.lang.Object> configuration) Configures the builder from a HashMap object.
boolean	configureFromURL(java.net.URL url) Configures the builder from a JSON structure.
static java.util.HashMap<java.lang.String,java.lang.Object>	controlsParametersFromDictionary(java.util.HashMap<java.lang.String,java.lang.Object> controls) Configures the builder from a HashMap object.
void	initWithMediaUnit(APSMediaUnit contentUnit, java.lang.String vmapURL)
void	initWithMediUnit(APSMediaUnit contentUnit, java.lang.String vmapURL) Deprecated. use initWithMediaUnit(com.appscend.media.events.APSMediaUnit, String) instead.
java.util.ArrayList<APSMediaEvent>	mediaUnits() Returns a generated playlist of APSMediaUnits, based on builder configuration and registered plugins.
java.util.ArrayList<APSMediaEvent>	mediaUnits(boolean preloadPrerolls)
static APSMediaOverlay	overlayFromDictionary(java.util.HashMap<java.lang.String,java.lang.Object> overlayConfigurations) Factory method to generate new instance of APSMediaOverlay via HashMap configuration.
java.lang.String	pointsForOffset(java.lang.String adOffset)
static APSMediaOverlay.APSMediaOverlayPosition	positionFromString(java.lang.String position) Configures overlay position from a string
void	setDesiredAdCategories(java.util.ArrayList<java.lang.String> desiredAdCategories)
static APSMediaUnit	unitFromDictionary(java.util.HashMap<java.lang.String,java.lang.Object> unitConfigurations) Configures a new APSMediaUnit from a HashMap object.

Methods inherited from class java.lang.Object

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

Field Detail

kAPSMetadataDrmEncodingType

public static final java.lang.String kAPSMetadataDrmEncodingType

See Also:

Constant Field Values

kAPSMetadataDrmUrl

public static final java.lang.String kAPSMetadataDrmUrl

See Also:

Constant Field Values

kAPSMarlinDRMEncoding

public static final java.lang.String kAPSMarlinDRMEncoding

See Also:

Constant Field Values

debugMode

public boolean debugMode

adBreakTemplate

public APSVastAdBreak adBreakTemplate

userAgent

public java.lang.String userAgent

vmapURL

public java.lang.String vmapURL

vastURL

public java.lang.String vastURL

vastType

public java.lang.String vastType

vastOffset

public java.lang.String vastOffset

adBreaks

public java.util.ArrayList<APSVastAdBreak> adBreaks

defaultAdBreakPositions

public java.util.ArrayList<java.lang.String> defaultAdBreakPositions

bumperUnits

public java.util.ArrayList<APSMediaUnit> bumperUnits

Array containing APSMediaUnits that will be scheduled before ones in contentUnits in the generated playlist.

exitUnits

public java.util.ArrayList<APSMediaUnit> exitUnits

contentUnits

public java.util.ArrayList<APSMediaUnit> contentUnits

Array containing the main content APSMediaUnits that will make up the playlist.

Constructor Detail

APSMediaBuilder

public APSMediaBuilder()

Method Detail

initWithMediUnit

@Deprecated
public void initWithMediUnit(APSMediaUnit contentUnit,
                                         java.lang.String vmapURL)

Deprecated. use initWithMediaUnit(com.appscend.media.events.APSMediaUnit, String) instead.

Initializes builder with a playlist of a single media unit.

Parameters:

contentUnit - object to be played.

vmapURL - the URL of a VMAP feed.

initWithMediaUnit

public void initWithMediaUnit(APSMediaUnit contentUnit,
                              java.lang.String vmapURL)

controlsParametersFromDictionary

public static java.util.HashMap<java.lang.String,java.lang.Object> controlsParametersFromDictionary(java.util.HashMap<java.lang.String,java.lang.Object> controls)

Configures the builder from a HashMap object.

Parameters:

controls - HashMap of controls configuration values

Returns:

HashMap with control parameters

positionFromString

public static APSMediaOverlay.APSMediaOverlayPosition positionFromString(java.lang.String position)

Configures overlay position from a string

Parameters:

position - A String that represents the position

Returns:

APSMediaOverlayPosition

unitFromDictionary

public static APSMediaUnit unitFromDictionary(java.util.HashMap<java.lang.String,java.lang.Object> unitConfigurations)

Configures a new APSMediaUnit from a HashMap object.

Parameters:

unitConfigurations - The configuration HashMap.

Returns:

a new APSMediaUnit object

overlayFromDictionary

public static APSMediaOverlay overlayFromDictionary(java.util.HashMap<java.lang.String,java.lang.Object> overlayConfigurations)

Factory method to generate new instance of APSMediaOverlay via HashMap configuration.

Parameters:

overlayConfigurations - Dictionary overlay configuration.

Returns:

An instance of APSMediaOverlay or null if error.

configureFromURL

public boolean configureFromURL(java.net.URL url)

Configures the builder from a JSON structure.
Warning: This method may execute blocking network I/O on the calling thread.

Parameters:

url - The URL of the JSON structure to load. This can be a remote file or a local file.

Returns:

true on succes

configureFromData

public boolean configureFromData(java.lang.String data)

Configures the builder from a String object.
Warning: UTF8 encoding is assumed.

Parameters:

data - Configuration data - UTF8 encoded.

Returns:

true on succes.

configureFromDictionary

public boolean configureFromDictionary(java.util.HashMap<java.lang.String,java.lang.Object> configuration)

Configures the builder from a HashMap object.

Parameters:

configuration - The configuration dictionary.

Returns:

true on succes.

mediaUnits

public java.util.ArrayList<APSMediaEvent> mediaUnits()

Returns a generated playlist of APSMediaUnits, based on builder configuration and registered plugins.

Warning: This method may execute blocking network I/O on the calling thread.

Returns:

An array of APSMediaUnits.

mediaUnits

public java.util.ArrayList<APSMediaEvent> mediaUnits(boolean preloadPrerolls)

adBreaksForVMAP

public java.util.ArrayList<APSVastAdBreak> adBreaksForVMAP()

pointsForOffset

public java.lang.String pointsForOffset(java.lang.String adOffset)

setDesiredAdCategories

public void setDesiredAdCategories(java.util.ArrayList<java.lang.String> desiredAdCategories)