Package io.guise.framework.input

Enum MediaCommand

java.lang.Object
java.lang.Enum<MediaCommand>
io.guise.framework.input.MediaCommand
All Implemented Interfaces:
Command, Serializable, Comparable<MediaCommand>
public enum MediaCommand extends Enum<MediaCommand> implements Command
Commands for controlling media.
Author:
Garret Wilson

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ADVANCE
    The command for advancing in a media stream from the current location.
    NEXT
    The command for moving to the next media resource in a series.
    PAUSE
    The command for pausing a media stream, with the capability to continue the media stream later.
    PLAY
    The command for starting media.
    PREVIOUS
    The command for moving to the previous media resource in a series.
    RECEDE
    The command for receding in a media stream from the current location.
    RECORD
    The command for recording input to media.
    STOP
    The command for stopping media.

  • Method Summary

    Modifier and Type
    Method
    Description
    URI
    getGlyph()
     
    String
    getLabel()
     
    String
    toString()
    Returns a string representation of the command.
    static MediaCommand
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static MediaCommand[]
    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 Details

    • ADVANCE

      public static final MediaCommand ADVANCE
      The command for advancing in a media stream from the current location.

    • NEXT

      public static final MediaCommand NEXT
      The command for moving to the next media resource in a series.

    • PAUSE

      public static final MediaCommand PAUSE
      The command for pausing a media stream, with the capability to continue the media stream later.

    • PLAY

      public static final MediaCommand PLAY
      The command for starting media.

    • PREVIOUS

      public static final MediaCommand PREVIOUS
      The command for moving to the previous media resource in a series.

    • RECEDE

      public static final MediaCommand RECEDE
      The command for receding in a media stream from the current location.

    • RECORD

      public static final MediaCommand RECORD
      The command for recording input to media.

    • STOP

      public static final MediaCommand STOP
      The command for stopping media.

  • Method Details

    • values

      public static MediaCommand[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static MediaCommand 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.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getLabel

      public String getLabel()
      Returns:
      The resource reference for the label.

    • getGlyph

      public URI getGlyph()
      Returns:
      The resource reference for the glyph.

    • toString

      public String toString()
      Returns a string representation of the command. This implementation delegates to getLabel().
      Overrides:
      toString in class Enum<MediaCommand>
      Returns:
      A string representation of the object.