| java.lang.Object
 java.util.EventObject
javax.sound.sampled.LineEvent
| LineEvent | | public class LineEvent extends java.util.EventObject (Code) | | 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
LineListener.update 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.
author:
Kara Kytle
version:
1.33, 07/05/05
See Also: Line
See Also: LineListener.update
since:
1.3 |
| Inner Class :public static class Type | |
| Constructor Summary | |
| public | LineEvent(Line line, Type type, long position)
Constructs a new event of the specified type, originating from the specified line. |
| Method Summary | |
| final public long | getFramePosition()
Obtains the position in the line's audio data when the event occurred, expressed in sample frames. | | final public Line | getLine()
Obtains the audio line that is the source of this event. | | final public Type | getType()
Obtains the event's type. | | public String | toString()
Obtains a string representation of the event. |
| LineEvent | | public LineEvent(Line line, Type type, long position)(Code) | | Constructs a new event of the specified type, originating from the specified line.
Parameters:
line - the source of this event
Parameters:
type - the event type (OPEN, CLOSE, START, or STOP)
Parameters:
position - the number of sample frames that the line had already processed when the event occurred,or AudioSystem.NOT_SPECIFIED
throws:
IllegalArgumentException - if line isnull. |
| getFramePosition | | final public long getFramePosition()(Code) | | 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 .
the line's position as a sample frame number |
| getLine | | final public Line getLine()(Code) | | Obtains the audio line that is the source of this event.
the line responsible for this event |
| getType | | final public Type getType()(Code) | | Obtains the event's type.
this event's type (Type.OPEN, Type.CLOSE, Type.START, or Type.STOP) |
| toString | | public String toString()(Code) | | Obtains a string representation of the event. The contents of the string may vary
between implementations of Java Sound.
a string describing the event. |
|
|