net.stemkoski.bagel

Class Audio

java.lang.Object

net.stemkoski.bagel.Audio

public class Audio
extends java.lang.Object

Load an audio file (sound or music).

Sound files are typically small, short audio files that are played when discrete game events occur (such as when an item is collected, or when two objects collide). Sound files are completely loaded into memory.

Music files are typically large, long audio files containing background music that is played continuously during the game. Music files are streamed from a file as they are played.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) javafx.scene.media.Media	music
(package private) javafx.scene.media.MediaPlayer	musicPlayer
(package private) javafx.scene.media.AudioClip	sound

Constructor Summary

Constructors

Constructor and Description
Audio() Empty constructor for internal methods; use loadMusic(String) or loadSound(String) to create an instance.

Method Summary

Modifier and Type	Method and Description
static Audio	loadMusic(java.lang.String fileName) Create an audio object from a music file.
static Audio	loadSound(java.lang.String fileName) Create an audio object from a sound file.
void	play() Play the loaded audio file.
void	setLoop(boolean loop) Set whether this audio should repeat forever or play once.
void	setVolume(double volume) Set volume of audio playback.
void	stop() Stop the audio from currently playing.

Methods inherited from class java.lang.Object

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

Field Detail

sound

javafx.scene.media.AudioClip sound

music

javafx.scene.media.Media music

musicPlayer

javafx.scene.media.MediaPlayer musicPlayer

Constructor Detail

Audio

Audio()

Empty constructor for internal methods; use loadMusic(String) or loadSound(String) to create an instance.

Method Detail

loadSound

public static Audio loadSound(java.lang.String fileName)

Create an audio object from a sound file.

Parameters:

fileName - name of the sound file

Returns:

an Audio object

loadMusic

public static Audio loadMusic(java.lang.String fileName)

Create an audio object from a music file.

Parameters:

fileName - name of the music file

Returns:

an Audio object

setLoop

public void setLoop(boolean loop)

Set whether this audio should repeat forever or play once.

Parameters:

loop - whether this audio should repeat forever

setVolume

public void setVolume(double volume)

Set volume of audio playback.

Parameters:

volume - value between 0.0 (silent) and 1.0 (original volume).

play

public void play()

Play the loaded audio file.

stop

public void stop()

Stop the audio from currently playing.