This class is used to host and play Playlists. Contains cross-fading, ducking and more!
More...
|
delegate void | SongChangedEventHandler (string newSongName, MusicSetting song) |
| Used for the SongChanged event you can subscribe to
|
|
delegate void | SongEndedEventHandler (string songName) |
| Used for the SongEnded event you can subscribe to
|
|
delegate void | SongLoopedEventHandler (string songName) |
| Used for the SongLooped event you can subscribe to
|
|
delegate void | PlaylistEndedEventHandler () |
| Used for the PlaylistEnded event you can subscribe to
|
|
bool | IsSongPlaying (string songName) |
| This method will tell you if the song you specify by name is playing or not. If it's the current song and paused, this will still return true. More...
|
|
void | ClearQueue () |
| Call this method to clear all songs out of the queued songs list.
|
|
void | ToggleMutePlaylist () |
| This method mutes the Playlist if it's not muted, and vice versa.
|
|
void | MutePlaylist () |
| This method mutes the Playlist.
|
|
void | UnmutePlaylist () |
| This method unmutes the Playlist.
|
|
void | PausePlaylist () |
| This method will pause the Playlist.
|
|
bool | UnpausePlaylist () |
| This method will unpause the Playlist.
|
|
void | StopPlaylist (bool onlyFadingClip=false) |
| This method will Stop the Playlist.
|
|
void | FadeToVolume (float targetVolume, float fadeTime, System.Action callback=null) |
| This method allows you to fade the Playlist to a specified volume over X seconds. More...
|
|
void | PlayRandomSong () |
| This method will play a random song in the current Playlist.
|
|
void | PlayNextSong () |
| This method will play the next song in the current Playlist.
|
|
void | StopPlaylistAfterCurrentSong () |
| This method will end the looping of the current song and cancel any scheduled / queued songs. Also turns off auto-advance if it's on to accomplish this.
|
|
void | StopLoopingCurrentSong () |
| This method will end the looping of the current song so the next can play when it's done.
|
|
void | QueuePlaylistClip (string clipName, bool scheduleNow=true) |
| This method will play the song in the current Playlist whose name you specify as soon as the currently playing song is done. The current song, if looping, will have loop turned off by this call. This requires auto-advance to work. More...
|
|
bool | TriggerPlaylistClip (string clipName) |
| This method will play the song in the current Playlist whose name you specify. More...
|
|
void | UpdateMasterVolume () |
| This method is used to update state based on the Playlist Master Volume.
|
|
void | StartPlaylist (string playlistName, string clipName=null) |
| This method is used to start a Playlist whether it's already loaded and playing or not. More...
|
|
void | ChangePlaylist (string playlistName, bool playFirstClip=true, string clipName=null) |
| This method is used to change the current Playlist to a new one, and optionally start it playing. More...
|
|
void | RestartPlaylist (string clipName=null) |
| This method can be called to restart the current Playlist More...
|
|
|
bool | ControllerIsReady [get] |
| This property returns true if the Playlist Controller has already run its Awake method. You should not call any PlaylistController method until it has done so.
|
|
FadeStatus | CurrentFadeStatus [get] |
| This returns the current fade status of a FadeToVolume call, if any is running.
|
|
PlaylistStates | PlaylistState [get] |
| This property returns the current state of the Playlist. Choices are: NotInScene, Stopped, Playing, Paused, Crossfading
|
|
AudioSource | ActiveAudioSource [get] |
| This property returns the active audio source for the PlaylistControllers in the Scene. During cross-fading, the one fading in is returned, not the one fading out.
|
|
static List< PlaylistController > | Instances [get, set] |
| This property returns all the PlaylistControllers in the Scene.
|
|
GameObject | PlaylistControllerGameObject [get] |
| This property returns the GameObject for the PlaylistController's GameObject.
|
|
AudioSource | CurrentPlaylistSource [get] |
| This property returns the current Audio Source for the current Playlist song that is playing.
|
|
AudioClip | CurrentPlaylistClip [get] |
| This property returns the current Audio Clip for the current Playlist song that is playing.
|
|
AudioClip | FadingPlaylistClip [get] |
| This property returns the currently fading out Audio Clip for the Playlist (null if not during cross-fading).
|
|
AudioSource | FadingSource [get] |
| This property returns the currently fading out Audio Source for the Playlist (null if not during cross-fading).
|
|
bool | IsCrossFading [get] |
| This property returns whether or not the Playlist is currently cross-fading.
|
|
bool | IsFading [get] |
| This property returns whether or not the Playlist is currently cross-fading or doing another fade.
|
|
float | PlaylistVolume [get, set] |
| This property gets and sets the volume of the Playlist Controller with Master Playlist Volume taken into account.
|
|
MasterAudio.Playlist | CurrentPlaylist [get] |
| This property returns the current Playlist
|
|
bool | HasPlaylist [get] |
| This property returns whether you have a Playlist assigned to this controller or not.
|
|
string | PlaylistName [get] |
| This property returns the name of the current Playlist
|
|
MusicSetting | CurrentSong [get] |
| This returns the currently playing song. Do not set any fields on the MusicSetting returned. Consider them read-only.
|
|
int | ClipsRemainingInCurrentPlaylist [get] |
| This tells you how many clips still haven't been played in the Playlist.
|
|
This class is used to host and play Playlists. Contains cross-fading, ducking and more!