Package io.guise.framework.platform.web
Enum WebAudioDepictor.AudioCommand
- java.lang.Object
-
- java.lang.Enum<WebAudioDepictor.AudioCommand>
-
- io.guise.framework.platform.web.WebAudioDepictor.AudioCommand
-
- All Implemented Interfaces:
com.globalmentor.lex.Identifier
,com.globalmentor.lex.Token
,PlatformCommand
,WebPlatformCommand
,java.io.Serializable
,java.lang.Comparable<WebAudioDepictor.AudioCommand>
- Enclosing class:
- WebAudioDepictor
public static enum WebAudioDepictor.AudioCommand extends java.lang.Enum<WebAudioDepictor.AudioCommand> implements WebPlatformCommand
The web commands for controlling audio.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description AUDIO_PAUSE
The command to pause the audio.AUDIO_PLAY
The command to start the audio.AUDIO_POSITION
The command to set the position of the audio.AUDIO_STOP
The command to stop the audio.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
POSITION_PROPERTY
The property for specifying the position of the audio.static java.lang.String
TYPE_PROPERTY
The property for specifying the content type of the audio.static java.lang.String
URI_PROPERTY
The property for specifying the URI of the audio.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static WebAudioDepictor.AudioCommand
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static WebAudioDepictor.AudioCommand[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
AUDIO_PLAY
public static final WebAudioDepictor.AudioCommand AUDIO_PLAY
-
AUDIO_PAUSE
public static final WebAudioDepictor.AudioCommand AUDIO_PAUSE
The command to pause the audio.
-
AUDIO_STOP
public static final WebAudioDepictor.AudioCommand AUDIO_STOP
The command to stop the audio.
-
AUDIO_POSITION
public static final WebAudioDepictor.AudioCommand AUDIO_POSITION
The command to set the position of the audio. parameters:{"position":"millisecondPosition"}
-
-
Field Detail
-
URI_PROPERTY
public static final java.lang.String URI_PROPERTY
The property for specifying the URI of the audio.- See Also:
- Constant Field Values
-
TYPE_PROPERTY
public static final java.lang.String TYPE_PROPERTY
The property for specifying the content type of the audio.- See Also:
- Constant Field Values
-
POSITION_PROPERTY
public static final java.lang.String POSITION_PROPERTY
The property for specifying the position of the audio.- See Also:
- Constant Field Values
-
-
Method Detail
-
values
public static WebAudioDepictor.AudioCommand[] 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 (WebAudioDepictor.AudioCommand c : WebAudioDepictor.AudioCommand.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static WebAudioDepictor.AudioCommand 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 namejava.lang.NullPointerException
- if the argument is null
-
-