Package com.jwplayer.pub.api.configuration

Class RelatedConfig

java.lang.Object

com.jwplayer.pub.api.configuration.RelatedConfig

All Implemented Interfaces:

android.os.Parcelable

public final class RelatedConfig
extends java.lang.Object
implements android.os.Parcelable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RelatedConfig.Builder
static interface	RelatedConfig.RelatedOnClick
static interface	RelatedConfig.RelatedOnComplete

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static android.os.Parcelable.Creator<RelatedConfig>	CREATOR
java.lang.String	mAutoPlayMessage
java.lang.Integer	mAutoPlayTimer
java.lang.String	mFile
java.lang.String	mOnClick
java.lang.String	mOnComplete
static java.lang.String	RELATED_ON_CLICK_LINK
static java.lang.String	RELATED_ON_CLICK_PLAY	OnClick StringDef
static java.lang.String	RELATED_ON_COMPLETE_AUTOPLAY
static java.lang.String	RELATED_ON_COMPLETE_HIDE	OnComplete StringDef
static java.lang.String	RELATED_ON_COMPLETE_NONE
static java.lang.String	RELATED_ON_COMPLETE_SHOW

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method	Description
int	describeContents()
java.lang.String	getAutoPlayMessage()	Deprecated. This API has been deprecated, override the key jwplayer_next_up_countdown in strings.xml to customize this message.
java.lang.Integer	getAutoPlayTimer()
java.lang.String	getFile()
java.lang.String	getOnClick()
java.lang.String	getOnComplete()
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 Detail

RELATED_ON_COMPLETE_HIDE

public static final java.lang.String RELATED_ON_COMPLETE_HIDE

OnComplete StringDef

See Also:

Constant Field Values

RELATED_ON_COMPLETE_SHOW

public static final java.lang.String RELATED_ON_COMPLETE_SHOW

See Also:

Constant Field Values

RELATED_ON_COMPLETE_NONE

public static final java.lang.String RELATED_ON_COMPLETE_NONE

See Also:

Constant Field Values

RELATED_ON_COMPLETE_AUTOPLAY

public static final java.lang.String RELATED_ON_COMPLETE_AUTOPLAY

See Also:

Constant Field Values

RELATED_ON_CLICK_PLAY

public static final java.lang.String RELATED_ON_CLICK_PLAY

OnClick StringDef

See Also:

Constant Field Values

RELATED_ON_CLICK_LINK

public static final java.lang.String RELATED_ON_CLICK_LINK

See Also:

Constant Field Values

mFile

public final java.lang.String mFile

mOnComplete

public final java.lang.String mOnComplete

mOnClick

public final java.lang.String mOnClick

mAutoPlayTimer

public final java.lang.Integer mAutoPlayTimer

mAutoPlayMessage

public final java.lang.String mAutoPlayMessage

CREATOR

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

Method Detail

getFile

public java.lang.String getFile()

Returns:

(Required) Location of an RSS or JSON file containing a feed of related videos.

getOnComplete

@NonNull
public java.lang.String getOnComplete()

Returns:

The behavior of our related videos overlay when a single video or playlist is completed. Must be one of the RELATED_DISPLAY_ON_COMPLETE_ constants.

getOnClick

@NonNull
public java.lang.String getOnClick()

Returns:

The behavior when a related video is selected. Must be one of the RELATED_DISPLAY_ON_CLICK_ constants.

getAutoPlayTimer

@NonNull
public java.lang.Integer getAutoPlayTimer()

Returns:

The number of seconds to wait before playing the next related video in your content list. Set to 0 to have your next related content to play immediately.

getAutoPlayMessage

@Nullable
@Deprecated
public java.lang.String getAutoPlayMessage()

Deprecated.

This API has been deprecated, override the key jwplayer_next_up_countdown in strings.xml to customize this message.

Returns:

A custom message that appears during autoplay.

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