Package com.jwplayer.pub.api

Enum PauseReason

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<PauseReason>
    public enum PauseReason
extends java.lang.Enum<PauseReason>
    Constants indicating the reason the player is in the pause state.

    • 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

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equalsName​(java.lang.String otherName)  
      java.lang.String toString()  
      static PauseReason valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PauseReason[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • 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 Detail

      • values

        public static PauseReason[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (PauseReason c : PauseReason.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static PauseReason valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • equalsName

        public boolean equalsName​(java.lang.String otherName)

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<PauseReason>