javax.sound.sampled: public class: LineEvent

javax.sound.sampled
public class: LineEvent [javadoc | source]

java.lang.Object
   java.util.EventObject
      javax.sound.sampled.LineEvent

The LineEvent class encapsulates information that a line sends its listeners whenever the line opens, closes, starts, or stops. Each of these four state changes is represented by a corresponding type of event. A listener receives the event as a parameter to its update method. By querying the event, the listener can learn the type of event, the line responsible for the event, and how much data the line had processed when the event occurred.

Although this class implements Serializable, attempts to serialize a LineEvent object will fail.

Also see:

Line

LineListener#update

author: Kara - Kytle

since: 1.3 -

serial: exclude -

Nested Class Summary:
public static class	LineEvent.Type	The LineEvent.Type inner class identifies what kind of event occurred on a line. Static instances are provided for the common types (OPEN, CLOSE, START, and STOP).

Constructor:

Constructor:
public LineEvent(Line line, Type type, long position) { super(line); this.type = type; this.position = position; } Constructs a new event of the specified type, originating from the specified line. Parameters: `line` - the source of this event `type` - the event type (`OPEN`, `CLOSE`, `START`, or `STOP`) `position` - the number of sample frames that the line had already processed when the event occurred, or AudioSystem#NOT_SPECIFIED Throws: `IllegalArgumentException` - if `line` is `null`.

 public LineEvent(Line line,
    Type type,
    long position) {
        super(line);
        this.type = type;
        this.position = position;
}

Constructs a new event of the specified type, originating from the specified line.

Parameters:

line - the source of this event

type - the event type (OPEN, CLOSE, START, or STOP)

position - the number of sample frames that the line had already processed when the event occurred, or AudioSystem#NOT_SPECIFIED

Throws:

IllegalArgumentException - if line is null.

Method from javax.sound.sampled.LineEvent Summary:
getFramePosition, getLine, getType, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.sound.sampled.LineEvent Detail:
public final long getFramePosition() { return position; } Obtains the position in the line's audio data when the event occurred, expressed in sample frames. For example, if a source line had already played back 14 sample frames at the time it was paused, the pause event would report the line's position as 14. The next frame to be processed would be frame number 14 using zero-based numbering, or 15 using one-based numbering. Note that this field is relevant only to certain events generated by data lines, such as `START` and `STOP`. For events generated by lines that do not count sample frames, and for any other events for which this value is not known, the position value should be AudioSystem#NOT_SPECIFIED .
public final Line getLine() { return (Line)getSource(); } Obtains the audio line that is the source of this event.
public final Type getType() { return type; } Obtains the event's type.
public String toString() { String sType = ""; if (type != null) sType = type.toString()+" "; String sLine; if (getLine() == null) { sLine = "null"; } else { sLine = getLine().toString(); } return new String(sType + "event from line " + sLine); } Obtains a string representation of the event. The contents of the string may vary between implementations of Java Sound.

Method from javax.sound.sampled.LineEvent Detail:

 public final long getFramePosition() {
        return position;
}

Note that this field is relevant only to certain events generated by data lines, such as START and STOP. For events generated by lines that do not count sample frames, and for any other events for which this value is not known, the position value should be AudioSystem#NOT_SPECIFIED .

 public final Line getLine() {
        return (Line)getSource();
}

Obtains the audio line that is the source of this event.

 public final Type getType() {
        return type;
}

Obtains the event's type.

 public String toString() {
        String sType = "";
        if (type != null) sType = type.toString()+" ";
        String sLine;
        if (getLine() == null) {
            sLine = "null";
        } else {
            sLine = getLine().toString();
        }
        return new String(sType + "event from line " + sLine);
}

Obtains a string representation of the event. The contents of the string may vary between implementations of Java Sound.