| java.lang.Object | ||
| ↳ | java.util.EventObject | |
| ↳ | javax.sound.sampled.LineEvent | |
Class Overview
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.
See Also
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| LineEvent.Type | The LineEvent.Type inner class identifies what kind of event occurred on a line. | ||||||||||
|
[Expand]
Inherited Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From class
java.util.EventObject
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a new event of the specified type, originating from the specified line.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Obtains the position in the line's audio data when the event occurred, expressed in sample frames.
| |||||||||||
Obtains the audio line that is the source of this event.
| |||||||||||
Obtains the event's type.
| |||||||||||
Obtains a string representation of the event.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.util.EventObject
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Constructors
public LineEvent (Line line, LineEvent.Type type, long 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 NOT_SPECIFIED |
Throws
| IllegalArgumentException | if line is
null.
|
|---|
Public Methods
public final long getFramePosition ()
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 NOT_SPECIFIED.
Returns
- the line's position as a sample frame number
public final Line getLine ()
Obtains the audio line that is the source of this event.
Returns
- the line responsible for this event
public final LineEvent.Type getType ()
public String toString ()
Obtains a string representation of the event. The contents of the string may vary between implementations of Java Sound.
Returns
- a string describing the event.