jp.kshoji.javax.sound.midi

Interface Sequencer

All Superinterfaces:

MidiDevice

All Known Implementing Classes:

SequencerImpl

public interface Sequencer
extends MidiDevice

Interface for MIDI Sequencer

Author:

K.Shoji

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Sequencer.SyncMode Sequencer's Synchronization mode

Nested classes/interfaces inherited from interface jp.kshoji.javax.sound.midi.MidiDevice

MidiDevice.Info

Field Summary

Fields

Modifier and Type	Field and Description
static int	LOOP_CONTINUOUSLY Loop eternally.

Method Summary

Modifier and Type	Method and Description
int[]	addControllerEventListener(ControllerEventListener listener, int[] controllers) Add EventListener for ShortMessage.CONTROL_CHANGE
boolean	addMetaEventListener(MetaEventListener listener) Add EventListener for MetaMessage
int	getLoopCount() Get the count of loop.
long	getLoopEndPoint() Get the end point(ticks) of loop.
long	getLoopStartPoint() Get start point(ticks) of loop.
Sequencer.SyncMode	getMasterSyncMode() Get the Sequencer.SyncMode for master.
Sequencer.SyncMode[]	getMasterSyncModes() Get the available Sequencer.SyncMode for master.
long	getMicrosecondLength() Get the Sequence length in microseconds.
long	getMicrosecondPosition() Get the current microsecond position.
Sequence	getSequence() Get the Sequence
Sequencer.SyncMode	getSlaveSyncMode() Get the Sequencer.SyncMode for slave.
Sequencer.SyncMode[]	getSlaveSyncModes() Get the available Sequencer.SyncMode for slave.
float	getTempoFactor() Get the tempo factor.
float	getTempoInBPM() Get the tempo in the Beats per minute.
float	getTempoInMPQ() Get the tempos in the microseconds per quarter note.
long	getTickLength() Get the Sequence length in ticks.
long	getTickPosition() Get the current tick position.
boolean	getTrackMute(int track) Get if the track is mute on the playback.
boolean	getTrackSolo(int track) Get if the track is solo on the playback.
boolean	isRecording() Get if the Sequencer is recording.
boolean	isRunning() Get if the Sequencer is playing OR recording.
void	recordDisable(Track track) Set the Track to disable recording
void	recordEnable(Track track, int channel) Set the Track to enable recording on the specified channel.
int[]	removeControllerEventListener(ControllerEventListener listener, int[] controllers) Remove EventListener for ShortMessage.CONTROL_CHANGE
void	removeMetaEventListener(MetaEventListener listener) Remove EventListener for MetaMessage
void	setLoopCount(int count) Set count of loop.
void	setLoopEndPoint(long tick) Set end point(ticks) of loop.
void	setLoopStartPoint(long tick) Set start point(ticks) of loop.
void	setMasterSyncMode(Sequencer.SyncMode sync) Set the Sequencer.SyncMode for master.
void	setMicrosecondPosition(long microseconds) Set the current microsecond position.
void	setSequence(InputStream stream) Load a Sequence from stream.
void	setSequence(Sequence sequence) Set the Sequence for the Sequencer
void	setSlaveSyncMode(Sequencer.SyncMode sync) Set the Sequencer.SyncMode for slave.
void	setTempoFactor(float factor) Set the tempo factor.
void	setTempoInBPM(float bpm) Set the tempo in the Beats per minute.
void	setTempoInMPQ(float mpq) Set the tempos in the microseconds per quarter note.
void	setTickPosition(long tick) Set the current tick position.
void	setTrackMute(int track, boolean mute) Set the track to mute on the playback.
void	setTrackSolo(int track, boolean solo) Set track to solo on the playback.
void	start() Start playing (starting at current sequencer position)
void	startRecording() Start recording (starting at current sequencer position)
void	stop() Stop playing AND recording.
void	stopRecording() Stop recording.

Methods inherited from interface jp.kshoji.javax.sound.midi.MidiDevice

close, getDeviceInfo, getMaxReceivers, getMaxTransmitters, getReceiver, getReceivers, getTransmitter, getTransmitters, isOpen, open

Field Detail

LOOP_CONTINUOUSLY

static final int LOOP_CONTINUOUSLY

Loop eternally.

See Also:

setLoopCount(int), Constant Field Values

Method Detail

getMasterSyncModes

@NonNull
Sequencer.SyncMode[] getMasterSyncModes()

Get the available Sequencer.SyncMode for master.

Returns:

the available Sequencer.SyncMode for master.

getMasterSyncMode

@NonNull
Sequencer.SyncMode getMasterSyncMode()

Get the Sequencer.SyncMode for master.

Returns:

the Sequencer.SyncMode for master.

setMasterSyncMode

void setMasterSyncMode(@NonNull
                       Sequencer.SyncMode sync)

Set the Sequencer.SyncMode for master.

Parameters:

sync - the Sequencer.SyncMode for master.

getSlaveSyncModes

@NonNull
Sequencer.SyncMode[] getSlaveSyncModes()

Get the available Sequencer.SyncMode for slave.

Returns:

the available Sequencer.SyncMode for slave.

getSlaveSyncMode

@NonNull
Sequencer.SyncMode getSlaveSyncMode()

Get the Sequencer.SyncMode for slave.

Returns:

the Sequencer.SyncMode for slave.

setSlaveSyncMode

void setSlaveSyncMode(@NonNull
                      Sequencer.SyncMode sync)

Set the Sequencer.SyncMode for slave.

Parameters:

sync - the Sequencer.SyncMode for slave.

getSequence

@Nullable
Sequence getSequence()

Get the Sequence

Returns:

the Sequence

setSequence

void setSequence(@NonNull
                 InputStream stream)
          throws IOException,
                 InvalidMidiDataException

Load a Sequence from stream.

Parameters:

stream - sequence source

Throws:

IOException

InvalidMidiDataException

setSequence

void setSequence(@Nullable
                 Sequence sequence)
          throws InvalidMidiDataException

Set the Sequence for the Sequencer

Parameters:

sequence - the Sequence

Throws:

InvalidMidiDataException

addControllerEventListener

@NonNull
int[] addControllerEventListener(@NonNull
                                           ControllerEventListener listener,
                                           @NonNull
                                           int[] controllers)

Add EventListener for ShortMessage.CONTROL_CHANGE

Parameters:

listener - event listener

controllers - controller codes

Returns:

int[] registered controllers for the specified listener

removeControllerEventListener

@NonNull
int[] removeControllerEventListener(@NonNull
                                              ControllerEventListener listener,
                                              @NonNull
                                              int[] controllers)

Remove EventListener for ShortMessage.CONTROL_CHANGE

Parameters:

listener - event listener

controllers - controller codes

Returns:

int[] registered controllers for the specified listener

addMetaEventListener

boolean addMetaEventListener(@NonNull
                             MetaEventListener listener)

Add EventListener for MetaMessage

Parameters:

listener - event listener

Returns:

true if registered successfully

removeMetaEventListener

void removeMetaEventListener(@NonNull
                             MetaEventListener listener)

Remove EventListener for MetaMessage

Parameters:

listener - event listener

isRecording

boolean isRecording()

Get if the Sequencer is recording.

Returns:

true if the Sequencer is recording

isRunning

boolean isRunning()

Get if the Sequencer is playing OR recording.

Returns:

true if the Sequencer is playing OR recording

recordDisable

void recordDisable(@Nullable
                   Track track)

Set the Track to disable recording

Parameters:

track - the Track to disable recording

recordEnable

void recordEnable(@NonNull
                  Track track,
                  int channel)

Set the Track to enable recording on the specified channel.

Parameters:

track - the Track

channel - the channel, 0-15

getLoopCount

int getLoopCount()

Get the count of loop.

Returns:

the count of loop

• LOOP_CONTINUOUSLY: play loops eternally
• 0: play once(no loop)
• 1: play twice(loop once)

setLoopCount

void setLoopCount(int count)

Set count of loop.

Parameters:

count -

• LOOP_CONTINUOUSLY: play loops eternally
• 0: play once(no loop)
• 1: play twice(loop once)

getLoopStartPoint

long getLoopStartPoint()

Get start point(ticks) of loop.

Returns:

ticks

setLoopStartPoint

void setLoopStartPoint(long tick)

Set start point(ticks) of loop.

Parameters:

tick - 0: start of Sequence

getLoopEndPoint

long getLoopEndPoint()

Get the end point(ticks) of loop.

Returns:

the end point(ticks) of loop

setLoopEndPoint

void setLoopEndPoint(long tick)

Set end point(ticks) of loop.

Parameters:

tick - -1: end of Sequence

getTempoFactor

float getTempoFactor()

Get the tempo factor.

Returns:

the tempo factor

setTempoFactor

void setTempoFactor(float factor)

Set the tempo factor. This method don't change Sequence's tempo.

Parameters:

factor -

• 1.0f : the normal tempo
• 0.5f : half slow tempo
• 2.0f : 2x fast tempo

getTempoInBPM

float getTempoInBPM()

Get the tempo in the Beats per minute.

Returns:

the tempo in the Beats per minute.

setTempoInBPM

void setTempoInBPM(float bpm)

Set the tempo in the Beats per minute.

Parameters:

bpm - the tempo in the Beats per minute

getTempoInMPQ

float getTempoInMPQ()

Get the tempos in the microseconds per quarter note.

Returns:

the tempos in the microseconds per quarter note

setTempoInMPQ

void setTempoInMPQ(float mpq)

Set the tempos in the microseconds per quarter note.

Parameters:

mpq - the tempos in the microseconds per quarter note

getTickLength

long getTickLength()

Get the Sequence length in ticks.

Returns:

the Sequence length in ticks

getMicrosecondLength

long getMicrosecondLength()

Get the Sequence length in microseconds.

Returns:

the Sequence length in microseconds

getTickPosition

long getTickPosition()

Get the current tick position.

Returns:

the current tick position

setTickPosition

void setTickPosition(long tick)

Set the current tick position.

Parameters:

tick - the current tick position

getMicrosecondPosition

long getMicrosecondPosition()

Get the current microsecond position.

Specified by:

getMicrosecondPosition in interface MidiDevice

Returns:

-1 if the timeStamp not supported.

setMicrosecondPosition

void setMicrosecondPosition(long microseconds)

Set the current microsecond position.

Parameters:

microseconds - the current microsecond position

getTrackMute

boolean getTrackMute(int track)

Get if the track is mute on the playback.

Parameters:

track - the track number

Returns:

true if the track is mute on the playback

setTrackMute

void setTrackMute(int track,
                  boolean mute)

Set the track to mute on the playback.

Parameters:

track - the track number

mute - true to set mute the track

getTrackSolo

boolean getTrackSolo(int track)

Get if the track is solo on the playback.

Parameters:

track - the track number

Returns:

true if the track is solo on the playback.

setTrackSolo

void setTrackSolo(int track,
                  boolean solo)

Set track to solo on the playback.

Parameters:

track - the track number

solo - true to set solo the track

start

void start()

Start playing (starting at current sequencer position)

startRecording

void startRecording()

Start recording (starting at current sequencer position)

Current Sequence's events are sent to the all Transmitter. Received events art also sent to the all Transmitter.

stop

void stop()

Stop playing AND recording.

stopRecording

void stopRecording()

Stop recording. Playing continues.