Package jmri.jmrit.vsdecoder

Class VSDSound

java.lang.Object

jmri.jmrit.vsdecoder.VSDSound

Direct Known Subclasses:

ConfigurableSound, EngineSound, SoundBite

public abstract class VSDSound
extends java.lang.Object

Superclass for all Sound types. 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.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static java.lang.String	BufSysNamePrefix
(package private) static java.lang.String	BufUserNamePrefix
(package private) static float	default_exponent
(package private) static float	default_gain
(package private) static float	default_reference_distance
(package private) static int	default_sleep_interval
(package private) float	gain
(package private) boolean	is_tunnel
(package private) PhysicalLocation	myposition
(package private) java.lang.String	name
(package private) static java.lang.String	SrcSysNamePrefix
(package private) static java.lang.String	SrcUserNamePrefix
(package private) javax.swing.Timer	t
(package private) static float	tunnel_volume
(package private) float	volume

Constructor Summary

Constructors

Constructor	Description
VSDSound(java.lang.String name)

Method Summary

Modifier and Type	Method	Description
(package private) int	attachSourcesToEffects()
void	changeNotch(int new_notch)
void	changeThrottle(float t)
(package private) boolean	checkForFreeBuffer()
(package private) int	detachSourcesToEffects()
abstract void	fadeIn()
abstract void	fadeOut()
float	getGain()
java.lang.String	getName()
PhysicalLocation	getPosition()
(package private) boolean	getTunnel()
org.jdom2.Element	getXml()
abstract void	loop()
abstract void	mute(boolean m)
protected javax.swing.Timer	newTimer(int time, boolean repeat, java.awt.event.ActionListener al)
abstract void	play()
void	setGain(float g)
void	setName(java.lang.String n)
void	setPosition(PhysicalLocation p)
(package private) void	setTunnel(boolean t)
abstract void	setVolume(float g)
void	setXml(org.jdom2.Element e)
abstract void	shutdown()
abstract void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

SrcSysNamePrefix

static final java.lang.String SrcSysNamePrefix

See Also:

Constant Field Values

BufSysNamePrefix

static final java.lang.String BufSysNamePrefix

See Also:

Constant Field Values

SrcUserNamePrefix

static final java.lang.String SrcUserNamePrefix

See Also:

Constant Field Values

BufUserNamePrefix

static final java.lang.String BufUserNamePrefix

See Also:

Constant Field Values

default_exponent

static final float default_exponent

See Also:

Constant Field Values

default_gain

static final float default_gain

See Also:

Constant Field Values

default_reference_distance

static final float default_reference_distance

See Also:

Constant Field Values

tunnel_volume

static final float tunnel_volume

See Also:

Constant Field Values

default_sleep_interval

static final int default_sleep_interval

See Also:

Constant Field Values

t

javax.swing.Timer t

is_tunnel

boolean is_tunnel

name

java.lang.String name

gain

float gain

volume

float volume

myposition

PhysicalLocation myposition

Constructor Detail

VSDSound

public VSDSound(java.lang.String name)

Method Detail

newTimer

protected javax.swing.Timer newTimer(int time,
                                     boolean repeat,
                                     java.awt.event.ActionListener al)

play

public abstract void play()

loop

public abstract void loop()

stop

public abstract void stop()

fadeIn

public abstract void fadeIn()

fadeOut

public abstract void fadeOut()

mute

public abstract void mute(boolean m)

setVolume

public abstract void setVolume(float g)

shutdown

public abstract void shutdown()

setPosition

public void setPosition(PhysicalLocation p)

getPosition

public PhysicalLocation getPosition()

changeNotch

public void changeNotch(int new_notch)

changeThrottle

public void changeThrottle(float t)

setName

public void setName(java.lang.String n)

getName

public java.lang.String getName()

getGain

public float getGain()

setGain

public void setGain(float g)

attachSourcesToEffects

int attachSourcesToEffects()

detachSourcesToEffects

int detachSourcesToEffects()

setTunnel

void setTunnel(boolean t)

getTunnel

boolean getTunnel()

checkForFreeBuffer

boolean checkForFreeBuffer()

getXml

public org.jdom2.Element getXml()

setXml

public void setXml(org.jdom2.Element e)