Common operations on audio objects
More...
|
| static string[] | GetMixers () |
| | Retrieve the list of mixers (aka VCAs) More...
|
| |
| static float | GetVolume (string mixer) |
| | Get the volume of an audio mixer More...
|
| |
| static float | GetVolumeOutput (string mixer) |
| | Get the volume of an audio mixer at output time (this is influenced by the mixer volume and master volume) More...
|
| |
| static void | SetVolume (float volume, string mixer) |
| | Set the volume of an audio mixer (like a VCA aka Voltage-Controlled Amplifier) More...
|
| |
| static void | SetVolumeMaster (float volume) |
| | Set the volume for all future audio More...
|
| |
Common operations on audio objects
◆ GetMixers()
| static string [] TechbloxModdingAPI.Utility.AudioTools.GetMixers |
( |
| ) |
|
|
inlinestatic |
Retrieve the list of mixers (aka VCAs)
- Returns
- The names of the mixers (without "vca:/")
◆ GetVolume()
| static float TechbloxModdingAPI.Utility.AudioTools.GetVolume |
( |
string |
mixer | ) |
|
|
inlinestatic |
Get the volume of an audio mixer
- Parameters
-
| mixer | The name of the mixer |
- Returns
- The volume
◆ GetVolumeOutput()
| static float TechbloxModdingAPI.Utility.AudioTools.GetVolumeOutput |
( |
string |
mixer | ) |
|
|
inlinestatic |
Get the volume of an audio mixer at output time (this is influenced by the mixer volume and master volume)
- Parameters
-
| mixer | The name of the mixer |
- Returns
- The final volume
◆ SetVolume()
| static void TechbloxModdingAPI.Utility.AudioTools.SetVolume |
( |
float |
volume, |
|
|
string |
mixer |
|
) |
| |
|
inlinestatic |
Set the volume of an audio mixer (like a VCA aka Voltage-Controlled Amplifier)
- Parameters
-
| volume | The volume from 0.0 to 1.0 (1.0+ is valid too) |
| mixer | The name of the mixer, as retrieved from GetMixers() |
◆ SetVolumeMaster()
| static void TechbloxModdingAPI.Utility.AudioTools.SetVolumeMaster |
( |
float |
volume | ) |
|
|
inlinestatic |
Set the volume for all future audio
- Parameters
-
| volume | The volume from 0.0 to 1.0 (1.0+ is valid too) |
The documentation for this class was generated from the following file:
