- java.lang.Object
- 
- javax.sound.midi.SoundbankResource
 
- 
- Direct Known Subclasses:
- Instrument
 
 public abstract class SoundbankResource extends Object ASoundbankResourcerepresents any audio resource stored in aSoundbank. Common soundbank resources include:- Instruments. An instrument may be specified in a variety of ways.
   However, all soundbanks have some mechanism for defining instruments. In
   doing so, they may reference other resources stored in the soundbank.
   Each instrument has a Patchwhich specifies the MIDI program and bank by which it may be referenced in MIDI messages. Instrument information may be stored inInstrumentobjects.
- Audio samples. A sample typically is a sampled audio waveform which
   contains a short sound recording whose duration is a fraction of a
   second, or at most a few seconds. These audio samples may be used by a
   Synthesizerto synthesize sound in response to MIDI commands, or extracted for use by an application. (The terminology reflects musicians' use of the word "sample" to refer collectively to a series of contiguous audio samples or frames, rather than to a single, instantaneous sample.) The data class for an audio sample will be an object that encapsulates the audio sample data itself and information about how to interpret it (the format of the audio data), such as anAudioInputStream.
- Embedded sequences. A sound bank may contain built-in song data stored
   in a data object such as a Sequence.
 Instrumentsand samples in aSoundbank. A singleInstrumentcan use multiple SoundbankResources (typically for notes of dissimilar pitch or brightness). Also, more than oneInstrumentcan use the same sample.
- 
- 
Constructor SummaryConstructors Modifier Constructor Description protectedSoundbankResource(Soundbank soundBank, String name, Class<?> dataClass)Constructs a newSoundbankResourcefrom the given sound bank and wavetable index.
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract ObjectgetData()Obtains the sampled audio that is stored in thisSoundbankResource.Class<?>getDataClass()Obtains the class used by this sample to represent its data.StringgetName()Obtains the name of the resource.SoundbankgetSoundbank()Obtains the sound bank that contains thisSoundbankResource.
 
- 
- 
- 
Constructor Detail- 
SoundbankResourceprotected SoundbankResource(Soundbank soundBank, String name, Class<?> dataClass) Constructs a newSoundbankResourcefrom the given sound bank and wavetable index. (Setting theSoundbankResource'sname, sampled audio data, and instruments is a subclass responsibility.)- Parameters:
- soundBank- the sound bank containing this- SoundbankResource
- name- the name of the sample
- dataClass- the class used to represent the sample's data
- See Also:
- getSoundbank(),- getName(),- getDataClass(),- getData()
 
 
- 
 - 
Method Detail- 
getSoundbankpublic Soundbank getSoundbank() Obtains the sound bank that contains thisSoundbankResource.- Returns:
- the sound bank in which this SoundbankResourceis stored
 
 - 
getNamepublic String getName() Obtains the name of the resource. This should generally be a string descriptive of the resource.- Returns:
- the instrument's name
 
 - 
getDataClasspublic Class<?> getDataClass() Obtains the class used by this sample to represent its data. The object returned bygetDatawill be of this class. If thisSoundbankResourceobject does not support direct access to its data, returnsnull.- Returns:
- the class used to represent the sample's data, or null if the data is not accessible
 
 - 
getDatapublic abstract Object getData() Obtains the sampled audio that is stored in thisSoundbankResource. The type of object returned depends on the implementation of the concrete class, and may be queried usinggetDataClass.- Returns:
- an object containing the sampled audio data
- See Also:
- getDataClass()
 
 
- 
 
-