com.SIMRacingApps.SIMPluginCallbacks.Sounds

Class Shift

java.lang.Object

com.SIMRacingApps.SIMPluginCallbacks.SIMPluginCallback

com.SIMRacingApps.SIMPluginCallbacks.Sounds.Shift

All Implemented Interfaces:

SIMPlugin.Callback

public class Shift
extends SIMPluginCallback

This plug-in will beep when it is time to shift. You can control its behavior with the following variables.

    shift-device = A Sound Device
    shift-volume = 100.0
    shift-replay = false
    shift-clip = com/SIMRacingApps/SIMPluginCallbacks/Sounds/Clips/shift_beep.wav
    
 #Also these global settings will be used if the specific settings above are not set.
    sound-device = A Sound Device Name
    sound-volume = 100.0
 

Setting the volume zero(0) will disable the sounds. The volume is a percentage from 0.0 to 1.0 or 1.1 to 100.0

Since:

1.0

Author:

Jeffrey Gilliam

Copyright:

Copyright (C) 2015 - 2024 Jeffrey Gilliam

License:

Apache License 2.0

Constructor Summary

Constructors

Constructor and Description
Shift(SIMPlugin SIMPlugin) Constructor.

Method Summary

Modifier and Type	Method and Description
void	destroy() Called when the SIMPlugin is destroyed.
Data	getVolume() Gets the volume as a percentage.
boolean	ProcessData(SIMPlugin SIMPlugin, java.util.Map<java.lang.String,Data> data) ProcessData is called from within the dedicated thread for this plug-in every time there is data available in the queue it pops it off the queue and passes it to this method.
Data	setVolume(double percentage) Sets the volume as a percentage.
Data	setVolume(java.lang.String percentage)

Methods inherited from class com.SIMRacingApps.SIMPluginCallbacks.SIMPluginCallback

DataReady, Waiting

Methods inherited from class java.lang.Object

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

Constructor Detail

Shift

public Shift(SIMPlugin SIMPlugin)
      throws SIMPlugin.SIMPluginException

Constructor. This plug-in watches for your distance from you pit stall and counts you down.

Parameters:

SIMPlugin - An instance of the current SIM.

Throws:

SIMPlugin.SIMPluginException - If there's a problem constructing your plug-in.

Method Detail

destroy

public void destroy()

Called when the SIMPlugin is destroyed. It's always best to call super.destroy() for future compatibility.

Overrides:

destroy in class SIMPluginCallback

getVolume

public Data getVolume()

Gets the volume as a percentage.

PATH = /SIMPluginCallback/Sounds/Shift/Volume

Returns:

The new volume percentage in a Data container.

setVolume

public Data setVolume(double percentage)

Sets the volume as a percentage. Range 0.0 to 100.0

PATH = /SIMPluginCallback/Sounds/Shift/setVolume/(PERCENTAGE)

Parameters:

percentage - The new volume percentage, between 0.0 and 100.0.

Returns:

The new volume percentage in a Data container.

setVolume

public Data setVolume(java.lang.String percentage)

ProcessData

public boolean ProcessData(SIMPlugin SIMPlugin,
                           java.util.Map<java.lang.String,Data> data)

Description copied from class: SIMPluginCallback

ProcessData is called from within the dedicated thread for this plug-in every time there is data available in the queue it pops it off the queue and passes it to this method. A should override this method to implement your plug-in's functionality. If this method takes too long to process the data in the queue, you could miss data that the SIM is sending. Design accordingly. There's no way to even guarantee that you will get every update from the SIM. At this point in the design, ProcessData will get called on the same frequency as the SIM (typically 16ms). At some point, I may change it to only get called if the subscribed to data changes. NOTE: If you find you need to use the SIMPlugin argument, inclose it in a synchronized block. You are in a separate thread, so this will block the main thread. Do not keep it locked very long.

     //When calling the SIMPlugin from this method, you must synchronize on it first. It is not thread safe.
     Data d;
     synchronized (SIMPlugin) {
         //do not spend much time in here, we are blocking the main thread 
         //Get the data and get out of the synchronized block 
         d = SIMPlugin.getData("/Session/IsGreenFlag");
         d = SIMPlugin.getSession().getIsGreenFlag();
     }
     //do something with the data
 

Overrides:

ProcessData in class SIMPluginCallback

Parameters:

SIMPlugin - A reference to the SIMPlugin instance.

data - The Data objects added to the queue.

Returns:

true to keep the plug-in alive, false to kill it.