Engine Audio Updater Role Parameters

Detailed Description

Collaboration diagram for Engine Audio Updater Role Parameters:

Variables
constexpr const char *	EngineAudioUpdaterConfig::audioPath = "audioPath"
constexpr const char *	EngineAudioUpdaterConfig::engineOnAttribute = "engineOnAttribute"
constexpr const char *	EngineAudioUpdaterConfig::engineOnName = "engineOnName"
constexpr const char *	EngineAudioUpdaterConfig::sources = "sources"

Variable Documentation

audioPath

const char* EngineAudioUpdaterConfig::audioPath = "audioPath"

constexpr

Parameter Name	audioPath
Parameter Description	Base path for locating audio files.
Parameter Type	string
Parameter Default	"$(SHARED_DATA_DIR)/Audio/"
Required?	No

Example Role Config Usage:

["engineAudioUpdater"] = { 
   ... 
   audioPath = "$(SHARED_DATA_DIR)/Audio/"; 
   ... 
};

engineOnAttribute

const char* EngineAudioUpdaterConfig::engineOnAttribute = "engineOnAttribute"

constexpr

Parameter Name	engineOnAttribute
Parameter Description	Name of the boolean state attribute that controls engine on/off state.
Parameter Type	string
Parameter Default	"engine-on"
Required?	No

Example Role Config Usage:

["engineAudioUpdater"] = { 
   ... 
   engineOnAttribute = "engine-on"; 
   ... 
};

engineOnName

const char* EngineAudioUpdaterConfig::engineOnName = "engineOnName"

constexpr

Parameter Name	engineOnName
Parameter Description	Legacy name for the engine on/off attribute (use engineOnAttribute instead).
Parameter Type	string
Parameter Default	"engine-on"
Required?	No

Example Role Config Usage:

["engineAudioUpdater"] = { 
   ... 
   engineOnName = "engine-on"; 
   ... 
};

sources

const char* EngineAudioUpdaterConfig::sources = "sources"

constexpr

Parameter Name	sources
Parameter Description	Table of engine audio sources with RPM-based modulation settings.
Parameter Type	table
Parameter Default	""
Required?	No

Example Role Config Usage:

["engineAudioUpdater"] = { 
   ... 
   sources = ""; 
   ... 
};