Package com.theoplayer.android.api.player.track.texttrack

Enum TextTrackMode

  • All Implemented Interfaces:
    
public enum TextTrackMode

    The mode of the text track.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description
      public final String mode

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DISABLED

      The track is disabled.

      • A disabled track is not displayed and exposes no active cues, nor fires cue events.
      HIDDEN

      The track is hidden.

      • A hidden track is not displayed but exposes active cues and fires cue events.
      SHOWING

      The track is showing.

      • A showing track is displayed, exposes active cues and fires cue events.

    • Method Summary

      Modifier and Type Method Description
      static TextTrackMode from(String mode) Creates a text track mode from a textual representation, when possible.
      String toString()
      static Array<TextTrackMode> values() Returns an array containing the constants of this enum type, in the order they're declared.
      static TextTrackMode valueOf(String name) Returns the enum constant of this type with the specified name.
      String getMode() The textual representation of the text track mode.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • from

        @Nullable() static TextTrackMode from(String mode)

        Creates a text track mode from a textual representation, when possible.

        Parameters:
        mode - The textual representation of the text track mode.
        Returns:

        The text track mode. (Nullable)

      • values

         static Array<TextTrackMode> values()

        Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.

        Returns:

        an array containing the constants of this enum type, in the order they're declared

      • valueOf

         static TextTrackMode valueOf(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.)

        Returns:

        the enum constant with the specified name

      • getMode

        @NonNull() String getMode()

        The textual representation of the text track mode.

        Returns:

        The textual representation of the text track mode. (NonNull)