Package com.jwplayer.pub.api.media.ads.dai

Class ImaDaiSettings

java.lang.Object

com.jwplayer.pub.api.media.ads.dai.ImaDaiSettings

All Implemented Interfaces:

android.os.Parcelable

public class ImaDaiSettings
extends Object
implements android.os.Parcelable

IMA DAI settings for a stream

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T extends Object>, android.os.Parcelable.Creator<T extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final android.os.Parcelable.Creator<ImaDaiSettings>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	describeContents()
Map<String,String>	getAdTagParameters()
String	getApiKey()
String	getAssetKey()
String	getCmsId()
ImaDaiSettings.StreamType	getStreamType()
String	getVideoId()
void	setAdTagParameters(Map<String,String> mAdTagParameters)
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Details

CREATOR

public static final android.os.Parcelable.Creator<ImaDaiSettings> CREATOR

Constructor Details

ImaDaiSettings

public ImaDaiSettings(@NonNull
 String videoId,
 @NonNull
 String cmsId,
 @NonNull
 ImaDaiSettings.StreamType streamType,
 @Nullable
 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
 String assetKey,
 @NonNull
 ImaDaiSettings.StreamType streamType,
 @Nullable
 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 Details

getVideoId

@Nullable
public String getVideoId()

Returns:

The video ID for the DAI stream to play

getCmsId

@Nullable
public String getCmsId()

Returns:

The CMS ID for the DAI stream to play

getAssetKey

@Nullable
public String getAssetKey()

Returns:

The asset key for the DAI stream to play

getApiKey

@Nullable
public String getApiKey()

Returns:

The DAI authentication key

getStreamType

@NonNull
public ImaDaiSettings.StreamType getStreamType()

Returns:

The type of stream (HLS or DASH)

getAdTagParameters

@Nullable
public Map<String,String> getAdTagParameters()

Returns:

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

setAdTagParameters

public void setAdTagParameters(@Nullable
 Map<String,String> mAdTagParameters)

Parameters:

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

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
 int flags)

Specified by:

writeToParcel in interface android.os.Parcelable