com.almasb.fxgl.service

Interface AudioPlayer

All Superinterfaces:

NotificationListener, UpdateEventListener, UserProfileSavable

public interface AudioPlayer
extends UserProfileSavable, UpdateEventListener, NotificationListener

General audio player service that supports playback of sound and music objects. It can also control volume of both.

Author:

Almas Baimagambetov (AlmasB) (almaslvl@gmail.com)

Property Summary

Type	Property and Description
javafx.beans.property.DoubleProperty	globalMusicVolume
javafx.beans.property.DoubleProperty	globalSoundVolume

Method Summary

Modifier and Type	Method and Description
default double	getGlobalMusicVolume()
default double	getGlobalSoundVolume()
javafx.beans.property.DoubleProperty	globalMusicVolumeProperty()
javafx.beans.property.DoubleProperty	globalSoundVolumeProperty()
default void	onNotificationEvent(NotificationEvent event) Fired on notification event.
void	pauseAllMusic() Pauses all currently playing music.
void	pauseMusic(Music music) Pauses given music if it was previously started with playSound(Sound).
void	playMusic(Music music) Plays given music based on its properties.
default void	playMusic(String assetName) Convenience method to play the music given its filename.
void	playSound(Sound sound) Plays given sound based on its properties.
default void	playSound(String assetName) Convenience method to play the sound given its filename.
void	resumeAllMusic() Resumes all currently paused music.
void	resumeMusic(Music music) Resumes previously paused pauseMusic(Music) music.
default void	setGlobalMusicVolume(double volume) Set global music volume in the range [0..1], where 0 = 0%, 1 = 100%.
default void	setGlobalSoundVolume(double volume) Set global sound volume in the range [0..1], where 0 = 0%, 1 = 100%.
void	stopAllMusic() Stops all currently playing music.
void	stopAllSounds() Stops playing all sounds.
void	stopMusic(Music music) Stops currently playing music.
void	stopSound(Sound sound) Stops playing given sound.

Methods inherited from interface com.almasb.fxgl.service.listener.UserProfileSavable

load, save

Methods inherited from interface com.almasb.fxgl.time.UpdateEventListener

onUpdateEvent

Property Detail

globalMusicVolume

javafx.beans.property.DoubleProperty globalMusicVolumeProperty

See Also:

getGlobalMusicVolume(), setGlobalMusicVolume(double)

globalSoundVolume

javafx.beans.property.DoubleProperty globalSoundVolumeProperty

See Also:

getGlobalSoundVolume(), setGlobalSoundVolume(double)

Method Detail

onNotificationEvent

default void onNotificationEvent(NotificationEvent event)

Description copied from interface: NotificationListener

Fired on notification event.

Specified by:

onNotificationEvent in interface NotificationListener

Parameters:

event - the notification event

globalMusicVolumeProperty

javafx.beans.property.DoubleProperty globalMusicVolumeProperty()

See Also:

getGlobalMusicVolume(), setGlobalMusicVolume(double)

getGlobalMusicVolume

default double getGlobalMusicVolume()

Returns:

global music volume

setGlobalMusicVolume

default void setGlobalMusicVolume(double volume)

Set global music volume in the range [0..1], where 0 = 0%, 1 = 100%.

Parameters:

volume - music volume

globalSoundVolumeProperty

javafx.beans.property.DoubleProperty globalSoundVolumeProperty()

See Also:

getGlobalSoundVolume(), setGlobalSoundVolume(double)

getGlobalSoundVolume

default double getGlobalSoundVolume()

Returns:

global sound volume

setGlobalSoundVolume

default void setGlobalSoundVolume(double volume)

Set global sound volume in the range [0..1], where 0 = 0%, 1 = 100%.

Parameters:

volume - sound volume

playSound

default void playSound(String assetName)

Convenience method to play the sound given its filename.

Parameters:

assetName - name of the sound file

playMusic

default void playMusic(String assetName)

Convenience method to play the music given its filename.

Parameters:

assetName - name of the music file

playSound

void playSound(Sound sound)

Plays given sound based on its properties.

Parameters:

sound - sound to play

stopSound

void stopSound(Sound sound)

Stops playing given sound.

Parameters:

sound - sound to stop

stopAllSounds

void stopAllSounds()

Stops playing all sounds.

playMusic

void playMusic(Music music)

Plays given music based on its properties. If the music has been paused, you need to call resumeMusic(Music) instead.

Parameters:

music - music to play

Throws:

IllegalArgumentException - if the music is already playing / paused

pauseMusic

void pauseMusic(Music music)

Pauses given music if it was previously started with playSound(Sound). It can then be restarted by resumeMusic(Music).

Parameters:

music - music to pause

resumeMusic

void resumeMusic(Music music)

Resumes previously paused pauseMusic(Music) music.

Parameters:

music - music to resume

stopMusic

void stopMusic(Music music)

Stops currently playing music. It cannot be restarted using resumeMusic(Music). The music object needs to be started again by playMusic(Music).

Parameters:

music - music to stop

pauseAllMusic

void pauseAllMusic()

Pauses all currently playing music. These can be resumed using resumeAllMusic().

resumeAllMusic

void resumeAllMusic()

Resumes all currently paused music.

stopAllMusic

void stopAllMusic()

Stops all currently playing music. The music cannot be restarted by calling resumeAllMusic(). Each music object will need to be started by playMusic(Music).