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, Serializable, Comparable<WebAudioDepictor.AudioCommand>

Enclosing class:

WebAudioDepictor

public static enum WebAudioDepictor.AudioCommand
extends 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 final String	POSITION_PROPERTY	The property for specifying the position of the audio.
static final String	TYPE_PROPERTY	The property for specifying the content type of the audio.
static final String	URI_PROPERTY	The property for specifying the URI of the audio.

Method Summary

Modifier and Type	Method	Description
static WebAudioDepictor.AudioCommand	valueOf(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.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AUDIO_PLAY

public static final WebAudioDepictor.AudioCommand AUDIO_PLAY

The command to start the audio. Parameters:

• {"uri":"uri"}
• {"type":"type"}

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 Details

URI_PROPERTY

public static final String URI_PROPERTY

The property for specifying the URI of the audio.

See Also:

• Constant Field Values

TYPE_PROPERTY

public static final String TYPE_PROPERTY

The property for specifying the content type of the audio.

See Also:

• Constant Field Values

POSITION_PROPERTY

public static final String POSITION_PROPERTY

The property for specifying the position of the audio.

See Also:

• Constant Field Values

Method Details

values

public static WebAudioDepictor.AudioCommand[] 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 WebAudioDepictor.AudioCommand 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