All Superinterfaces:: Comparable<NamedBean>, NamedBean, PropertyChangeProvider

All Known Subinterfaces:: AudioBuffer, AudioListener, AudioSource

All Known Implementing Classes:: AbstractAudio, AbstractAudioBuffer, AbstractAudioListener, AbstractAudioSource, JavaSoundAudioBuffer, JavaSoundAudioListener, JavaSoundAudioSource, JoalAudioBuffer, JoalAudioListener, JoalAudioSource, NullAudioBuffer, NullAudioListener, NullAudioSource

public interface Audio
extends NamedBean

Represent an Audio, a place to store or control sound information.

The AbstractAudio class contains a basic implementation of the state and messaging code, and forms a useful start for a system-specific implementation. Specific implementations will convert to and from the hardware commands.

The states and names are Java Bean parameters, so that listeners can be registered to be notified of any changes.

Each Audio object has a two names. The "user" name is entirely free form, and can be used for any purpose. The "system" name is provided by the system-specific implementations, and provides a unique mapping to the layout control system and address within that system.

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.

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.NamedBean
NamedBean.BadNameException, NamedBean.BadSystemNameException, NamedBean.BadUserNameException, NamedBean.DisplayOptions, NamedBean.DuplicateSystemNameException

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`AT`	Definition of Audio object orientation at vector code
`static char`	`BUFFER`	Definition of AudioBuffer NamedBean sub-type code
`static int`	`CMD_BIND_BUFFER`	Command to bind Buffer to Source
`static int`	`CMD_FADE_IN`	Command to fade in and start playback of this Source
`static int`	`CMD_FADE_OUT`	Command to fade out and stop playback of this Source
`static int`	`CMD_INIT_FACTORY`	Command to initialise AudioFactory
`static int`	`CMD_LOAD_SOUND`	Command to load the sound
`static int`	`CMD_PAUSE`	Command to pause playback of this Source and retain the position
`static int`	`CMD_PAUSE_TOGGLE`	Command to pause or resume this Source from the current position
`static int`	`CMD_PLAY`	Command to play this Source from the beginning
`static int`	`CMD_PLAY_TOGGLE`	Command to start or stop this Source from the beginning
`static int`	`CMD_QUEUE_BUFFERS`	Command to queue Buffer to Source
`static int`	`CMD_RESET_POSITION`	Command to reset the position of this Source
`static int`	`CMD_RESUME`	Command to resume playback of this Source from the current position
`static int`	`CMD_REWIND`	Command to rewind this Source to the beginning
`static int`	`CMD_STOP`	Command to stop playing this Source and rewind to the start
`static int`	`CMD_UNQUEUE_BUFFERS`	Command to unqueue used Buffers from Source
`static double`	`DECIMAL_PLACES`	Number of decimal places for float values to be stored in
`static int`	`FADE_IN`	Fade state of Source when fading in
`static int`	`FADE_NONE`	Fade state of Source when not fading
`static int`	`FADE_OUT`	Fade state of Source when fading out
`static char`	`LISTENER`	Definition of AudioListener NamedBean sub-type code
`static float`	`MAX_DISTANCE`	Maximum distance for Audio objects
`static char`	`SOURCE`	Definition of AudioSource NamedBean sub-type code
`static int`	`STATE_EMPTY`	State code for an AudioBuffer when empty
`static int`	`STATE_INITIAL`	Default state for any newly created Audio object
`static int`	`STATE_LOADED`	State code for an AudioBuffer when loaded
`static int`	`STATE_MOVING`	State code for an AudioListener when moving
`static int`	`STATE_PLAYING`	State code for an AudioSource when playing
`static int`	`STATE_POSITIONED`	State code for an AudioListener when positioned
`static int`	`STATE_STOPPED`	State code for an AudioSource when stopped
`static int`	`UP`	Definition of Audio object orientation up vector code

Fields inherited from interface jmri.NamedBean

DISPLAY_NAME_FORMAT, INCONSISTENT, PROPERTY_STATE, QUOTED_NAME_FORMAT, UNKNOWN

Method Summary

Modifier and Type	Method	Description
`char`	`getSubType()`	An Audio object can represent one of a number of subtypes of object.
`void`	`stateChanged(int oldState)`	Method used to update the current state of the Audio object

Methods inherited from interface jmri.NamedBean

addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, describeState, dispose, getBeanType, getComment, getDisplayName, getDisplayName, getFullyFormattedDisplayName, getFullyFormattedDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getState, getSystemName, getUsageReport, getUserName, removeProperty, setComment, setProperty, setState, setUserName, toString, updateListenerRef, vetoableChange

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Field Details
- SOURCE
  
  static final char SOURCE
  
  Definition of AudioSource NamedBean sub-type code
  
  See Also:
  
  Constant Field Values
- BUFFER
  
  static final char BUFFER
  
  Definition of AudioBuffer NamedBean sub-type code
  
  See Also:
  
  Constant Field Values
- LISTENER
  
  static final char LISTENER
  
  Definition of AudioListener NamedBean sub-type code
  
  See Also:
  
  Constant Field Values
- AT
  
  static final int AT
  
  Definition of Audio object orientation at vector code
  
  See Also:
  
  Constant Field Values
- UP
  
  static final int UP
  
  Definition of Audio object orientation up vector code
  
  See Also:
  
  Constant Field Values
- STATE_INITIAL
  
  static final int STATE_INITIAL
  
  Default state for any newly created Audio object
  
  See Also:
  
  Constant Field Values
- STATE_STOPPED
  
  static final int STATE_STOPPED
  
  State code for an AudioSource when stopped
  
  See Also:
  
  Constant Field Values
- STATE_PLAYING
  
  static final int STATE_PLAYING
  
  State code for an AudioSource when playing
  
  See Also:
  
  Constant Field Values
- STATE_EMPTY
  
  static final int STATE_EMPTY
  
  State code for an AudioBuffer when empty
  
  See Also:
  
  Constant Field Values
- STATE_LOADED
  
  static final int STATE_LOADED
  
  State code for an AudioBuffer when loaded
  
  See Also:
  
  Constant Field Values
- STATE_POSITIONED
  
  static final int STATE_POSITIONED
  
  State code for an AudioListener when positioned
  
  See Also:
  
  Constant Field Values
- STATE_MOVING
  
  static final int STATE_MOVING
  
  State code for an AudioListener when moving
  
  See Also:
  
  Constant Field Values
- CMD_INIT_FACTORY
  
  static final int CMD_INIT_FACTORY
  
  Command to initialise AudioFactory
  
  See Also:
  
  Constant Field Values
- CMD_LOAD_SOUND
  
  static final int CMD_LOAD_SOUND
  
  Command to load the sound
  
  See Also:
  
  Constant Field Values
- CMD_BIND_BUFFER
  
  static final int CMD_BIND_BUFFER
  
  Command to bind Buffer to Source
  
  See Also:
  
  Constant Field Values
- CMD_QUEUE_BUFFERS
  
  static final int CMD_QUEUE_BUFFERS
  
  Command to queue Buffer to Source
  
  See Also:
  
  Constant Field Values
- CMD_UNQUEUE_BUFFERS
  
  static final int CMD_UNQUEUE_BUFFERS
  
  Command to unqueue used Buffers from Source
  
  See Also:
  
  Constant Field Values
- CMD_PLAY
  
  static final int CMD_PLAY
  
  Command to play this Source from the beginning
  
  See Also:
  
  Constant Field Values
- CMD_STOP
  
  static final int CMD_STOP
  
  Command to stop playing this Source and rewind to the start
  
  See Also:
  
  Constant Field Values
- CMD_PLAY_TOGGLE
  
  static final int CMD_PLAY_TOGGLE
  
  Command to start or stop this Source from the beginning
  
  See Also:
  
  Constant Field Values
- CMD_PAUSE
  
  static final int CMD_PAUSE
  
  Command to pause playback of this Source and retain the position
  
  See Also:
  
  Constant Field Values
- CMD_RESUME
  
  static final int CMD_RESUME
  
  Command to resume playback of this Source from the current position
  
  See Also:
  
  Constant Field Values
- CMD_PAUSE_TOGGLE
  
  static final int CMD_PAUSE_TOGGLE
  
  Command to pause or resume this Source from the current position
  
  See Also:
  
  Constant Field Values
- CMD_REWIND
  
  static final int CMD_REWIND
  
  Command to rewind this Source to the beginning
  
  See Also:
  
  Constant Field Values
- CMD_FADE_IN
  
  static final int CMD_FADE_IN
  
  Command to fade in and start playback of this Source
  
  See Also:
  
  Constant Field Values
- CMD_FADE_OUT
  
  static final int CMD_FADE_OUT
  
  Command to fade out and stop playback of this Source
  
  See Also:
  
  Constant Field Values
- CMD_RESET_POSITION
  
  static final int CMD_RESET_POSITION
  
  Command to reset the position of this Source
  
  See Also:
  
  Constant Field Values
- FADE_NONE
  
  static final int FADE_NONE
  
  Fade state of Source when not fading
  
  See Also:
  
  Constant Field Values
- FADE_OUT
  
  static final int FADE_OUT
  
  Fade state of Source when fading out
  
  See Also:
  
  Constant Field Values
- FADE_IN
  
  static final int FADE_IN
  
  Fade state of Source when fading in
  
  See Also:
  
  Constant Field Values
- MAX_DISTANCE
  
  static final float MAX_DISTANCE
  
  Maximum distance for Audio objects
  
  See Also:
  
  Constant Field Values
- DECIMAL_PLACES
  
  static final double DECIMAL_PLACES
  
  Number of decimal places for float values to be stored in
  
  See Also:
  
  Constant Field Values
Method Details
- getSubType
  
  char getSubType()
  An Audio object can represent one of a number of subtypes of object.
  This method enables us to determine which of those subtypes this particular instance is and be able to process accordingly.
  Current supported subtypes are:
  
  B = Buffer
  L = Listener
  S = Source
  Returns:
  
  subType char
- stateChanged
  
  void stateChanged(int oldState)
  
  Method used to update the current state of the Audio object
  
  Parameters:
  
  oldState - the former state

Interface Audio

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.NamedBean

Field Summary

Fields inherited from interface jmri.NamedBean

Method Summary

Methods inherited from interface jmri.NamedBean

Methods inherited from interface jmri.beans.PropertyChangeProvider

Field Details

Method Details