| Modifier and Type | Class and Description |
|---|---|
| private static class |
| Modifier and Type | Field and Description |
|---|---|
| private static NativeAudioClip. | |
| private final Locator | |
| private long |
| Access | Constructor and Description |
|---|---|
| private | |
| private | NativeAudioClip(byte[] data, int dataOffset, int sampleCount, int sampleFormat, int channels, int sampleRate)
|
| Modifier and Type | Method and Description |
|---|---|
| public AudioClip | append(AudioClip
The clip to be appended to the current clip. clip)Implements abstract com. Create a new AudioClip by appending the given clip to the current clip. |
| public static AudioClip | create(byte[]
Raw PCM samples stored in a byte array. data, int Byte offset into data that the sample data starts. dataOffset, int Number of LPCM samples stored in data. sampleCount, int Raw format that the LPCM data is being provided in.
This may not be the actual format stored internally. sampleFormat, int The number of channels. Currently only two channel
audio is supported, channels beyond two are simply dropped. channels, int Audio sample playbackRate of the raw LPCM data. sampleRate)Hides com. Generate a AudioClip from raw LPCM audio data. |
| public AudioClip | createSegment(double
The start time for the segment startTime, double The end time of the segment or -1.0 for the remainder of
the source clip. stopTime)Implements abstract com. Create a new AudioClip from a segment of an existing AudioClip. |
| public AudioClip | createSegment(int
The starting audio sample for the segment startSample, int The ending audio sample of the segment, or -1 for the
remainder of the source clip. endSample)Implements abstract com. Create a new AudioClip from a segment of an existing AudioClip. |
| public AudioClip | flatten()
Implements abstract com. Creates a completely independent AudioClip. |
| pack-priv long | |
| public static synchronized boolean | |
| public boolean | isPlaying()
Implements abstract com. Test if any AudioClipPlayer has this AudioClip in its effect chain. |
| public static AudioClip | load(URI
URI to the desired clip. source)Hides com. Load an audio clip from the specified source URI. |
| private native NativeAudioClip | |
| private static native long | nacCreate(byte[] data, int dataOffset, int sampleCount, int sampleFormat, int channels, int sampleRate)
|
| private native NativeAudioClip | |
| private native NativeAudioClip | |
| private static native boolean | |
| private native boolean | |
| private static native long | |
| private native void | nacPlay(long handle, double volume, double balance, double pan, double rate, int loopCount, int priority)
|
| private native NativeAudioClip | |
| private native void | |
| private static native void | |
| private static native void | |
| public void | play()
Implements abstract com. Play this AudioClip with the default parameters. |
| public void | play(double
Volume level to play this effect at. Valid volume range is
0.0 to 1.0, where 0.0 is effectively muted and 1.0 is full volume. volume)Implements abstract com. Play this AudioClip at the given volume level. |
| public void | play(double
Volume level to play this effect at. Valid volume range is
0.0 to 1.0, where 0.0 is effectively muted and 1.0 is full volume. volume, double Left/right balance or relative channel volumes for stereo
effects. balance, double Playback rate multiplier. 1.0 will play back at the normal
rate while 2.0 will double the rate. rate, double Left/right shift to be applied to the clip. A pan value of
-1.0 means full left channel, 1.0 means full right channel, 0.0 has no
effect. pan, int The number of times to play this clip, specify -1 to
loop indefinitely loopCount, int Audio effect priority. Lower priority effects will be
dropped first if too many effects are trying to play simultaneously. priority)Implements abstract com. Play this AudioClip at the given volume level and relative pitch. |
| public AudioClip | resample(int
starting sample to begin resampling at. The first
sample is always zero, negative values are not allowed. startSample, int The last sample to resample or -1 for the remainder of
the source clip. endSample, int The sample playbackRate to create the new AudioClip at. newSampleRate)Implements abstract com. Create a new AudioClip from an existing clip by resampling a segment of the source clip to the specified sample playbackRate. |
| public void | stop()
Implements abstract com. Stops all playback of this AudioClip. |
| public static void | stopAllClips()
Hides com. Stop all AudioClips that are currently playing. |
| clipDisposer | back to summary |
|---|---|
| private static NativeAudioClip. | |
| mediaSource | back to summary |
|---|---|
| private final Locator mediaSource | |
| nativeHandle | back to summary |
|---|---|
| private long nativeHandle | |
| NativeAudioClip | back to summary |
|---|---|
| private NativeAudioClip(Locator source) | |
| NativeAudioClip | back to summary |
|---|---|
| private NativeAudioClip(byte[] data, int dataOffset, int sampleCount, int sampleFormat, int channels, int sampleRate) | |
| append | back to summary |
|---|---|
| public AudioClip append(AudioClip clip) Implements abstract com. Doc from com. Create a new AudioClip by appending the given clip to the current clip. The new clip is independent of the two source clips. If the sample rates are mismatched, the new clip will contain at least one resampled copy of a source clip. Which clip is resampled is implementation dependent. | |
| create | back to summary |
|---|---|
| public static AudioClip create(byte[] data, int dataOffset, int sampleCount, int sampleFormat, int channels, int sampleRate) Hides com. Doc from com. Generate a AudioClip from raw LPCM audio data. This can be used to programmatically create sound effects, either generated mathematically or loaded from some arbitrary source. Multiple channels must be interleaved properly, for stereo audio left channel is always first.
| |
| createSegment | back to summary |
|---|---|
| public AudioClip createSegment(double startTime, double stopTime) Implements abstract com. Doc from com. Create a new AudioClip from a segment of an existing AudioClip. The new clip may copy or simply reference this existing clip, so be aware that this operation may have a severe memory usage impact for long segments. The default parameters are copied to the new clip. This variant specifies the start and end times of the segment. Specifying an end time beyond the duration of the clip will crop the new AudioClip to the end of the source clip. Specifying a start time less than zero or greater than end time is undefined and will return null. | |
| createSegment | back to summary |
|---|---|
| public AudioClip createSegment(int startSample, int endSample) Implements abstract com. Doc from com. Create a new AudioClip from a segment of an existing AudioClip. The new clip may copy or simply reference this existing clip, so be aware that this operation may have a severe memory usage impact for long segments. The default parameters are copied to the new clip. This variant specifies the exact sample offsets of the segment, starting at sample zero. If endSample is greater than the number of samples in the source clip, it will be cropped to the last sample. Specifying a start sample less than zero or higher than endSample is undefined and will return null. | |
| flatten | back to summary |
|---|---|
| public AudioClip flatten() Implements abstract com. Doc from com. Creates a completely independent AudioClip. Any references contained will be copied and the references removed. The result will be a single AudioEffect containing all the audio data required to produce the effect. If the effect is already independent, then this will simply return the same AudioClip. | |
| getNativeHandle | back to summary |
|---|---|
| pack-priv long getNativeHandle() | |
| init | back to summary |
|---|---|
| public static synchronized boolean init() | |
| isPlaying | back to summary |
|---|---|
| public boolean isPlaying() Implements abstract com. Doc from com. Test if any AudioClipPlayer has this AudioClip in its effect chain.
| |
| load | back to summary |
|---|---|
| public static AudioClip load(URI source) Hides com. Doc from com. Load an audio clip from the specified source URI. Currently supported formats are AIFF and WAV files. Audio data in the file must be raw PCM, loading compressed files is not supported at this time. | |
| nacAppend | back to summary |
|---|---|
| private native NativeAudioClip nacAppend(long handle, long otherClip) | |
| nacCreate | back to summary |
|---|---|
| private static native long nacCreate(byte[] data, int dataOffset, int sampleCount, int sampleFormat, int channels, int sampleRate) | |
| nacCreateSegment | back to summary |
|---|---|
| private native NativeAudioClip nacCreateSegment(long handle, double startTime, double stopTime) | |
| nacCreateSegment | back to summary |
|---|---|
| private native NativeAudioClip nacCreateSegment(long handle, int startSample, int endSample) | |
| nacInit | back to summary |
|---|---|
| private static native boolean nacInit() | |
| nacIsPlaying | back to summary |
|---|---|
| private native boolean nacIsPlaying(long handle) | |
| nacLoad | back to summary |
|---|---|
| private static native long nacLoad(Locator source) | |
| nacPlay | back to summary |
|---|---|
| private native void nacPlay(long handle, double volume, double balance, double pan, double rate, int loopCount, int priority) | |
| nacResample | back to summary |
|---|---|
| private native NativeAudioClip nacResample(long handle, int startSample, int endSample, int sampleRate) | |
| nacStop | back to summary |
|---|---|
| private native void nacStop(long handle) | |
| nacStopAll | back to summary |
|---|---|
| private static native void nacStopAll() | |
| nacUnload | back to summary |
|---|---|
| private static native void nacUnload(long handle) | |
| play | back to summary |
|---|---|
| public void play() Implements abstract com. Doc from com. Play this AudioClip with the default parameters. This is a fire and forget method, the clip will play exactly once using the default parameters.
| |
| play | back to summary |
|---|---|
| public void play(double volume) Implements abstract com. Doc from com. Play this AudioClip at the given volume level. This is a fire and forget method, the clip will play exactly once using the given volume and default pitch and pan.
| |
| play | back to summary |
|---|---|
| public void play(double volume, double balance, double rate, double pan, int loopCount, int priority) Implements abstract com. Doc from com. Play this AudioClip at the given volume level and relative pitch. This is a fire and forget method, the clip will play exactly once using the given parameters.
| |
| resample | back to summary |
|---|---|
| public AudioClip resample(int startSample, int endSample, int newSampleRate) Implements abstract com. Doc from com. Create a new AudioClip from an existing clip by resampling a segment of the source clip to the specified sample playbackRate.
| |
| stop | back to summary |
|---|---|
| public void stop() Implements abstract com. Doc from com. Stops all playback of this AudioClip.
| |
| stopAllClips | back to summary |
|---|---|
| public static void stopAllClips() Hides com. Doc from com. Stop all AudioClips that are currently playing. | |
| Access | Constructor and Description |
|---|---|
| private |
| Modifier and Type | Method and Description |
|---|---|
| public void | disposeResource(Object
the resource that needs to be disposed of. resource)Implements com. Dispose the provided resource. |
| NativeAudioClipDisposer | back to summary |
|---|---|
| private NativeAudioClipDisposer() | |
| disposeResource | back to summary |
|---|---|
| public void disposeResource(Object resource) Implements com. Doc from com. Dispose the provided resource. | |