AutoCloseable
, DataLine
, Line
public interface Clip extends DataLine
Clip
interface represents a special kind of data line whose audio data can be loaded prior to playback, instead of being streamed in real time. Because the data is pre-loaded and has a known length, you can set a clip to start playing at any position in its audio data. You can also create a loop, so that when the clip is played it will cycle repeatedly. Loops are specified with a starting and ending sample frame, along with the number of times that the loop should be played.
Clips may be obtained from a Mixer
that supports lines of this type. Data is loaded into a clip when it is opened.
Playback of an audio clip may be started and stopped using the start
and stop
methods. These methods do not reset the media position; start
causes playback to continue from the position where playback was last stopped. To restart playback from the beginning of the clip's audio data, simply follow the invocation of stop
with setFramePosition(0)
, which rewinds the media to the beginning of the clip.
DataLine.Info
Modifier and Type | Field | Description |
---|---|---|
static final int |
LOOP_CONTINUOUSLY |
A value indicating that looping should continue indefinitely rather than complete after a specific number of loops. |
Modifier and Type | Method | Description |
---|---|---|
int |
getFrameLength() |
Obtains the media length in sample frames. |
long |
getMicrosecondLength() |
Obtains the media duration in microseconds. |
void |
loop |
Starts looping playback from the current position. |
void |
open |
Opens the clip, meaning that it should acquire any required system resources and become operational. |
void |
open |
Opens the clip with the format and audio data present in the provided audio input stream. |
void |
setFramePosition |
Sets the media position in sample frames. |
void |
setLoopPoints |
Sets the first and last sample frames that will be played in the loop. |
void |
setMicrosecondPosition |
Sets the media position in microseconds. |
available, drain, flush, getBufferSize, getFormat, getFramePosition, getLevel, getLongFramePosition, getMicrosecondPosition, isActive, isRunning, start, stop
addLineListener, close, getControl, getControls, getLineInfo, isControlSupported, isOpen, open, removeLineListener
static final int LOOP_CONTINUOUSLY
void open(AudioFormat format, byte[] data, int offset, int bufferSize) throws LineUnavailableException
OPEN
event is dispatched to the line's listeners. Invoking this method on a line which is already open is illegal and may result in an IllegalStateException
.
Note that some lines, once closed, cannot be reopened. Attempts to reopen such a line will always result in a LineUnavailableException
.
format
- the format of the supplied audio datadata
- a byte array containing audio data to load into the clipoffset
- the point at which to start copying, expressed in bytes from the beginning of the arraybufferSize
- the number of bytes of data to load into the clip from the arrayLineUnavailableException
- if the line cannot be opened due to resource restrictionsIllegalArgumentException
- if the buffer size does not represent an integral number of sample frames, or if format
is not fully specified or invalidIllegalStateException
- if the line is already openSecurityException
- if the line cannot be opened due to security restrictionsvoid open(AudioInputStream stream) throws LineUnavailableException, IOException
OPEN
event is dispatched to the line's listeners. Invoking this method on a line which is already open is illegal and may result in an IllegalStateException
.
Note that some lines, once closed, cannot be reopened. Attempts to reopen such a line will always result in a LineUnavailableException
.
stream
- an audio input stream from which audio data will be read into the clipLineUnavailableException
- if the line cannot be opened due to resource restrictionsIOException
- if an I/O exception occurs during reading of the streamIllegalArgumentException
- if the stream's audio format is not fully specified or invalidIllegalStateException
- if the line is already openSecurityException
- if the line cannot be opened due to security restrictionsint getFrameLength()
AudioSystem.NOT_SPECIFIED
if the line is not openlong getMicrosecondLength()
AudioSystem.NOT_SPECIFIED
if the line is not openvoid setFramePosition(int frames)
To obtain the current position in sample frames, use the getFramePosition
method of DataLine
.
frames
- the desired new media position, expressed in sample framesvoid setMicrosecondPosition(long microseconds)
To obtain the current position in microseconds, use the getMicrosecondPosition
method of DataLine
.
microseconds
- the desired new media position, expressed in microsecondsvoid setLoopPoints(int start, int end)
start
- the loop's starting position, in sample frames (zero-based)end
- the loop's ending position, in sample frames (zero-based), or -1 to indicate the final frameIllegalArgumentException
- if the requested loop points cannot be set, usually because one or both falls outside the media's duration or because the ending point is before the starting pointvoid loop(int count)
count
times, and finally continue playback to the end of the clip. If the current position when this method is invoked is greater than the loop end point, playback simply continues to the end of the clip without looping.
A count
value of 0 indicates that any current looping should cease and playback should continue to the end of the clip. The behavior is undefined when this method is invoked with any other value during a loop operation.
If playback is stopped during looping, the current loop status is cleared; the behavior of subsequent loop and start requests is not affected by an interrupted loop operation.
count
- the number of times playback should loop back from the loop's end position to the loop's start position, or LOOP_CONTINUOUSLY
to indicate that looping should continue until interrupted
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/sound/sampled/Clip.html