ioio.lib.api

Enum Sequencer.Event.Type

java.lang.Object

java.lang.Enum<Sequencer.Event.Type>

ioio.lib.api.Sequencer.Event.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Sequencer.Event.Type>

Enclosing class:

Sequencer.Event

public static enum Sequencer.Event.Type
extends java.lang.Enum<Sequencer.Event.Type>

Event type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSED This event type is only sent once, when the sequencer has been closed.
CUE_STARTED A new cue has started executing.
PAUSED A cue has ended execution and the sequencer is idle as result of a pause request.
STALLED A cue has ended execution and the sequencer is idle as result of the queue becoming empty.
STOPPED The sequencer has been stopped or never started.

Method Summary

Methods

Modifier and Type	Method and Description
static Sequencer.Event.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Sequencer.Event.Type[]	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 Detail

STOPPED

public static final Sequencer.Event.Type STOPPED

The sequencer has been stopped or never started. This will always be accompanied by a numCuesStarted of 0. This event will also be the first event appearing on the event queue to designate the the sequencer has been opened and the cue FIFO is at its full capacity for pushing messages. This is useful if the client wants to pre-fill the FIFO in order to avoid stalls.

CUE_STARTED

public static final Sequencer.Event.Type CUE_STARTED

A new cue has started executing.

PAUSED

public static final Sequencer.Event.Type PAUSED

A cue has ended execution and the sequencer is idle as result of a pause request.

STALLED

public static final Sequencer.Event.Type STALLED

A cue has ended execution and the sequencer is idle as result of the queue becoming empty.

CLOSED

public static final Sequencer.Event.Type CLOSED

This event type is only sent once, when the sequencer has been closed. It is mostly intended to release a client blocking on Sequencer.waitEvent(). It is also used if Sequencer.getLastEvent() is called before any event has been sent.

Method Detail

values

public static Sequencer.Event.Type[] 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 (Sequencer.Event.Type c : Sequencer.Event.Type.values())
    System.out.println(c);

Returns:

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

valueOf

public static Sequencer.Event.Type 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