Package jmri.jmrit.vsdecoder

Class SoundBite

java.lang.Object

jmri.jmrit.vsdecoder.VSDSound

jmri.jmrit.vsdecoder.SoundBite

Direct Known Subclasses:

NotchTransition

class SoundBite
extends VSDSound

VSD implementation of an audio sound. 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 inherited from class jmri.jmrit.vsdecoder.VSDSound

BufSysNamePrefix, BufUserNamePrefix, default_exponent, default_gain, default_reference_distance, default_sleep_interval, gain, is_tunnel, myposition, name, SrcSysNamePrefix, SrcUserNamePrefix, t, tunnel_volume, volume

Constructor Summary

Constructors

Constructor	Description
SoundBite(java.lang.String name)
SoundBite(VSDFile vf, java.lang.String filename, java.lang.String sname, java.lang.String uname)

Method Summary

Modifier and Type	Method	Description
(package private) int	attachSourcesToEffects()	Method to attach a source to effects
static long	calcLength(AudioBuffer buf)
static long	calcLength(SoundBite s)
(package private) int	detachSourcesToEffects()	Method to detach a source to effects
void	fadeIn()
void	fadeOut()
AudioBuffer	getBuffer()
java.lang.String	getBufferSystemName()
java.lang.String	getBufferUserName()
int	getFadeInTime()
int	getFadeOutTime()
java.lang.String	getFileName()
long	getLength()
int	getLengthAsInt()
float	getReferenceDistance()
AudioSource	getSource()
java.lang.String	getSourceSystemName()
java.lang.String	getSourceUserName()
java.lang.String	getSystemName()
java.lang.String	getUserName()
(package private) boolean	isInitialized()
void	loop()
void	mute(boolean m)
int	numQueuedBuffers()
void	pause()
void	play()
void	queueBuffer(AudioBuffer b)
void	rewind()
void	setFadeInTime(int t)
void	setFadeOutTime(int t)
void	setFadeTimes(int in, int out)
void	setLength()
void	setLength(long p)
void	setLooped(boolean loop)
void	setPosition(PhysicalLocation v)
void	setReferenceDistance(float r)
void	setURL(java.lang.String filename)
void	setVolume(float v)
void	shutdown()
void	stop()
void	unqueueBuffers()

Methods inherited from class jmri.jmrit.vsdecoder.VSDSound

changeNotch, changeThrottle, checkForFreeBuffer, getGain, getName, getPosition, getTunnel, getXml, newTimer, setGain, setName, setTunnel, setXml

Methods inherited from class java.lang.Object

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

Constructor Detail

SoundBite

public SoundBite(java.lang.String name)

SoundBite

public SoundBite(VSDFile vf,
                 java.lang.String filename,
                 java.lang.String sname,
                 java.lang.String uname)

Method Detail

getFileName

public java.lang.String getFileName()

getSystemName

public java.lang.String getSystemName()

getUserName

public java.lang.String getUserName()

isInitialized

final boolean isInitialized()

queueBuffer

public void queueBuffer(AudioBuffer b)

unqueueBuffers

public void unqueueBuffers()

numQueuedBuffers

public int numQueuedBuffers()

getSource

public AudioSource getSource()

getBuffer

public AudioBuffer getBuffer()

getSourceSystemName

public java.lang.String getSourceSystemName()

getSourceUserName

public java.lang.String getSourceUserName()

getBufferSystemName

public java.lang.String getBufferSystemName()

getBufferUserName

public java.lang.String getBufferUserName()

setLooped

public void setLooped(boolean loop)

getFadeInTime

public int getFadeInTime()

getFadeOutTime

public int getFadeOutTime()

setFadeInTime

public void setFadeInTime(int t)

setFadeOutTime

public void setFadeOutTime(int t)

setFadeTimes

public void setFadeTimes(int in,
                         int out)

getReferenceDistance

public float getReferenceDistance()

setReferenceDistance

public void setReferenceDistance(float r)

shutdown

public void shutdown()

Specified by:

shutdown in class VSDSound

mute

public void mute(boolean m)

Specified by:

mute in class VSDSound

setVolume

public void setVolume(float v)

Specified by:

setVolume in class VSDSound

play

public void play()

Specified by:

play in class VSDSound

loop

public void loop()

Specified by:

loop in class VSDSound

stop

public void stop()

Specified by:

stop in class VSDSound

pause

public void pause()

rewind

public void rewind()

fadeOut

public void fadeOut()

Specified by:

fadeOut in class VSDSound

fadeIn

public void fadeIn()

Specified by:

fadeIn in class VSDSound

setPosition

public void setPosition(PhysicalLocation v)

Overrides:

setPosition in class VSDSound

attachSourcesToEffects

int attachSourcesToEffects()

Method to attach a source to effects

Overrides:

attachSourcesToEffects in class VSDSound

Returns:

0 when failed, 1 when successful

detachSourcesToEffects

int detachSourcesToEffects()

Method to detach a source to effects

Overrides:

detachSourcesToEffects in class VSDSound

Returns:

0 when failed, 1 when successful

setURL

public void setURL(java.lang.String filename)

getLength

public long getLength()

getLengthAsInt

public int getLengthAsInt()

setLength

public void setLength(long p)

setLength

public void setLength()

calcLength

public static long calcLength(SoundBite s)

calcLength

public static long calcLength(AudioBuffer buf)