Package com.jwplayer.pub.api

Enum Class PlayReason

java.lang.Object

java.lang.Enum<PlayReason>

com.jwplayer.pub.api.PlayReason

All Implemented Interfaces:

Serializable, Comparable<PlayReason>, Constable

public enum PlayReason
extends Enum<PlayReason>

Constants indicating the reason the player is in the play state.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTO_START	Player automatically began playing.
CLICK_THROUGH	Player is playing due to a clickthrough.
EXTERNAL	Player is playing due to external api call.
INTERACTION	Player is playing due to user interaction.
PLAY_LIST	Playback began due to natural playlist progression.
RELATED_AUTO	Player is playing due to the auto advance feature.
RELATED_INTERACTION	Player is playing due to user interaction with the related menu.
REPEAT_CONTENT	Playback began due to repeat flag is enabled.
SETTINGS_INTERACTION	Playback resumed due to user interaction with the settings menu.
UNKNOWN	Player is playing but the cause is unknown.
VIEWABLE	Playback began due to autostart setting or when the player is 50% visible.

Method Summary

Modifier and Type	Method	Description
boolean	equalsName(String otherName)
String	toString()
static PlayReason	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PlayReason[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EXTERNAL

public static final PlayReason EXTERNAL

Player is playing due to external api call.

INTERACTION

public static final PlayReason INTERACTION

Player is playing due to user interaction.

CLICK_THROUGH

public static final PlayReason CLICK_THROUGH

Player is playing due to a clickthrough.

PLAY_LIST

public static final PlayReason PLAY_LIST

Playback began due to natural playlist progression.

VIEWABLE

public static final PlayReason VIEWABLE

Playback began due to autostart setting or when the player is 50% visible.

SETTINGS_INTERACTION

public static final PlayReason SETTINGS_INTERACTION

Playback resumed due to user interaction with the settings menu.

RELATED_INTERACTION

public static final PlayReason RELATED_INTERACTION

Player is playing due to user interaction with the related menu.

AUTO_START

public static final PlayReason AUTO_START

Player automatically began playing.

REPEAT_CONTENT

public static final PlayReason REPEAT_CONTENT

Playback began due to repeat flag is enabled.

RELATED_AUTO

public static final PlayReason RELATED_AUTO

Player is playing due to the auto advance feature.

UNKNOWN

public static final PlayReason UNKNOWN

Player is playing but the cause is unknown.

Method Details

values

public static PlayReason[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PlayReason valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

equalsName

public boolean equalsName(String otherName)

toString

public String toString()

Overrides:

toString in class Enum<PlayReason>