Interface Soundbank
-
public interface SoundbankASoundbankcontains a set ofInstrumentsthat can be loaded into aSynthesizer. Note that a Java SoundSoundbankis different from a MIDI bank. MIDI permits up to 16383 banks, each containing up to 128 instruments (also sometimes called programs, patches, or timbres). However, aSoundbankcan contain 16383 times 128 instruments, because the instruments within aSoundbankare indexed by both a MIDI program number and a MIDI bank number (via aPatchobject). Thus, aSoundbankcan be thought of as a collection of MIDI banks.Soundbankincludes methods that returnStringobjects containing the sound bank's name, manufacturer, version number, and description. The precise content and format of these strings is left to the implementor.Different synthesizers use a variety of synthesis techniques. A common one is wavetable synthesis, in which a segment of recorded sound is played back, often with looping and pitch change. The Downloadable Sound (DLS) format uses segments of recorded sound, as does the Headspace Engine.
SoundbanksandInstrumentsthat are based on wavetable synthesis (or other uses of stored sound recordings) should typically implement thegetResources()method to provide access to these recorded segments. This is optional, however; the method can return an zero-length array if the synthesis technique doesn't use sampled sound (FM synthesis and physical modeling are examples of such techniques), or if it does but the implementor chooses not to make the samples accessible.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description StringgetDescription()Obtains a textual description of the sound bank, suitable for display.InstrumentgetInstrument(Patch patch)Obtains anInstrumentfrom the givenPatch.Instrument[]getInstruments()Obtains a list of instruments contained in this sound bank.StringgetName()Obtains the name of the sound bank.SoundbankResource[]getResources()Extracts a list of non-Instrument resources contained in the sound bank.StringgetVendor()Obtains astringnaming the company that provides the sound bankStringgetVersion()Obtains the version string for the sound bank.
-
-
-
Method Detail
getName
String getName()
Obtains the name of the sound bank.- Returns:
-
a
Stringnaming the sound bank
getVersion
String getVersion()
Obtains the version string for the sound bank.- Returns:
-
a
Stringthat indicates the sound bank's version
getVendor
String getVendor()
Obtains astringnaming the company that provides the sound bank- Returns:
- the vendor string
getDescription
String getDescription()
Obtains a textual description of the sound bank, suitable for display.- Returns:
-
a
Stringthat describes the sound bank
getResources
SoundbankResource[] getResources()
Extracts a list of non-Instrument resources contained in the sound bank.- Returns:
- an array of resources, excluding instruments. If the sound bank contains no resources (other than instruments), returns an array of length 0.
getInstruments
Instrument[] getInstruments()
Obtains a list of instruments contained in this sound bank.- Returns:
-
an array of the
Instrumentsin thisSoundBankIf the sound bank contains no instruments, returns an array of length 0. - See Also:
-
Synthesizer.getLoadedInstruments(),getInstrument(Patch)
getInstrument
Instrument getInstrument(Patch patch)
Obtains anInstrumentfrom the givenPatch.- Parameters:
-
patch- aPatchobject specifying the bank index and program change number - Returns:
-
the requested instrument, or
nullif the sound bank doesn't contain that instrument - See Also:
-
getInstruments(),Synthesizer.loadInstruments(Soundbank, Patch[])
-
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.
