|
GF4J 0.9.4 Beta | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--gameframe.engines.jdk12x.CSoundEngine
Java 2 implementation of the sound engine. Uses the well known "hack" to play samples on plain vanilla Java 2 platforms without Java Media Framework. Loads mono/stereo Microsoft PCM RIFF WAVE files.
Inner Class Summary | |
(package private) class |
CSoundEngine.CJava2Music
Implementation of music that implements a Java 2 sound clip. |
(package private) class |
CSoundEngine.CJava2Sample
Implementation of Sound that implements a Java 2 sound clip. |
Field Summary | |
private java.util.Vector |
m_createdMusics
All the musics created through this sound engine. |
private java.util.Vector |
m_createdSamples
All the samples created through this sound engine. |
private java.awt.Component |
m_focusComponent
The focus component that is listened for events. |
private java.lang.String |
m_strDataDirectory
Name of the directory that contains loaded sounds. |
private static CSoundEngine.CJava2Music |
mStatic_currentMusic
The currently playing music. |
private static SoundEngine |
mStatic_soundEngine
The singleton instance of the sound engine. |
Constructor Summary | |
CSoundEngine(java.awt.Component focusComponent,
GameFrameSettings settings)
Constructs a sound engine. |
Method Summary | |
void |
finalize()
Finalises all sounds. |
java.lang.String |
getDataDirectory()
Returns the data directory wherefrom the sounds are loaded. |
java.lang.String |
getDescription()
Returns the (possibly multiline) description of the implementation. |
java.lang.String |
getName()
Returns the short name (max 8 characters) of the implementation "Java2". |
Music |
loadMusic(java.lang.String strFileName)
First tries to load a music file as streamed Microsoft RIFF WAV file, if no such file is found from the current data directory, tries to load a music file in MIDI format. |
Sample |
loadSample(java.lang.String strFileName)
Loads an mono 8-bit 11025 bytes/sec AU formatted sample from the given file name and return an abstract reference for the loaded sound. |
void |
setDataDirectory(java.lang.String strDirectoryName)
Sets the data directory wherefrom the sounds are loaded. |
Methods inherited from class java.lang.Object |
|
Field Detail |
private static SoundEngine mStatic_soundEngine
private static CSoundEngine.CJava2Music mStatic_currentMusic
private java.awt.Component m_focusComponent
private java.util.Vector m_createdSamples
private java.util.Vector m_createdMusics
private java.lang.String m_strDataDirectory
Constructor Detail |
public CSoundEngine(java.awt.Component focusComponent, GameFrameSettings settings)
focusComponent
- The component that needs to be focused in order
for the sound to be played.settings
- The settings object that contains settings for this
sound engine.Method Detail |
public Sample loadSample(java.lang.String strFileName) throws java.io.FileNotFoundException, GameFrameException
loadSample
in interface SoundEngine
strFileName
- The name of the file to be loaded (without the file extension)public Music loadMusic(java.lang.String strFileName) throws java.io.FileNotFoundException, GameFrameException
loadMusic
in interface SoundEngine
fileName
- The name of the file to be loaded (without the file extension)setDataDirectory(java.lang.String)
public void setDataDirectory(java.lang.String strDirectoryName) throws java.io.FileNotFoundException
setDataDirectory
in interface SoundEngine
strDirectoryName
- The name of the directory that contains the sounds.public java.lang.String getDataDirectory()
getDataDirectory
in interface SoundEngine
loadSample(java.lang.String)
,
loadMusic(java.lang.String)
public java.lang.String getName()
getName
in interface SoundEngine
public java.lang.String getDescription()
getDescription
in interface SoundEngine
public void finalize()
finalize
in interface Finalizable
finalize
in class java.lang.Object
|
GF4J 0.9.4 Beta | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |