Master Audio - AAA Sound Solution! v2024
The ultimate AAA audio config tool
Loading...
Searching...
No Matches
DarkTonic.MasterAudio.MusicSetting Class Reference

This class is used to populate a song for a PlaylistController through code if necessary. More...

Public Attributes

string alias = string.Empty
 The alias for the song
 
MasterAudio.AudioLocation audLocation = MasterAudio.AudioLocation.Clip
 This setting allows you to choose Audio Clip, Resource File or Addressable
 
AudioClip clip
 The Audio Clip for the song, if you're using AudioLocation of Clip
 
string songName = string.Empty
 Do not set this. It is calculated from the clip's name or alias if it has one.
 
string resourceFileName = string.Empty
 This is the path to the Resource File if you're using AudioLocation of Resource File
 
AssetReference audioClipAddressable
 This is the AssetReference to the clip if you're using AudioLocation of Addressable
 
float volume = 1f
 The volume to use when playing the song.
 
float pitch = 1f
 The pitch to play the song at.
 
bool isExpanded = true
 Do not set this. It is for Inspector only.
 
bool isLoop
 Whether to loop the song or not.
 
bool isChecked = true
 Do not set this, it is for Inspector only
 
List< SongMetadataStringValue > metadataStringValues = new List<SongMetadataStringValue>()
 Do not set this, it is for Inspector only
 
List< SongMetadataBoolValue > metadataBoolValues = new List<SongMetadataBoolValue>()
 Do not set this, it is for Inspector only
 
List< SongMetadataIntValue > metadataIntValues = new List<SongMetadataIntValue>()
 Do not set this, it is for Inspector only
 
List< SongMetadataFloatValue > metadataFloatValues = new List<SongMetadataFloatValue>()
 Do not set this, it is for Inspector only
 
bool metadataExpanded = true
 Do not set this, it is for Inspector only
 
MasterAudio.CustomSongStartTimeMode songStartTimeMode = MasterAudio.CustomSongStartTimeMode.Beginning
 This controls where the song starts from.
 
float customStartTime
 If you choose Random Time for Begin Song Time Node, it will start between customStartTime (min) and customStartTimeMax, randomly.
 
float customStartTimeMax
 If you choose Random Time for Begin Song Time Node, it will start between customStartTime (min) and customStartTimeMax, randomly.
 
int lastKnownTimePoint = 0
 Do not set this value, used by "New Clip From Last Known Position" mode of Song Transition Mode and set automatically.
 
bool wasLastKnownTimePointSet = false
 Do not set this value, used by "New Clip From Last Known Position" mode of Song Transition Mode and set automatically.
 
int songIndex = 0
 Set this uniquely for each song as consecutive integers, used to keep track of which songs haven't played yet.
 
float sectionStartTime = 0f
 This is used for loopable section of a song.
 
float sectionEndTime = 0f
 This is used for loopable section of a song.
 
bool songStartedEventExpanded
 Set this to true if you are going to use songStartedCustomEvent
 
string songStartedCustomEvent = string.Empty
 This is the name of a Custom Event to fire when the song is started.
 
bool songChangedEventExpanded
 Set this to true if you are going to use songChangedCustomEvent
 
string songChangedCustomEvent = string.Empty
 This is the name of a Custom Event to fire when the song is changed to another.
 

Detailed Description

This class is used to populate a song for a PlaylistController through code if necessary.


The documentation for this class was generated from the following file: