File	Doc	Category	Size	Date	Package
Sequencer.java	API Doc	Java SE 5 API	29831	Fri Aug 26 14:57:50 BST 2005	javax.sound.midi

Sequencer

Fields Summary
public static final int	LOOP_CONTINUOUSLY A value indicating that looping should continue indefinitely rather than complete after a specific number of loops.

Constructors Summary

Methods Summary
public int[]	addControllerEventListener(javax.sound.midi.ControllerEventListener listener, int[] controllers) Registers a controller event listener to receive notification whenever the sequencer processes a control-change event of the requested type or types. The types are specified by the controllers argument, which should contain an array of MIDI controller numbers. (Each number should be between 0 and 127, inclusive. See the MIDI 1.0 Specification for the numbers that correspond to various types of controllers.) The returned array contains the MIDI controller numbers for which the listener will now receive events. Some sequencers might not support controller event notification, in which case the array has a length of 0. Other sequencers might support notification for some controllers but not all. This method may be invoked repeatedly. Each time, the returned array indicates all the controllers that the listener will be notified about, not only the controllers requested in that particular invocation. param listener the controller event listener to add to the list of registered listeners param controllers the MIDI controller numbers for which change notification is requested return the numbers of all the MIDI controllers whose changes will now be reported to the specified listener see #removeControllerEventListener see ControllerEventListener
public boolean	addMetaEventListener(javax.sound.midi.MetaEventListener listener) Registers a meta-event listener to receive notification whenever a meta-event is encountered in the sequence and processed by the sequencer. This method can fail if, for instance,this class of sequencer does not support meta-event notification. param listener listener to add return true if the listener was successfully added, otherwise false see #removeMetaEventListener see MetaEventListener see MetaMessage
public int	getLoopCount() Obtains the number of repetitions for playback. return the number of loops after which playback plays to the end of the sequence see #setLoopCount see #start since 1.5
public long	getLoopEndPoint() Obtains the end position of the loop, in MIDI ticks. return the end position of the loop, in MIDI ticks (zero-based), or -1 to indicate the end of the sequence see #setLoopEndPoint since 1.5
public long	getLoopStartPoint() Obtains the start position of the loop, in MIDI ticks. return the start position of the loop, in MIDI ticks (zero-based) see #setLoopStartPoint since 1.5
public javax.sound.midi.Sequencer$SyncMode	getMasterSyncMode() Obtains the current master synchronization mode for this sequencer. return the current master synchronization mode see #setMasterSyncMode(Sequencer.SyncMode) see #getMasterSyncModes
public javax.sound.midi.Sequencer$SyncMode[]	getMasterSyncModes() Obtains the set of master synchronization modes supported by this sequencer. return the available master synchronization modes see SyncMode#INTERNAL_CLOCK see SyncMode#MIDI_SYNC see SyncMode#MIDI_TIME_CODE see #getMasterSyncMode see #setMasterSyncMode(Sequencer.SyncMode)
public long	getMicrosecondLength() Obtains the length of the current sequence, expressed in microseconds, or 0 if no sequence is set. return length of the sequence in microseconds.
public long	getMicrosecondPosition() Obtains the current position in the sequence, expressed in microseconds. return the current position in microseconds see #setMicrosecondPosition
public javax.sound.midi.Sequence	getSequence() Obtains the sequence on which the Sequencer is currently operating. This method can be called even if the Sequencer is closed. return the current sequence, or null if no sequence is currently set.
public javax.sound.midi.Sequencer$SyncMode	getSlaveSyncMode() Obtains the current slave synchronization mode for this sequencer. return the current slave synchronization mode see #setSlaveSyncMode(Sequencer.SyncMode) see #getSlaveSyncModes
public javax.sound.midi.Sequencer$SyncMode[]	getSlaveSyncModes() Obtains the set of slave synchronization modes supported by the sequencer. return the available slave synchronization modes see SyncMode#MIDI_SYNC see SyncMode#MIDI_TIME_CODE see SyncMode#NO_SYNC
public float	getTempoFactor() Returns the current tempo factor for the sequencer. The default is 1.0. return tempo factor. see #setTempoFactor(float)
public float	getTempoInBPM() Obtains the current tempo, expressed in beats per minute. The actual tempo of playback is the product of the returned value and the tempo factor. return the current tempo in beats per minute see #getTempoFactor see #setTempoInBPM(float) see #getTempoInMPQ
public float	getTempoInMPQ() Obtains the current tempo, expressed in microseconds per quarter note. The actual tempo of playback is the product of the returned value and the tempo factor. return the current tempo in microseconds per quarter note see #getTempoFactor see #setTempoInMPQ(float) see #getTempoInBPM
public long	getTickLength() Obtains the length of the current sequence, expressed in MIDI ticks, or 0 if no sequence is set. return length of the sequence in ticks
public long	getTickPosition() Obtains the current position in the sequence, expressed in MIDI ticks. (The duration of a tick in seconds is determined both by the tempo and by the timing resolution stored in the {@link Sequence}.) return current tick see #setTickPosition
public boolean	getTrackMute(int track) Obtains the current mute state for a track. The default mute state for all tracks which have not been muted is false. In any case where the specified track has not been muted, this method should return false. This applies if the sequencer does not support muting of tracks, and if the specified track index is not valid. param track the track number. Tracks in the current sequence are numbered from 0 to the number of tracks in the sequence minus 1. return true if muted, false if not.
public boolean	getTrackSolo(int track) Obtains the current solo state for a track. The default mute state for all tracks which have not been solo'd is false. In any case where the specified track has not been solo'd, this method should return false. This applies if the sequencer does not support soloing of tracks, and if the specified track index is not valid. param track the track number. Tracks in the current sequence are numbered from 0 to the number of tracks in the sequence minus 1. return true if solo'd, false if not.
public boolean	isRecording() Indicates whether the Sequencer is currently recording. The default is false. The Sequencer begins recording when {@link #startRecording} is called, and then returns true until {@link #stop} or {@link #stopRecording} is called. return true if the Sequencer is recording, otherwise false
public boolean	isRunning() Indicates whether the Sequencer is currently running. The default is false. The Sequencer starts running when either {@link #start} or {@link #startRecording} is called. isRunning then returns true until playback of the sequence completes or {@link #stop} is called. return true if the Sequencer is running, otherwise false
public void	recordDisable(javax.sound.midi.Track track) Disables recording to the specified track. Events will no longer be recorded into this track. param track the track to disable for recording, or null to disable recording for all tracks.
public void	recordEnable(javax.sound.midi.Track track, int channel) Prepares the specified track for recording events received on a particular channel. Once enabled, a track will receive events when recording is active. param track the track to which events will be recorded param channel the channel on which events will be received. If -1 is specified for the channel value, the track will receive data from all channels. throws IllegalArgumentException thrown if the track is not part of the current sequence.
public int[]	removeControllerEventListener(javax.sound.midi.ControllerEventListener listener, int[] controllers) Removes a controller event listener's interest in one or more types of controller event. The controllers argument is an array of MIDI numbers corresponding to the controllers for which the listener should no longer receive change notifications. To completely remove this listener from the list of registered listeners, pass in null for controllers. The returned array contains the MIDI controller numbers for which the listener will now receive events. The array has a length of 0 if the listener will not receive change notifications for any controllers. param listener old listener param controllers the MIDI controller numbers for which change notification should be cancelled, or null to cancel for all controllers return the numbers of all the MIDI controllers whose changes will now be reported to the specified listener see #addControllerEventListener
public void	removeMetaEventListener(javax.sound.midi.MetaEventListener listener) Removes the specified meta-event listener from this sequencer's list of registered listeners, if in fact the listener is registered. param listener the meta-event listener to remove see #addMetaEventListener
public void	setLoopCount(int count) Sets the number of repetitions of the loop for playback. When the playback position reaches the loop end point, it will loop back to the loop start point count times, after which playback will continue to play to the end of the sequence. If the current position when this method is invoked is greater than the loop end point, playback continues to the end of the sequence without looping, unless the loop end point is changed subsequently. A count value of 0 disables looping: playback will continue at the loop end point, and it will not loop back to the loop start point. This is a sequencer's default. If playback is stopped during looping, the current loop status is cleared; subsequent start requests are not affected by an interrupted loop operation. param count the number of times playback should loop back from the loop's end position to the loop's start position, or {@link #LOOP_CONTINUOUSLY} to indicate that looping should continue until interrupted throws IllegalArgumentException if count is negative and not equal to {@link #LOOP_CONTINUOUSLY} see #setLoopStartPoint see #setLoopEndPoint see #getLoopCount see #start since 1.5
public void	setLoopEndPoint(long tick) Sets the last MIDI tick that will be played in the loop. If the loop count is 0, the loop end point has no effect and playback continues to play when reaching the loop end point. A value of -1 for the ending point indicates the last tick of the sequence. Otherwise, the ending point must be greater than or equal to the starting point, and it must fall within the size of the loaded sequence. A sequencer's loop end point defaults to -1, meaning the end of the sequence. param tick the loop's ending position, in MIDI ticks (zero-based), or -1 to indicate the final tick throws IllegalArgumentException if the requested loop point cannot be set, usually because it falls outside the sequence's duration or because the ending point is before the starting point see #setLoopStartPoint see #setLoopCount see #getLoopEndPoint see #start since 1.5
public void	setLoopStartPoint(long tick) Sets the first MIDI tick that will be played in the loop. If the loop count is greater than 0, playback will jump to this point when reaching the loop end point. A value of 0 for the starting point means the beginning of the loaded sequence. The starting point must be lower than or equal to the ending point, and it must fall within the size of the loaded sequence. A sequencer's loop start point defaults to start of the sequence. param tick the loop's starting position, in MIDI ticks (zero-based) throws IllegalArgumentException if the requested loop start point cannot be set, usually because it falls outside the sequence's duration or because the start point is after the end point see #setLoopEndPoint see #setLoopCount see #getLoopStartPoint see #start since 1.5
public void	setMasterSyncMode(javax.sound.midi.Sequencer$SyncMode sync) Sets the source of timing information used by this sequencer. The sequencer synchronizes to the master, which is the internal clock, MIDI clock, or MIDI time code, depending on the value of sync. The sync argument must be one of the supported modes, as returned by {@link #getMasterSyncModes}. param sync the desired master synchronization mode see SyncMode#INTERNAL_CLOCK see SyncMode#MIDI_SYNC see SyncMode#MIDI_TIME_CODE see #getMasterSyncMode
public void	setMicrosecondPosition(long microseconds) Sets the current position in the sequence, expressed in microseconds param microseconds desired position in microseconds see #getMicrosecondPosition
public void	setSequence(javax.sound.midi.Sequence sequence) Sets the current sequence on which the sequencer operates. This method can be called even if the Sequencer is closed. param sequence the sequence to be loaded. throws InvalidMidiDataException if the sequence contains invalid MIDI data, or is not supported.
public void	setSequence(java.io.InputStream stream) Sets the current sequence on which the sequencer operates. The stream must point to MIDI file data. This method can be called even if the Sequencer is closed. param stream stream containing MIDI file data. throws IOException if an I/O exception occurs during reading of the stream. throws InvalidMidiDataException if invalid data is encountered in the stream, or the stream is not supported.
public void	setSlaveSyncMode(javax.sound.midi.Sequencer$SyncMode sync) Sets the slave synchronization mode for the sequencer. This indicates the type of timing information sent by the sequencer to its receiver. The sync argument must be one of the supported modes, as returned by {@link #getSlaveSyncModes}. param sync the desired slave synchronization mode see SyncMode#MIDI_SYNC see SyncMode#MIDI_TIME_CODE see SyncMode#NO_SYNC see #getSlaveSyncModes
public void	setTempoFactor(float factor) Scales the sequencer's actual playback tempo by the factor provided. The default is 1.0. A value of 1.0 represents the natural rate (the tempo specified in the sequence), 2.0 means twice as fast, etc. The tempo factor does not affect the values returned by {@link #getTempoInMPQ} and {@link #getTempoInBPM}. Those values indicate the tempo prior to scaling. Note that the tempo factor cannot be adjusted when external synchronization is used. In that situation, setTempoFactor always sets the tempo factor to 1.0. param factor the requested tempo scalar see #getTempoFactor
public void	setTempoInBPM(float bpm) Sets the tempo in beats per minute. The actual tempo of playback is the product of the specified value and the tempo factor. param bpm desired new tempo in beats per minute see #getTempoFactor see #setTempoInMPQ(float) see #getTempoInBPM
public void	setTempoInMPQ(float mpq) Sets the tempo in microseconds per quarter note. The actual tempo of playback is the product of the specified value and the tempo factor. param mpq desired new tempo in microseconds per quarter note. see #getTempoFactor see #setTempoInBPM(float) see #getTempoInMPQ
public void	setTickPosition(long tick) Sets the current sequencer position in MIDI ticks param tick the desired tick position see #getTickPosition
public void	setTrackMute(int track, boolean mute) Sets the mute state for a track. This method may fail for a number of reasons. For example, the track number specified may not be valid for the current sequence, or the sequencer may not support this functionality. An application which needs to verify whether this operation succeeded should follow this call with a call to {@link #getTrackMute}. param track the track number. Tracks in the current sequence are numbered from 0 to the number of tracks in the sequence minus 1. param mute the new mute state for the track. true implies the track should be muted, false implies the track should be unmuted. see #getSequence
public void	setTrackSolo(int track, boolean solo) Sets the solo state for a track. If solo is true only this track and other solo'd tracks will sound. If solo is false then only other solo'd tracks will sound, unless no tracks are solo'd in which case all un-muted tracks will sound. This method may fail for a number of reasons. For example, the track number specified may not be valid for the current sequence, or the sequencer may not support this functionality. An application which needs to verify whether this operation succeeded should follow this call with a call to {@link #getTrackSolo}. param track the track number. Tracks in the current sequence are numbered from 0 to the number of tracks in the sequence minus 1. param solo the new solo state for the track. true implies the track should be solo'd, false implies the track should not be solo'd. see #getSequence
public void	start() Starts playback of the MIDI data in the currently loaded sequence. Playback will begin from the current position. If the playback position reaches the loop end point, and the loop count is greater than 0, playback will resume at the loop start point for the number of repetitions set with setLoopCount. After that, or if the loop count is 0, playback will continue to play to the end of the sequence. The implementation ensures that the synthesizer is brought to a consistent state when jumping to the loop start point by sending appropriate controllers, pitch bend, and program change events. throws IllegalStateException if the Sequencer is closed. see #setLoopStartPoint see #setLoopEndPoint see #setLoopCount see #stop
public void	startRecording() Starts recording and playback of MIDI data. Data is recorded to all enabled tracks, on the channel(s) for which they were enabled. Recording begins at the current position of the sequencer. Any events already in the track are overwritten for the duration of the recording session. Events from the currently loaded sequence, if any, are delivered to the sequencer's transmitter(s) along with messages received during recording. Note that tracks are not by default enabled for recording. In order to record MIDI data, at least one track must be specifically enabled for recording. throws IllegalStateException if the Sequencer is closed. see #startRecording see #recordEnable see #recordDisable
public void	stop() Stops recording, if active, and playback of the currently loaded sequence, if any. throws IllegalStateException if the Sequencer is closed. see #start see #isRunning
public void	stopRecording() Stops recording, if active. Playback of the current sequence continues. throws IllegalStateException if the Sequencer is closed. see #startRecording see #isRecording