OpenJDK 27 · javax.sound.sampled.Clip · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final int	LOOP_CONTINUOUSLY A value indicating that looping should continue indefinitely rather than complete after a specific number of loops.

Method Summary

Modifier and Type	Method and Description
public int	Returns: the media length, expressed in sample frames, or `AudioSystem.NOT_SPECIFIED` if the line is not open getFrameLength() Obtains the media length in sample frames.
public long	Returns: the media duration, expressed in microseconds, or `AudioSystem.NOT_SPECIFIED` if the line is not open getMicrosecondLength() Obtains the media duration in microseconds.
public void	loop(int 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 count) Starts looping playback from the current position.
public void	open(AudioFormat the format of the supplied audio data format, byte[] a byte array containing audio data to load into the clip data, int the point at which to start copying, expressed in bytes from the beginning of the array offset, int the number of bytes of data to load into the clip from the array bufferSize) Opens the clip, meaning that it should acquire any required system resources and become operational.
public void	open(AudioInputStream an audio input stream from which audio data will be read into the clip stream) Opens the clip with the format and audio data present in the provided audio input stream.
public void	setFramePosition(int the desired new media position, expressed in sample frames frames) Sets the media position in sample frames.
public void	setLoopPoints(int the loop's starting position, in sample frames (zero-based) start, int the loop's ending position, in sample frames (zero-based), or -1 to indicate the final frame end) Sets the first and last sample frames that will be played in the loop.
public void	setMicrosecondPosition(long the desired new media position, expressed in microseconds microseconds) Sets the media position in microseconds.

Inherited from javax.sound.sampled.DataLine:: available drain flush getBufferSize getFormat getFramePosition getLevel getLongFramePosition getMicrosecondPosition isActive isRunning start stop

LOOP_CONTINUOUSLY	back to summary
public static final int LOOP_CONTINUOUSLY A value indicating that looping should continue indefinitely rather than complete after a specific number of loops. See Also `loop`

Method Detail

getFrameLength back to summary

getFrameLength	back to summary
public int getFrameLength() Obtains the media length in sample frames. Returns:int the media length, expressed in sample frames, or `AudioSystem.NOT_SPECIFIED` if the line is not open See Also `AudioSystem#NOT_SPECIFIED`

public int getFrameLength()

Obtains the media length in sample frames.

Returns:int: the media length, expressed in sample frames, or AudioSystem.NOT_SPECIFIED if the line is not open
See Also: AudioSystem#NOT_SPECIFIED

getMicrosecondLength back to summary

getMicrosecondLength	back to summary
public long getMicrosecondLength() Obtains the media duration in microseconds. Returns:long the media duration, expressed in microseconds, or `AudioSystem.NOT_SPECIFIED` if the line is not open See Also `AudioSystem#NOT_SPECIFIED`

public long getMicrosecondLength()

Obtains the media duration in microseconds.

Returns:long: the media duration, expressed in microseconds, or AudioSystem.NOT_SPECIFIED if the line is not open
See Also: AudioSystem#NOT_SPECIFIED

loop back to summary

loop	back to summary
public void loop(int count) Starts looping playback from the current position. Playback will continue to the loop's end point, then loop back to the loop start point `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. Parameters count:int 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

public void loop(int count)

Starts looping playback from the current position. Playback will continue to the loop's end point, then loop back to the loop start point 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.

Parameters

count:int: 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

open back to summary

open	back to summary
public void open(AudioFormat format, byte[] data, int offset, int bufferSize) throws LineUnavailableException Opens the clip, meaning that it should acquire any required system resources and become operational. The clip is opened with the format and audio data indicated. If this operation succeeds, the line is marked as open and an `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`. Parameters format:AudioFormat the format of the supplied audio data data:byte[] a byte array containing audio data to load into the clip offset:int the point at which to start copying, expressed in bytes from the beginning of the array bufferSize:int the number of bytes of data to load into the clip from the array Exceptions LineUnavailableException: if the line cannot be opened due to resource restrictions IllegalArgumentException: if the buffer size does not represent an integral number of sample frames, or if `format` is not fully specified or invalid IllegalStateException: if the line is already open See Also `close`, `isOpen`, `LineListener`

public void open(AudioFormat format, byte[] data, int offset, int bufferSize) throws LineUnavailableException

Opens the clip, meaning that it should acquire any required system resources and become operational. The clip is opened with the format and audio data indicated. If this operation succeeds, the line is marked as open and an 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.

Parameters

format:AudioFormat: the format of the supplied audio data
data:byte[]: a byte array containing audio data to load into the clip
offset:int: the point at which to start copying, expressed in bytes from the beginning of the array
bufferSize:int: the number of bytes of data to load into the clip from the array

Exceptions

LineUnavailableException:: if the line cannot be opened due to resource restrictions
IllegalArgumentException:: if the buffer size does not represent an integral number of sample frames, or if format is not fully specified or invalid
IllegalStateException:: if the line is already open

See Also

close, isOpen, LineListener

open back to summary

open	back to summary
public void open(AudioInputStream stream) throws LineUnavailableException, IOException Opens the clip with the format and audio data present in the provided audio input stream. Opening a clip means that it should acquire any required system resources and become operational. If this operation input stream. If this operation succeeds, the line is marked open and an `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`. Parameters stream:AudioInputStream an audio input stream from which audio data will be read into the clip Exceptions LineUnavailableException: if the line cannot be opened due to resource restrictions IOException: if an I/O exception occurs during reading of the stream IllegalArgumentException: if the stream's audio format is not fully specified or invalid IllegalStateException: if the line is already open See Also `close`, `isOpen`, `LineListener`

public void open(AudioInputStream stream) throws LineUnavailableException, IOException

Opens the clip with the format and audio data present in the provided audio input stream. Opening a clip means that it should acquire any required system resources and become operational. If this operation input stream. If this operation succeeds, the line is marked open and an 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.

Parameters

stream:AudioInputStream: an audio input stream from which audio data will be read into the clip

Exceptions

LineUnavailableException:: if the line cannot be opened due to resource restrictions
IOException:: if an I/O exception occurs during reading of the stream
IllegalArgumentException:: if the stream's audio format is not fully specified or invalid
IllegalStateException:: if the line is already open

See Also

close, isOpen, LineListener

setFramePosition back to summary

setFramePosition	back to summary
public void setFramePosition(int frames) Sets the media position in sample frames. The position is zero-based; the first frame is frame number zero. When the clip begins playing the next time, it will start by playing the frame at this position. To obtain the current position in sample frames, use the `getFramePosition` method of `DataLine`. Parameters frames:int the desired new media position, expressed in sample frames

public void setFramePosition(int frames)

Sets the media position in sample frames. The position is zero-based; the first frame is frame number zero. When the clip begins playing the next time, it will start by playing the frame at this position.

To obtain the current position in sample frames, use the getFramePosition method of DataLine.

Parameters

frames:int: the desired new media position, expressed in sample frames

setLoopPoints	back to summary
public void setLoopPoints(int start, int end) Sets the first and last sample frames that will be played in the loop. The ending point must be greater than or equal to the starting point, and both must fall within the size of the loaded media. A value of 0 for the starting point means the beginning of the loaded media. Similarly, a value of -1 for the ending point indicates the last frame of the media. Parameters start:int the loop's starting position, in sample frames (zero-based) end:int the loop's ending position, in sample frames (zero-based), or -1 to indicate the final frame Exceptions IllegalArgumentException: 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 point

setLoopPoints

back to summary

public void setLoopPoints(int start, int end)

Sets the first and last sample frames that will be played in the loop. The ending point must be greater than or equal to the starting point, and both must fall within the size of the loaded media. A value of 0 for the starting point means the beginning of the loaded media. Similarly, a value of -1 for the ending point indicates the last frame of the media.

Parameters

start:int: the loop's starting position, in sample frames (zero-based)
end:int: the loop's ending position, in sample frames (zero-based), or -1 to indicate the final frame

Exceptions

IllegalArgumentException:: 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 point

setMicrosecondPosition back to summary

setMicrosecondPosition	back to summary
public void setMicrosecondPosition(long microseconds) Sets the media position in microseconds. When the clip begins playing the next time, it will start at this position. The level of precision is not guaranteed. For example, an implementation might calculate the microsecond position from the current frame position and the audio sample frame rate. The precision in microseconds would then be limited to the number of microseconds per sample frame. To obtain the current position in microseconds, use the `getMicrosecondPosition` method of `DataLine`. Parameters microseconds:long the desired new media position, expressed in microseconds

public void setMicrosecondPosition(long microseconds)

Sets the media position in microseconds. When the clip begins playing the next time, it will start at this position. The level of precision is not guaranteed. For example, an implementation might calculate the microsecond position from the current frame position and the audio sample frame rate. The precision in microseconds would then be limited to the number of microseconds per sample frame.

To obtain the current position in microseconds, use the getMicrosecondPosition method of DataLine.

Parameters

microseconds:long: the desired new media position, expressed in microseconds

public Interface Clip

Field Summary

Method Summary

Field Detail

Method Detail