Module tagtraum.audioplayer4j

Package com.tagtraum.audioplayer4j

Class AudioPlayerFactory

java.lang.Object

com.tagtraum.audioplayer4j.AudioPlayerFactory

public class AudioPlayerFactory
extends Object

Factory for AudioPlayer instances. To get an instance, use open(URI) or, if playback on a specific AudioDevice is desired, use open(URI, AudioDevice).
You may disable certain implementations by calling setJavaEnabled(boolean), setJavaFXEnabled(boolean), or setNativeEnabled(boolean).

Author:

Hendrik Schreiber

Method Summary

Modifier and Type	Method	Description
static boolean	isJavaEnabled()	Indicates whether a Java-based implementation is enabled.
static boolean	isJavaFXEnabled()	Indicates whether a JavaFX-based implementation is enabled.
static boolean	isNativeEnabled()	Indicates whether a native implementation is enabled.
static AudioPlayer	open(URI uri)	Opens an AudioPlayer instance suitable for the given URI using the default audio device for playback.
static AudioPlayer	open(URI uri, AudioDevice audioDevice)	Opens an AudioPlayer instance suitable for the given URI using the given audio device for playback.
static void	setJavaEnabled(boolean javaEnabled)	Enables/disables the Java-based implementation.
static void	setJavaFXEnabled(boolean javaFXEnabled)	Enables/disables the JavaFX-based implementation (if available at all).
static void	setNativeEnabled(boolean nativeEnabled)	Enables/disables the native implementation (if available at all).

Methods inherited from class java.lang.Object

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

Method Detail

isNativeEnabled

public static boolean isNativeEnabled()

Indicates whether a native implementation is enabled.

Returns:

true or false

setNativeEnabled

public static void setNativeEnabled(boolean nativeEnabled)

Enables/disables the native implementation (if available at all).

Parameters:

nativeEnabled - true or false

isJavaEnabled

public static boolean isJavaEnabled()

Indicates whether a Java-based implementation is enabled.

Returns:

true or false

setJavaEnabled

public static void setJavaEnabled(boolean javaEnabled)

Enables/disables the Java-based implementation.

Parameters:

javaEnabled - true or false

isJavaFXEnabled

public static boolean isJavaFXEnabled()

Indicates whether a JavaFX-based implementation is enabled.

Returns:

true or false

setJavaFXEnabled

public static void setJavaFXEnabled(boolean javaFXEnabled)

Enables/disables the JavaFX-based implementation (if available at all).

Parameters:

javaFXEnabled - true or false

open

public static AudioPlayer open(URI uri)
                        throws IOException,
                               UnsupportedAudioFileException

Opens an AudioPlayer instance suitable for the given URI using the default audio device for playback.

Parameters:

uri - audio resource URI

Returns:

audio player instance

Throws:

IOException - if the URI cannot be opened

UnsupportedAudioFileException

See Also:

open(URI, AudioDevice)

open

public static AudioPlayer open(URI uri,
                               AudioDevice audioDevice)
                        throws IOException,
                               UnsupportedAudioFileException

Opens an AudioPlayer instance suitable for the given URI using the given audio device for playback.

Parameters:

uri - audio resource URI

audioDevice - desired audio device

Returns:

audio player instance

Throws:

IOException - if the URI cannot be opened

UnsupportedAudioFileException

See Also:

open(URI)