com.sun.media.jfxmediaimpl

Class NativeMediaAudioClip

java.lang.Object

com.sun.media.jfxmedia.AudioClip

com.sun.media.jfxmediaimpl.NativeMediaAudioClip

final class NativeMediaAudioClip
extends AudioClip

AudioClip implementation that uses NativeMediaPlayer to play sounds.

Field Summary

Fields

Modifier and Type	Field and Description
private Locator	mediaLocator
private java.util.concurrent.atomic.AtomicInteger	playCount
private java.net.URI	sourceURI

Fields inherited from class com.sun.media.jfxmedia.AudioClip

clipBalance, clipPan, clipPriority, clipRate, clipVolume, loopCount, SAMPLE_FORMAT_S16BE, SAMPLE_FORMAT_S16LE, SAMPLE_FORMAT_S24BE, SAMPLE_FORMAT_S24LE, SAMPLE_FORMAT_S8, SAMPLE_FORMAT_U16BE, SAMPLE_FORMAT_U16LE, SAMPLE_FORMAT_U24BE, SAMPLE_FORMAT_U24LE, SAMPLE_FORMAT_U8

Constructor Summary

Constructors

Modifier	Constructor and Description
private	NativeMediaAudioClip(java.net.URI source)

Method Summary

Modifier and Type	Method and Description
AudioClip	append(AudioClip clip) Create a new AudioClip by appending the given clip to the current clip.
static AudioClip	create(byte[] data, int dataOffset, int sampleCount, int sampleFormat, int channels, int sampleRate)
AudioClip	createSegment(double startTime, double stopTime) Create a new AudioClip from a segment of an existing AudioClip.
AudioClip	createSegment(int startSample, int endSample) Create a new AudioClip from a segment of an existing AudioClip.
AudioClip	flatten() Creates a completely independent AudioClip.
(package private) Locator	getLocator()
boolean	isPlaying() Test if any AudioClipPlayer has this AudioClip in its effect chain.
static AudioClip	load(java.net.URI source)
void	play() Play this AudioClip with the default parameters.
void	play(double volume) Play this AudioClip at the given volume level.
void	play(double volume, double balance, double rate, double pan, int loopCount, int priority) Play this AudioClip at the given volume level and relative pitch.
(package private) void	playFinished()
AudioClip	resample(int startSample, int endSample, int newSampleRate) Create a new AudioClip from an existing clip by resampling a segment of the source clip to the specified sample playbackRate.
void	stop() Stops all playback of this AudioClip.
static void	stopAllClips()

Methods inherited from class com.sun.media.jfxmedia.AudioClip

balance, loopCount, pan, playbackRate, priority, setBalance, setLoopCount, setPan, setPlaybackRate, setPriority, setVolume, volume

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sourceURI

private java.net.URI sourceURI

mediaLocator

private Locator mediaLocator

playCount

private java.util.concurrent.atomic.AtomicInteger playCount

Constructor Detail

NativeMediaAudioClip

private NativeMediaAudioClip(java.net.URI source)
                      throws java.net.URISyntaxException,
                             java.io.FileNotFoundException,
                             java.io.IOException

Throws:

java.net.URISyntaxException

java.io.FileNotFoundException

java.io.IOException

Method Detail

getLocator

Locator getLocator()

load

public static AudioClip load(java.net.URI source)
                      throws java.net.URISyntaxException,
                             java.io.FileNotFoundException,
                             java.io.IOException

Throws:

java.net.URISyntaxException

java.io.FileNotFoundException

java.io.IOException

create

public static AudioClip create(byte[] data,
                               int dataOffset,
                               int sampleCount,
                               int sampleFormat,
                               int channels,
                               int sampleRate)

createSegment

public AudioClip createSegment(double startTime,
                               double stopTime)
                        throws java.lang.IllegalArgumentException

Description copied from class: AudioClip

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.

Specified by:

createSegment in class AudioClip

Parameters:

startTime - The start time for the segment

stopTime - The end time of the segment or -1.0 for the remainder of the source clip.

Returns:

A new AudioClip instance containing only the specified segment of the source clip

Throws:

java.lang.IllegalArgumentException - If startTime or stopTime are not valid for this AudioClip.

createSegment

public AudioClip createSegment(int startSample,
                               int endSample)
                        throws java.lang.IllegalArgumentException

Description copied from class: AudioClip

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.

Specified by:

createSegment in class AudioClip

Parameters:

startSample - The starting audio sample for the segment

endSample - The ending audio sample of the segment, or -1 for the remainder of the source clip.

Returns:

A new AudioClip instance containing only the specified segment of the source clip

Throws:

java.lang.IllegalArgumentException - If the given sample range is invalid for this AudioClip.

resample

public AudioClip resample(int startSample,
                          int endSample,
                          int newSampleRate)
                   throws java.lang.IllegalArgumentException,
                          java.io.IOException

Description copied from class: AudioClip

Create a new AudioClip from an existing clip by resampling a segment of the source clip to the specified sample playbackRate.

Specified by:

resample in class AudioClip

Parameters:

startSample - starting sample to begin resampling at. The first sample is always zero, negative values are not allowed.

endSample - The last sample to resample or -1 for the remainder of the source clip.

newSampleRate - The sample playbackRate to create the new AudioClip at.

Returns:

A new AudioClip that contains a copy of the source AudioClip resampled to the new sample playbackRate.

Throws:

java.lang.IllegalArgumentException - If the sample range is invalid for this AudioClip, or the new sample rate is not supported.

java.io.IOException - If an error occurred during rate conversion.

append

public AudioClip append(AudioClip clip)
                 throws java.io.IOException

Description copied from class: AudioClip

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.

Specified by:

append in class AudioClip

Parameters:

clip - The clip to be appended to the current clip.

Returns:

A new AudioClip that contains the concatenation of the two source clips.

Throws:

java.io.IOException - If an error occurred during the concatenation, generally during rate conversion if it's necessary.

flatten

public AudioClip flatten()

Description copied from class: AudioClip

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.

Specified by:

flatten in class AudioClip

Returns:

A new AudioClip that is independent of all other clips.

isPlaying

public boolean isPlaying()

Description copied from class: AudioClip

Test if any AudioClipPlayer has this AudioClip in its effect chain.

Specified by:

isPlaying in class AudioClip

Returns:

true if at least one AudioClipPlayer is playing or has this AudioClip enqueued.

play

public void play()

Description copied from class: AudioClip

Play this AudioClip with the default parameters. This is a fire and forget method, the clip will play exactly once using the default parameters.

Specified by:

play in class AudioClip

play

public void play(double volume)

Description copied from class: AudioClip

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.

Specified by:

play in class AudioClip

Parameters:

volume - 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.

play

public void play(double volume,
                 double balance,
                 double rate,
                 double pan,
                 int loopCount,
                 int priority)

Description copied from class: AudioClip

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.

Specified by:

play in class AudioClip

Parameters:

volume - 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.

balance - Left/right balance or relative channel volumes for stereo effects.

rate - Playback rate multiplier. 1.0 will play back at the normal rate while 2.0 will double the rate.

pan - 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.

loopCount - The number of times to play this clip, specify -1 to loop indefinitely

priority - Audio effect priority. Lower priority effects will be dropped first if too many effects are trying to play simultaneously.

stop

public void stop()

Description copied from class: AudioClip

Stops all playback of this AudioClip.

Specified by:

stop in class AudioClip

stopAllClips

public static void stopAllClips()

playFinished

void playFinished()