org.netbeans.html.sound.spi

Interface AudioEnvironment<Audio>

Type Parameters:

Audio - custom type representing the internal audio state

public interface AudioEnvironment<Audio>

Basic interface for sound playback providers. Register your implementation in a way ServiceLoader can find it - e.g. use ServiceProvider annotation. Possibly one can register the provider into Contexts.newBuilder(), in case the implementation is somehow associated with the actual BrwsrCtx (works since version 0.8.3).

Author:

antonepple

Method Summary

Modifier and Type	Method and Description
Audio	create(String src) Checks if the provided URL can be a supported audio stream and if so, it create an object to represent it.
boolean	isSupported(Audio a) Checks whether given audio is supported
void	pause(Audio a) Pauses playback of the audio.
void	play(Audio a) Starts playback of the audio.
void	setVolume(Audio a, double volume) Changes volume for the playback of the audio.

Method Detail

create

Audio create(String src)

Checks if the provided URL can be a supported audio stream and if so, it create an object to represent it. The created object will be used in future callbacks to other methods of this interface (like AudioEnvironment.play(java.lang.Object)).

Parameters:

src - the URL pointing to the media stream

Returns:

an internal representation object or null if this environment does not know how to handle such stream

play

void play(Audio a)

Starts playback of the audio.

Parameters:

a - the internal representation of the audio as created by AudioEnvironment.create(java.lang.String) method.

pause

void pause(Audio a)

Pauses playback of the audio.

Parameters:

a - the internal representation of the audio as created by AudioEnvironment.create(java.lang.String) method.

setVolume

void setVolume(Audio a,
               double volume)

Changes volume for the playback of the audio.

Parameters:

a - the internal representation of the audio as created by AudioEnvironment.create(java.lang.String) method.

volume - value between 0.0 and 1.0

isSupported

boolean isSupported(Audio a)

Checks whether given audio is supported

Parameters:

a - the internal representation of the audio as created by AudioEnvironment.create(java.lang.String) method.

Returns:

true or false