Package com.jwplayer.pub.api

Enum Class PauseReason

java.lang.Object

java.lang.Enum<PauseReason>

com.jwplayer.pub.api.PauseReason

All Implemented Interfaces:

Serializable, Comparable<PauseReason>, Constable

public enum PauseReason
extends Enum<PauseReason>

Constants indicating the reason the player is in the pause 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 is paused when playback cannot start automatically because the player is not visible.
CLICK_THROUGH	Player is paused due to a clickthrough.
EXTERNAL	Player is paused due to external api call.
INTERACTION	Player is paused due to user interaction.
RELATED_INTERACTION	Player is paused due to user interaction with the related menu.
SETTINGS_INTERACTION	Player is paused due to user interaction with the settings menu.
UNKNOWN	Unknown reason.
VIEWABLE	Playback paused due to the player being less than 50% visible.

Method Summary

Modifier and Type	Method	Description
boolean	equalsName(String otherName)
String	toString()
static PauseReason	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PauseReason[]	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 PauseReason EXTERNAL

Player is paused due to external api call.

INTERACTION

public static final PauseReason INTERACTION

Player is paused due to user interaction.

CLICK_THROUGH

public static final PauseReason CLICK_THROUGH

Player is paused due to a clickthrough.

VIEWABLE

public static final PauseReason VIEWABLE

Playback paused due to the player being less than 50% visible.

SETTINGS_INTERACTION

public static final PauseReason SETTINGS_INTERACTION

Player is paused due to user interaction with the settings menu.

RELATED_INTERACTION

public static final PauseReason RELATED_INTERACTION

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

AUTO_START

public static final PauseReason AUTO_START

Player is paused when playback cannot start automatically because the player is not visible.

UNKNOWN

public static final PauseReason UNKNOWN

Unknown reason.

Method Details

values

public static PauseReason[] 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 PauseReason 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<PauseReason>