- Direct Known Subclasses:
public abstract class SoundbankResource extends Object
SoundbankResourcerepresents any audio resource stored in a
Soundbank. 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 in
- 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 an
- Embedded sequences. A sound bank may contain built-in song data stored
in a data object such as a
Instrumentsand samples in a
Soundbank. A single
Instrumentcan use multiple SoundbankResources (typically for notes of dissimilar pitch or brightness). Also, more than one
Instrumentcan use the same sample.
Method SummaryModifier and TypeMethodDescription
getData()Obtains the sampled audio that is stored in this
Class<?>Obtains the class used by this sample to represent its data.
getName()Obtains the name of the resource.Obtains the sound bank that contains this
SoundbankResourceConstructs a new
SoundbankResourcefrom the given sound bank and wavetable index. (Setting the
SoundbankResource'sname, sampled audio data, and instruments is a subclass responsibility.)
getSoundbankpublic Soundbank getSoundbank()Obtains the sound bank that contains this
- the sound bank in which this
getNamepublic String getName()Obtains the name of the resource. This should generally be a string descriptive of the resource.
- the instrument's name
getDataClasspublic Class<?> getDataClass()Obtains the class used by this sample to represent its data. The object returned by
getDatawill be of this class. If this
SoundbankResourceobject does not support direct access to its data, 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 this
SoundbankResource. The type of object returned depends on the implementation of the concrete class, and may be queried using
- an object containing the sampled audio data
- See Also: