Package jmri.jmrit.audio
Class NullAudioFactory
- java.lang.Object
-
- jmri.jmrit.audio.AbstractAudioFactory
-
- jmri.jmrit.audio.NullAudioFactory
-
- All Implemented Interfaces:
AudioFactory
public class NullAudioFactory extends AbstractAudioFactory
This is the null audio system specific AudioFactory. It is a dummy factory which provides the necessary object generation but does not produce any sound. This will normally only be used when running on a system that has no sound-card installed.
This file is part of JMRI.JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.
JMRI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
-
-
Constructor Summary
Constructors Constructor Description NullAudioFactory()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
cleanup()
Perform any implementation specific clean-up operations.AudioBuffer
createNewBuffer(java.lang.String systemName, java.lang.String userName)
Provide a specific new AudioBuffer object.AudioListener
createNewListener(java.lang.String systemName, java.lang.String userName)
Provide a specific new AudioListener object.AudioSource
createNewSource(java.lang.String systemName, java.lang.String userName)
Provide a specific new AudioSource object.AudioListener
getActiveAudioListener()
Get the currently active Listener object.boolean
init()
Perform any implementation specific initialisation routines.boolean
isInitialised()
Determine if this AudioFactory is initialisedjava.lang.String
toString()
-
Methods inherited from class jmri.jmrit.audio.AbstractAudioFactory
audioCommandQueue, getCommandThread, isDistanceAttenuated, setDistanceAttenuated
-
-
-
-
Constructor Detail
-
NullAudioFactory
public NullAudioFactory()
-
-
Method Detail
-
init
public boolean init()
Description copied from interface:AudioFactory
Perform any implementation specific initialisation routines.- Specified by:
init
in interfaceAudioFactory
- Overrides:
init
in classAbstractAudioFactory
- Returns:
- true, if initialisation successful
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
cleanup
public void cleanup()
Description copied from interface:AudioFactory
Perform any implementation specific clean-up operations.- Specified by:
cleanup
in interfaceAudioFactory
- Overrides:
cleanup
in classAbstractAudioFactory
-
isInitialised
public boolean isInitialised()
Description copied from interface:AudioFactory
Determine if this AudioFactory is initialised- Returns:
- true if initialised
-
createNewBuffer
public AudioBuffer createNewBuffer(java.lang.String systemName, java.lang.String userName)
Description copied from interface:AudioFactory
Provide a specific new AudioBuffer object.- Parameters:
systemName
- for this object instanceuserName
- for this object instance- Returns:
- a new specific AudioBuffer
-
createNewListener
public AudioListener createNewListener(java.lang.String systemName, java.lang.String userName)
Description copied from interface:AudioFactory
Provide a specific new AudioListener object.- Parameters:
systemName
- for this object instanceuserName
- for this object instance- Returns:
- a new specific AudioListener
-
getActiveAudioListener
public AudioListener getActiveAudioListener()
Description copied from interface:AudioFactory
Get the currently active Listener object.- Returns:
- active AudioListener
-
createNewSource
public AudioSource createNewSource(java.lang.String systemName, java.lang.String userName)
Description copied from interface:AudioFactory
Provide a specific new AudioSource object.- Parameters:
systemName
- for this object instanceuserName
- for this object instance- Returns:
- a new specific AudioSource
-
-