org.barrelorgandiscovery.editableinstrument

Interface IEditableInstrument

All Known Implementing Classes:

EditableInstrument, SynchronizedEditableInstrument

public interface IEditableInstrument

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_PIPESTOPGROUPNAME Default pipestopgroupname

Method Summary

Modifier and Type	Method and Description
void	addListener(InstrumentDescriptionListener listener)
void	addListener(ScaleListener listener) Add a scale listener ...
void	addListener(SoundSampleListListener listener) Add sound sample list listener
void	addScript(InstrumentScript script) Add an instrument script
void	addSoundSample(SoundSample ss, java.lang.String pipeStopGroup)
void	clearDirty() Reset the dirty flag
void	dispose() Release all the instrument resources used
InstrumentScript	findScript(java.lang.String name) Find a script by its name
InstrumentScript[]	findScriptsByType(InstrumentScript.InstrumentScriptType type) Find all the script of a specified type
java.lang.String	getInstrumentDescription() Get the instrument description
java.awt.Image	getInstrumentPicture() Get the instrument picture
java.lang.String	getName() Get the instrument name
SoundSample	getPercussionSoundSample(PercussionDef pd) Get the sample associated to a percussion sample
java.lang.String[]	getPipeStopGroupsAndRegisterName() Get the list of pipestop groups in the instrument
SampleMapping	getSampleMapping(java.lang.String pipeStopGroup, SoundSample sample) Get the mapping associated with a pipestopgroup
Scale	getScale() Get the scale of the instrument
InstrumentScript[]	getScripts() Get all the scripts associated to an instrument
java.util.List<SoundSample>	getSoundSampleList(java.lang.String pipeStopGroup) Get the sound sample List ...
boolean	isDirty() Ask if the instrument is dirty
void	removeListener(InstrumentDescriptionListener listener)
void	removeListener(ScaleListener listener) Remove a scale listener
void	removeListener(SoundSampleListListener listener) Remove sound sample list listener
void	removeSampleMapping(java.lang.String pipeStopGroup, SoundSample sample) Remove a sound sample associated to a pipestopgroup
void	removeScript(java.lang.String name) Remove a script by its name
void	removeSoundSample(SoundSample ss, java.lang.String pipeStopGroup)
void	setInstrumentDescription(java.lang.String instrumentDescription) Define the instrument description
void	setInstrumentPicture(java.awt.Image instrumentPicture) Define the instrument picture
void	setName(java.lang.String name) Define the name of the instrument
void	setPercussionSoundSample(PercussionDef pd, SoundSample ss) define a sample associated to a percussion
SampleMapping	setSampleMapping(java.lang.String pipeStopGroup, SoundSample sample, int first, int end) Define a sound sample for a pipestopgroup
void	setScale(Scale scale) Define a new Scale associated to the instrument

Field Detail

DEFAULT_PIPESTOPGROUPNAME

static final java.lang.String DEFAULT_PIPESTOPGROUPNAME

Default pipestopgroupname

See Also:

Constant Field Values

Method Detail

setScale

void setScale(Scale scale)

Define a new Scale associated to the instrument

getScale

Scale getScale()

Get the scale of the instrument

Returns:

setName

void setName(java.lang.String name)

Define the name of the instrument

getName

java.lang.String getName()

Get the instrument name

Returns:

getPipeStopGroupsAndRegisterName

java.lang.String[] getPipeStopGroupsAndRegisterName()

Get the list of pipestop groups in the instrument

Returns:

addListener

void addListener(ScaleListener listener)

Add a scale listener ...

Parameters:

listener -

removeListener

void removeListener(ScaleListener listener)

Remove a scale listener

Parameters:

listener -

addListener

void addListener(SoundSampleListListener listener)

Add sound sample list listener

Parameters:

listener -

removeListener

void removeListener(SoundSampleListListener listener)

Remove sound sample list listener

addListener

void addListener(InstrumentDescriptionListener listener)

removeListener

void removeListener(InstrumentDescriptionListener listener)

getSoundSampleList

java.util.List<SoundSample> getSoundSampleList(java.lang.String pipeStopGroup)

Get the sound sample List ...

Returns:

addSoundSample

void addSoundSample(SoundSample ss,
                    java.lang.String pipeStopGroup)

removeSoundSample

void removeSoundSample(SoundSample ss,
                       java.lang.String pipeStopGroup)

getSampleMapping

SampleMapping getSampleMapping(java.lang.String pipeStopGroup,
                               SoundSample sample)

Get the mapping associated with a pipestopgroup

Parameters:

pipeStopGroup -

sample -

Returns:

setSampleMapping

SampleMapping setSampleMapping(java.lang.String pipeStopGroup,
                               SoundSample sample,
                               int first,
                               int end)

Define a sound sample for a pipestopgroup

Parameters:

pipeStopGroup - the pipestopgroup

sample - the sample

first - the first note of the sample association

end - the last note of the sample association

Returns:

removeSampleMapping

void removeSampleMapping(java.lang.String pipeStopGroup,
                         SoundSample sample)

Remove a sound sample associated to a pipestopgroup

Parameters:

pipeStopGroup -

sample -

getInstrumentDescription

java.lang.String getInstrumentDescription()

Get the instrument description

Returns:

setInstrumentDescription

void setInstrumentDescription(java.lang.String instrumentDescription)

Define the instrument description

Parameters:

instrumentDescription -

setInstrumentPicture

void setInstrumentPicture(java.awt.Image instrumentPicture)

Define the instrument picture

Parameters:

instrumentPicture -

getInstrumentPicture

java.awt.Image getInstrumentPicture()

Get the instrument picture

Returns:

dispose

void dispose()

Release all the instrument resources used

isDirty

boolean isDirty()

Ask if the instrument is dirty

Returns:

clearDirty

void clearDirty()

Reset the dirty flag

getScripts

InstrumentScript[] getScripts()

Get all the scripts associated to an instrument

findScript

InstrumentScript findScript(java.lang.String name)

Find a script by its name

Parameters:

name -

Returns:

findScriptsByType

InstrumentScript[] findScriptsByType(InstrumentScript.InstrumentScriptType type)

Find all the script of a specified type

Parameters:

type -

Returns:

removeScript

void removeScript(java.lang.String name)

Remove a script by its name

Parameters:

name -

addScript

void addScript(InstrumentScript script)

Add an instrument script

Parameters:

script -

getPercussionSoundSample

SoundSample getPercussionSoundSample(PercussionDef pd)

Get the sample associated to a percussion sample

setPercussionSoundSample

void setPercussionSoundSample(PercussionDef pd,
                              SoundSample ss)

define a sample associated to a percussion

Parameters:

pd -

ss -