Package com.longtailvideo.jwplayer.media.ads.dai

Class ImaDaiSettings

java.lang.Object

com.longtailvideo.jwplayer.media.ads.dai.ImaDaiSettings

All Implemented Interfaces:

com.longtailvideo.jwplayer.utils.Jsonable

public class ImaDaiSettings
extends java.lang.Object
implements com.longtailvideo.jwplayer.utils.Jsonable

IMA DAI settings for a stream

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImaDaiSettings.StreamType	The type of DAI stream

Constructor Summary

Constructors

Constructor	Description
ImaDaiSettings(java.lang.String assetKey, ImaDaiSettings.StreamType streamType, java.lang.String apiKey)	Constructor for DAI settings for a Live Stream
ImaDaiSettings(java.lang.String videoId, java.lang.String cmsId, ImaDaiSettings.StreamType streamType, java.lang.String apiKey)	Constructor for DAI settings for a VOD Stream

Method Summary

Modifier and Type	Method	Description
void	addJson(org.json.JSONObject jsonObjectToAddFieldsTo)
java.util.Map<java.lang.String,java.lang.String>	getAdTagParameters()
java.lang.String	getApiKey()
java.lang.String	getAssetKey()
java.lang.String	getCmsId()
ImaDaiSettings.StreamType	getStreamType()
java.lang.String	getVideoId()
static ImaDaiSettings	parseJson(java.lang.String json)
static ImaDaiSettings	parseJson(org.json.JSONObject json)
void	setAdTagParameters(java.util.Map<java.lang.String,java.lang.String> mAdTagParameters)
org.json.JSONObject	toJson()

Methods inherited from class java.lang.Object

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

Constructor Detail

ImaDaiSettings

public ImaDaiSettings(@NonNull
                      java.lang.String videoId,
                      @NonNull
                      java.lang.String cmsId,
                      @NonNull
                      ImaDaiSettings.StreamType streamType,
                      @Nullable
                      java.lang.String apiKey)

Constructor for DAI settings for a VOD Stream

Parameters:

videoId - Video ID for the video you would like to play

cmsId - CMS ID for the video you would like to play

streamType - The type of stream (HLS or DASH)

apiKey - DAI authentication key

ImaDaiSettings

public ImaDaiSettings(@NonNull
                      java.lang.String assetKey,
                      @NonNull
                      ImaDaiSettings.StreamType streamType,
                      @Nullable
                      java.lang.String apiKey)

Constructor for DAI settings for a Live Stream

Parameters:

assetKey - The asset key for the Live Stream you would like to play

streamType - The type of stream (HLS or DASH)

apiKey - DAI authentication key

Method Detail

getVideoId

@Nullable
public java.lang.String getVideoId()

Returns:

The video ID for the DAI stream to play

getCmsId

@Nullable
public java.lang.String getCmsId()

Returns:

The CMS ID for the DAI stream to play

getAssetKey

@Nullable
public java.lang.String getAssetKey()

Returns:

The asset key for the DAI stream to play

getApiKey

@Nullable
public java.lang.String getApiKey()

Returns:

The DAI authentication key

getStreamType

@NonNull
public ImaDaiSettings.StreamType getStreamType()

Returns:

The type of stream (HLS or DASH)

getAdTagParameters

@Nullable
public java.util.Map<java.lang.String,java.lang.String> getAdTagParameters()

Returns:

The ad tag parameters on the DAI stream request that is override

setAdTagParameters

public void setAdTagParameters(@Nullable
                               java.util.Map<java.lang.String,java.lang.String> mAdTagParameters)

Parameters:

mAdTagParameters - The ad tag parameters on the DAI stream request that is override

toJson

public org.json.JSONObject toJson()

Specified by:

toJson in interface com.longtailvideo.jwplayer.utils.Jsonable

addJson

public void addJson(org.json.JSONObject jsonObjectToAddFieldsTo)

parseJson

public static ImaDaiSettings parseJson(org.json.JSONObject json)
                                throws org.json.JSONException

Throws:

org.json.JSONException

parseJson

public static ImaDaiSettings parseJson(java.lang.String json)
                                throws org.json.JSONException

Throws:

org.json.JSONException