Whole document tree


www.fifi.org
    Documentation
        Manpages
        GNU Info
        Debian document tree
        Whole document tree
    Trigance web page
    Public services
    User info
    Mailing lists
    Secure server
    Multilingual usage
 

Copyright (C) 2000-2012
Philippe Troin
<webmaster@fifi.org>.

Validate HTML
Validate CSS

    

Whole document tree

Java 2 Platform SE v1.3.1: Class LineEvent
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
JavaTM 2 Platform
Std. Ed. v1.3.1
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

javax.sound.sampled
Class LineEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--javax.sound.sampled.LineEvent
All Implemented Interfaces:
Serializable
public class LineEvent
extends EventObject

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 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.

Since:
1.3
See Also:
Line, LineListener.update(javax.sound.sampled.LineEvent), Serialized Form

Inner Class Summary
static class LineEvent.Type
          The LineEvent.Type inner class identifies what kind of event occurred on a line.
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
LineEvent(Line line, LineEvent.Type type, long position)
          Constructs a new event of the specified type, originating from the specified line.
 
Method Summary
 long getFramePosition()
          Obtains the position in the line's audio data when the event occurred, expressed in sample frames.
 Line getLine()
          Obtains the audio line that is the source of this event.
 LineEvent.Type getType()
          Obtains the event's type.
 String toString()
          Obtains a string representation of the event.
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LineEvent

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 AudioSystem.NOT_SPECIFIED
Method Detail

getLine

public final Line getLine()
Obtains the audio line that is the source of this event.
Returns:
the line responsible for this event

getType

public final LineEvent.Type getType()
Obtains the event's type.
Returns:
this event's type (LineEvent.Type.OPEN, LineEvent.Type.CLOSE, LineEvent.Type.START, or LineEvent.Type.STOP)

getFramePosition

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 AudioSystem.NOT_SPECIFIED.

Returns:
the line's position as a sample frame number

toString

public String toString()
Obtains a string representation of the event. The contents of the string may vary between implementations of Java Sound.
Overrides:
toString in class EventObject
Returns:
a string describing the event.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
JavaTM 2 Platform
Std. Ed. v1.3.1
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2001 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.