ej.audio

Class AudioPlayer

java.lang.Object

ej.audio.AudioPlayer

public class AudioPlayer
extends java.lang.Object

Class audio player to play sound with limited functionality.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	SOUND_OFF Boolean indicating a mute state.
static boolean	SOUND_ON Boolean indicating sound output is ON.

Method Summary

Modifier and Type	Method and Description
boolean	getAudioOutputState() Getter for the current state of the audio output.
java.lang.String	getCurrentSoundTitle() Get the name of the currently selected file in the play list.
static AudioPlayer	getInstance()
int	getVolume() Get the volume value.
void	loadPlaylist(Playlist Playlist) Load a Playlist in the AudioPlayer.
void	mute() Mute audio output.
void	next(int duration) Plays the next file in the Playlist..
void	pause() Pause the file currently playing.
void	play(AudioFile audioFile, int duration) Plays an AudioFile.
void	play(int duration) Plays the currently selected file in the Playlist.
void	previous(int duration) Plays the previous file in the Playlist.
void	restartPlaylist() Set the Playlist to the first {link @AudioFile}.
void	setPlaylistByIndex(int index) Read the file selected by the index on the Playlist.
void	setVolume(int volume) Set the volume in percentage.
void	unmute() Un-mute audio output.

Methods inherited from class java.lang.Object

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

Field Detail

SOUND_OFF

public static final boolean SOUND_OFF

Boolean indicating a mute state.

See Also:

Constant Field Values

SOUND_ON

public static final boolean SOUND_ON

Boolean indicating sound output is ON.

See Also:

Constant Field Values

Method Detail

getInstance

public static AudioPlayer getInstance()

Returns:

The singleton instance of AudioPlayer.

loadPlaylist

public void loadPlaylist(Playlist Playlist)

Load a Playlist in the AudioPlayer. Using a Playlist with an AudioPlayer is not required. You may chose not to initialize the Playlist. The next / previous will do nothing if no Playlist is initialized.

Parameters:

Playlist - Playlist to load into the audio player.

play

public void play(AudioFile audioFile,
                 int duration)
          throws java.io.IOException

Plays an AudioFile. This function will blocks for duration seconds. If a file is already playing, it will stop playing this file and the selected AudioFile.

Parameters:

audioFile - AudioFile to play.

duration - in seconds, how long will be the file be played.

Throws:

java.io.IOException - Low level code failed or has not been initialized.

play

public void play(int duration)
          throws java.io.IOException

Plays the currently selected file in the Playlist. This methods will blocks for duration seconds. If a file is already playing, it will stop playing this file and the selected AudioFile.

Parameters:

duration - in seconds, how long will the file be played.

Throws:

java.io.IOException - Low level code failed or has not been initialized.

next

public void next(int duration)
          throws java.io.IOException

Plays the next file in the Playlist.. This function will blocks for @param duration seconds. This methods does nothing if you haven't loaded a Playlist.. If a file is already playing, it will stop playing this file and the selected AudioFile.

Parameters:

duration - in seconds, how long will the file be played.

Throws:

java.io.IOException - Low level code failed or has not been initialized.

previous

public void previous(int duration)
              throws java.io.IOException

Plays the previous file in the Playlist. This function will blocks for duration seconds. This methods does nothing if you haven't loaded a Playlist. If a file is already playing, it will stop playing this file and the selected AudioFile.

Parameters:

duration - in seconds, how long will the file be played.

Throws:

java.io.IOException - Low level code failed or has not been initialized.

pause

public void pause()
           throws java.io.IOException

Pause the file currently playing.

Throws:

java.io.IOException - Low level code failed or has not been initialized.

setVolume

public void setVolume(int volume)

Set the volume in percentage.

Parameters:

volume - volume in percentage.

getVolume

public int getVolume()

Get the volume value.

Returns:

current volume in percent.

mute

public void mute()

Mute audio output.

unmute

public void unmute()

Un-mute audio output.

getAudioOutputState

public boolean getAudioOutputState()

Getter for the current state of the audio output. Return true if the AudioPlayer is not muted. Return false otherwise.

Returns:

AudioOutputState.

getCurrentSoundTitle

public java.lang.String getCurrentSoundTitle()

Get the name of the currently selected file in the play list. It is not the name of the currently playing file. Return an empty string if Playlist is not initialized.

Returns:

the field name of the current AudioFile in the Playlist.

restartPlaylist

public void restartPlaylist()

Set the Playlist to the first {link @AudioFile}.

setPlaylistByIndex

public void setPlaylistByIndex(int index)

Read the file selected by the index on the Playlist.

Parameters:

index - the index of the file to select in the Playlist between 0 and Playlist's size - 1