Class SoundbankResource
- java.lang.Object
-
- javax.sound.midi.SoundbankResource
-
- Direct Known Subclasses:
- Instrument
public abstract class SoundbankResource extends Object
ASoundbankResourcerepresents any audio resource stored in aSoundbank- 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 inInstrument - 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
SynthesizerAudioInputStream - Embedded sequences. A sound bank may contain built-in song data stored in a data object such as a
Sequence
Synthesizers that use wavetable synthesis or related techniques play back the audio in a sample when synthesizing notes, often when emulating the real-world instrument that was originally recorded. However, there is not necessarily a one-to-one correspondence between the
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 Summary
Constructors Modifier Constructor and Description protectedSoundbankResource(Soundbank soundBank, String name, Class<?> dataClass)Constructs a newSoundbankResourcefrom the given sound bank and wavetable index.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method and 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
SoundbankResource
protected 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 thisSoundbankResource -
name- the name of the sample -
dataClass- the class used to represent the sample's data - See Also:
-
getSoundbank(),getName(),getDataClass(),getData()
-
Method Detail
getSoundbank
public Soundbank getSoundbank()
Obtains the sound bank that contains thisSoundbankResource.- Returns:
-
the sound bank in which this
SoundbankResourceis stored
getName
public String getName()
Obtains the name of the resource. This should generally be a string descriptive of the resource.- Returns:
- the instrument's name
getDataClass
public 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
getData
public 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()
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
