|
JSampler v0.8a |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface SamplerModel
A data model representing a sampler. Note that the setter methods does not alter any settings on the backend side unless otherwise specified.
| Method Summary | |
|---|---|
void |
addAudioDevice(AudioOutputDevice device)
Adds the specified audio device. |
void |
addAudioDeviceListListener(ListListener<AudioDeviceModel> listener)
Registers the specified listener for receiving event messages. |
void |
addBackendChannel()
Adds a new sampler channel on the backend side. |
void |
addBackendMidiDevice(java.lang.String driver,
Parameter... parameters)
Schedules a new task for adding new MIDI device. |
void |
addBackendMidiInstrumentMap(java.lang.String name)
Schedules a new task for creating a new MIDI instrument map on the backend side. |
void |
addChannel(SamplerChannel channel)
Adds the specified sampler channel. |
void |
addMidiDevice(MidiInputDevice device)
Adds the specified MIDI device. |
void |
addMidiDeviceListListener(MidiDeviceListListener listener)
Registers the specified listener for receiving event messages. |
void |
addMidiInstrumentMap(MidiInstrumentMap map)
Adds the specified MIDI instrument map. |
void |
addMidiInstrumentMapListListener(ListListener<MidiInstrumentMap> listener)
Registers the specified listener for receiving event messages. |
void |
addSamplerChannelListListener(SamplerChannelListListener listener)
Registers the specified listener for receiving event messages. |
void |
addSamplerListener(SamplerListener l)
Registers the specified listener for receiving event messages. |
void |
editBackendInstrument(int channelId)
Schedules a new task for starting an instrument editor for editing the loaded instrument on the specified sampler channel. |
AudioDeviceModel |
getAudioDevice(int index)
Gets the model of the audio device at the specified position. |
AudioDeviceModel |
getAudioDeviceById(int deviceId)
Gets the model of the audio device with ID deviceId. |
int |
getAudioDeviceCount()
Gets the current number of audio devices. |
AudioDeviceModel[] |
getAudioDevices()
Gets the current list of audio device models. |
AudioOutputDriver[] |
getAudioOutputDrivers()
Gets all audio output drivers currently available for the LinuxSampler instance. |
SamplerChannelModel |
getChannel(int index)
Gets the model of the sampler channel in the specified position. |
SamplerChannelModel |
getChannelById(int channelId)
Gets the model of the sampler channel with ID channelId. |
int |
getChannelCount()
Gets the current number of sampler channels. |
SamplerChannelModel[] |
getChannels()
Gets the current list of sampler channel models. |
MidiInstrumentMap |
getDefaultMidiInstrumentMap()
Gets the default MIDI instrument map. |
SamplerEngine[] |
getEngines()
Gets a list of all available engines. |
MidiDeviceModel |
getMidiDevice(int index)
Gets the model of the MIDI device at the specified position. |
MidiDeviceModel |
getMidiDeviceById(int deviceId)
Gets the model of the MIDI device with ID deviceId. |
int |
getMidiDeviceCount()
Gets the current number of MIDI input devices. |
MidiDeviceModel[] |
getMidiDevices()
Gets the current list of MIDI device models. |
MidiInputDriver[] |
getMidiInputDrivers()
Gets all MIDI input drivers currently available for the LinuxSampler instance. |
MidiInstrumentMap |
getMidiInstrumentMap(int index)
Gets the MIDI instrument map at the specified position. |
MidiInstrumentMap |
getMidiInstrumentMapById(int mapId)
Gets the MIDI instrument map with ID mapId. |
int |
getMidiInstrumentMapCount()
Gets the current number of MIDI instrument maps. |
int |
getMidiInstrumentMapIndex(MidiInstrumentMap map)
Gets the position of the specified MIDI instrument map in the list. |
MidiInstrumentMap[] |
getMidiInstrumentMaps()
Gets the current list of MIDI instrument maps. |
int |
getMutedBySoloChannelCount()
Gets the number of channels muted because of the presence of a solo channel. |
int |
getMutedChannelCount()
Gets the number of muted channels in the current list of sampler channels. |
ServerInfo |
getServerInfo()
Gets information about the LinuxSampler instance the front-end is connected to. |
int |
getSoloChannelCount()
Gets the number of solo channels in the current list of sampler channels. |
int |
getTotalStreamCount()
Gets the total number of active streams. |
int |
getTotalVoiceCount()
Gets the total number of active voices. |
int |
getTotalVoiceCountMax()
Gets the maximum number of active voices. |
float |
getVolume()
Gets the golobal volume of the sampler. |
boolean |
hasSoloChannel()
Determines whether there is at least one solo channel in the current list of sampler channels. |
boolean |
isModified()
Determines whether the sampler configuration is modified. |
void |
mapBackendMidiInstrument(int mapId,
int bank,
int program,
MidiInstrumentInfo instrInfo)
Schedules a new task for mapping a MIDI instrument on the backend side. |
void |
removeAllMidiInstrumentMaps()
Removes all MIDI instrument maps. |
boolean |
removeAudioDeviceById(int deviceId)
Removes the specified audio device. |
void |
removeAudioDeviceListListener(ListListener<AudioDeviceModel> listener)
Removes the specified listener. |
void |
removeBackendAudioDevice(int deviceId)
Removes (on the backend side) the specified audio device. |
void |
removeBackendChannel(int channelId)
Schedules a new task for removing the specified sampler channel on the backend side. |
void |
removeBackendMidiDevice(int deviceId)
Schedules a new task for removing the specified MIDI device. |
void |
removeBackendMidiInstrumentMap(int mapId)
Schedules a new task for removing the specified MIDI instrument map on the backend side. |
boolean |
removeChannelById(int channelId)
Removes the specified sampler channel. |
boolean |
removeMidiDeviceById(int deviceId)
Removes the specified MIDI device. |
void |
removeMidiDeviceListListener(MidiDeviceListListener listener)
Removes the specified listener. |
boolean |
removeMidiInstrumentMapById(int mapId)
Removes the specified MIDI instrument map. |
void |
removeMidiInstrumentMapListListener(ListListener<MidiInstrumentMap> listener)
Removes the specified listener. |
void |
removeSamplerChannelListListener(SamplerChannelListListener listener)
Removes the specified listener. |
void |
removeSamplerListener(SamplerListener l)
Removes the specified listener. |
void |
resetBackend()
Schedules a new task for resetting the sampler. |
void |
setBackendMidiInstrumentMapName(int mapId,
java.lang.String name)
Schedules a new task for changing the name of the specified MIDI instrument map on the backend side. |
void |
setBackendVolume(float volume)
Sets the global volume on the backend side. |
void |
setModified(boolean b)
Sets whether the sampler configuration is modified. |
void |
setVolume(float volume)
Sets the global volume. |
void |
unmapBackendMidiInstrument(int mapId,
int bank,
int program)
Schedules a new task for removing a MIDI instrument on the backend side. |
void |
updateActiveStreamsInfo(int count)
Updates the current number of active disk streams in the sampler. |
void |
updateActiveVoiceInfo(int count,
int countMax)
Updates the current and the maximum number of active voices in the sampler. |
void |
updateChannel(SamplerChannel channel)
Updates the settings of the specified channel. |
| Method Detail |
|---|
void addSamplerListener(SamplerListener l)
l - The SamplerListener to register.void removeSamplerListener(SamplerListener l)
l - The SamplerListener to remove.void addAudioDeviceListListener(ListListener<AudioDeviceModel> listener)
listener - The ListListener to register.void removeAudioDeviceListListener(ListListener<AudioDeviceModel> listener)
listener - The ListListener to remove.void addMidiDeviceListListener(MidiDeviceListListener listener)
listener - The MidiDeviceListListener to register.void removeMidiDeviceListListener(MidiDeviceListListener listener)
listener - The MidiDeviceListListener to remove.void addMidiInstrumentMapListListener(ListListener<MidiInstrumentMap> listener)
listener - The ListListener to register.void removeMidiInstrumentMapListListener(ListListener<MidiInstrumentMap> listener)
listener - The ListListener to remove.void addSamplerChannelListListener(SamplerChannelListListener listener)
listener - The SamplerChannelListListener to register.void removeSamplerChannelListListener(SamplerChannelListListener listener)
listener - The SamplerChannelListListener to remove.ServerInfo getServerInfo()
ServerInfo instance containing
information about the LinuxSampler instance the front-end is connected to.AudioOutputDriver[] getAudioOutputDrivers()
AudioOutputDriver array containing all audio output drivers
currently available for the LinuxSampler instance.AudioDeviceModel getAudioDevice(int index)
index - The position of the audio device to return.
getAudioDeviceCount()AudioDeviceModel getAudioDeviceById(int deviceId)
deviceId.
deviceId - The ID of the audio device whose model should be obtained.
null
if there is no audio device with ID deviceId.int getAudioDeviceCount()
AudioDeviceModel[] getAudioDevices()
void addAudioDevice(AudioOutputDevice device)
device - The audio device to be added.boolean removeAudioDeviceById(int deviceId)
deviceId - The ID of the audio device to be removed.
true if the audio device is removed successfully, false
if the device list does not contain audio device with ID deviceId.void removeBackendAudioDevice(int deviceId)
deviceId - The ID of the audio device to be removed.MidiInputDriver[] getMidiInputDrivers()
MidiInputDriver array containing all MIDI input drivers currently
available for the LinuxSampler instance.MidiDeviceModel getMidiDevice(int index)
index - The position of the MIDI device to return.
MidiDeviceModel getMidiDeviceById(int deviceId)
deviceId.
deviceId - The ID of the MIDI device whose model should be obtained.
null
if there is no MIDI device with ID deviceId.int getMidiDeviceCount()
MidiDeviceModel[] getMidiDevices()
void addMidiDevice(MidiInputDevice device)
device - The MIDI device to be added.
void addBackendMidiDevice(java.lang.String driver,
Parameter... parameters)
driver - The desired MIDI input system.parameters - An optional list of driver specific parameters.boolean removeMidiDeviceById(int deviceId)
deviceId - The ID of the MIDI device to be removed.
true if the MIDI device is removed successfully, false
if the device list does not contain MIDI device with ID deviceId.void removeBackendMidiDevice(int deviceId)
deviceId - The ID of the MIDI input device to be destroyed.MidiInstrumentMap getMidiInstrumentMapById(int mapId)
mapId.
mapId - The ID of the MIDI instrument map to obtain.
null
if there is no MIDI instrument map with ID mapId.MidiInstrumentMap getMidiInstrumentMap(int index)
index - The position of the MIDI instrument map to return.
int getMidiInstrumentMapCount()
MidiInstrumentMap[] getMidiInstrumentMaps()
int getMidiInstrumentMapIndex(MidiInstrumentMap map)
map - The map whose index should be returned.
map is null or
the map list does not contain the specified map.void addMidiInstrumentMap(MidiInstrumentMap map)
map - The MIDI instrument map to be added.void addBackendMidiInstrumentMap(java.lang.String name)
name - The name of the MIDI instrument map.
java.lang.IllegalArgumentException - If name is null.boolean removeMidiInstrumentMapById(int mapId)
mapId - The ID of the MIDI instrument map to be removed.
true if the MIDI instrument map is removed successfully,
false if the MIDI instrument map's list does not contain
MIDI instrument map with ID mapId.void removeAllMidiInstrumentMaps()
void removeBackendMidiInstrumentMap(int mapId)
mapId - The numerical ID of the MIDI instrument map to remove.
java.lang.IllegalArgumentException - If mapId is negative.
void setBackendMidiInstrumentMapName(int mapId,
java.lang.String name)
mapId - The numerical ID of the MIDI instrument map.name - The new name for the specified MIDI instrument map.MidiInstrumentMap getDefaultMidiInstrumentMap()
null
if there are no maps created.
void mapBackendMidiInstrument(int mapId,
int bank,
int program,
MidiInstrumentInfo instrInfo)
mapId - The id of the MIDI instrument map.bank - The index of the MIDI bank, which shall contain the instrument.program - The MIDI program number of the new instrument.instrInfo - Provides the MIDI instrument settings.
void unmapBackendMidiInstrument(int mapId,
int bank,
int program)
mapId - The id of the MIDI instrument map containing the instrument to be removed.bank - The index of the MIDI bank containing the instrument to be removed.program - The MIDI program number of the instrument to be removed.SamplerEngine[] getEngines()
SamplerChannelModel[] getChannels()
SamplerChannelModel getChannel(int index)
index - The position of the channel to return.
#getchannelCountSamplerChannelModel getChannelById(int channelId)
channelId.
channelId - The ID of the sampler channel whose model should be obtained.
null
if there is no channel with ID channelId.int getChannelCount()
void addBackendChannel()
addChannel(SamplerChannel)void addChannel(SamplerChannel channel)
channel - The channel to be added.boolean removeChannelById(int channelId)
channelId - The ID of the channel to be removed.
true if the channel is removed successfully, false
if the channel's list does not contain channel with ID channelId.void removeBackendChannel(int channelId)
channelId - The ID of the channel to be removed.void updateChannel(SamplerChannel channel)
channel - A SamplerChannel instance containing the new settings
for the channel.void editBackendInstrument(int channelId)
channelId - The sampler channel number.boolean hasSoloChannel()
true if there is at least one solo channel in the current list of
sampler channels, false otherwise.int getSoloChannelCount()
int getMutedChannelCount()
int getMutedBySoloChannelCount()
int getTotalStreamCount()
int getTotalVoiceCount()
int getTotalVoiceCountMax()
float getVolume()
void setVolume(float volume)
volume - The new volume value.void setBackendVolume(float volume)
volume - The new volume value.void resetBackend()
void updateActiveStreamsInfo(int count)
count - The new number of active streams.
void updateActiveVoiceInfo(int count,
int countMax)
count - The new number of active voices.countMax - The maximum number of active voices.boolean isModified()
void setModified(boolean b)
|
JSampler v0.8a |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||