Master Audio Multiplayer  1.3.8
The ONLY audio framework with extensive turnkey multiplayer features!
DarkTonic.MasterAudio.MusicSetting Class Reference

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

Static Public Member Functions

static MusicSetting Clone (MusicSetting mus, MasterAudio.Playlist aList)
 

Public Attributes

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

Detailed Description

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

Member Data Documentation

string DarkTonic.MasterAudio.MusicSetting.alias = string.Empty

The alias for the song

MasterAudio.AudioLocation DarkTonic.MasterAudio.MusicSetting.audLocation = MasterAudio.AudioLocation.Clip

This setting allows you to choose Audio Clip, Resource File or Addressable

AudioClip DarkTonic.MasterAudio.MusicSetting.clip

The Audio Clip for the song, if you're using AudioLocation of Clip

float DarkTonic.MasterAudio.MusicSetting.customStartTime

If you choose Random Time for Song Start Time Node, it will start between customStartTime (min) and customStartTimeMax, randomly.

float DarkTonic.MasterAudio.MusicSetting.customStartTimeMax

If you choose Random Time for Song Start Time Node, it will start between customStartTime (min) and customStartTimeMax, randomly.

bool DarkTonic.MasterAudio.MusicSetting.isChecked = true

Do not set this, it is for Inspector only

bool DarkTonic.MasterAudio.MusicSetting.isExpanded = true

Do not set this. It is for Inspector only.

bool DarkTonic.MasterAudio.MusicSetting.isLoop

Whether to loop the song or not.

int DarkTonic.MasterAudio.MusicSetting.lastKnownTimePoint = 0

Do not set this value, used by "New Clip From Last Known Position" mode of Song Transition Mode and set automatically.

List<SongMetadataBoolValue> DarkTonic.MasterAudio.MusicSetting.metadataBoolValues = new List<SongMetadataBoolValue>()

Do not set this, it is for Inspector only

bool DarkTonic.MasterAudio.MusicSetting.metadataExpanded = true

Do not set this, it is for Inspector only

List<SongMetadataFloatValue> DarkTonic.MasterAudio.MusicSetting.metadataFloatValues = new List<SongMetadataFloatValue>()

Do not set this, it is for Inspector only

List<SongMetadataIntValue> DarkTonic.MasterAudio.MusicSetting.metadataIntValues = new List<SongMetadataIntValue>()

Do not set this, it is for Inspector only

List<SongMetadataStringValue> DarkTonic.MasterAudio.MusicSetting.metadataStringValues = new List<SongMetadataStringValue>()

Do not set this, it is for Inspector only

float DarkTonic.MasterAudio.MusicSetting.pitch = 1f

The pitch to play the song at.

string DarkTonic.MasterAudio.MusicSetting.resourceFileName = string.Empty

This is the path to the Resource File if you're using AudioLocation of Resource File

string DarkTonic.MasterAudio.MusicSetting.songChangedCustomEvent = string.Empty

This is the name of a Custom Event to fire when the song is changed to another.

bool DarkTonic.MasterAudio.MusicSetting.songChangedEventExpanded

Set this to true if you are going to use songChangedCustomEvent

int DarkTonic.MasterAudio.MusicSetting.songIndex = 0

Set this uniquely for each song as consecutive integers, used to keep track of which songs haven't played yet.

string DarkTonic.MasterAudio.MusicSetting.songName = string.Empty

Do not set this. It is calculated from the clip's name or alias if it has one.

string DarkTonic.MasterAudio.MusicSetting.songStartedCustomEvent = string.Empty

This is the name of a Custom Event to fire when the song is started.

bool DarkTonic.MasterAudio.MusicSetting.songStartedEventExpanded

Set this to true if you are going to use songStartedCustomEvent

MasterAudio.CustomSongStartTimeMode DarkTonic.MasterAudio.MusicSetting.songStartTimeMode = MasterAudio.CustomSongStartTimeMode.Beginning

This controls where the song starts from.

float DarkTonic.MasterAudio.MusicSetting.volume = 1f

The volume to use when playing the song.

bool DarkTonic.MasterAudio.MusicSetting.wasLastKnownTimePointSet = false

Do not set this value, used by "New Clip From Last Known Position" mode of Song Transition Mode and set automatically.


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