HKI Core
Public Member Functions | Properties | Private Member Functions | Private Attributes | List of all members
HKI.Core.Audio.AudioSystem Class Reference

The AudioSystem is responsble of the creation and access of the general purpose AudioPlayers. More...

Inheritance diagram for HKI.Core.Audio.AudioSystem:
HKI.Core.Init.IInit

Public Member Functions

void Init ()
 
void PlaySoundClipWithMusicAudioPlayer (SoundClip soundclip)
 
void PlayNextSoundClipOfPlaylistWithMusicAudioPlayer (Playlist playlist)
 
void PlaySoundClipWithAmbientAudioPlayer (SoundClip soundClip)
 
void PlayNextSoundClipOfPlaylistWithAmbientAudioPlayer (Playlist playlist)
 
void PlaySoundClipWithFxAudioPlayer (SoundClip soundClip)
 
void PlayNextSoundClipOfPlaylistWithFxAudioPlayer (Playlist playlist)
 
void PlaySoundClipWithUiFxAudioPlayer (SoundClip soundClip)
 
void PlayNextSoundClipOfPlaylistWithUiFxAudioPlayer (Playlist playlist)
 
void PlaySoundClipWithVoicesAudioPlayer (SoundClip soundClip)
 
void PlayNextSoundClipOfPlaylistWithVoicesAudioPlayer (Playlist playlist)
 
void PlayAudioLocalization (AudioLocalization audioLocalization)
 

Properties

static AudioSystem Instance [get, private set]
 
SimpleAudioPlayer MusicAudioPlayer [get]
 
SimpleAudioPlayer AmbientAudioPlayer [get]
 
SimpleAudioPlayer FxAudioPlayer [get]
 
SimpleAudioPlayer UiFxAudioPlayer [get]
 
SimpleAudioPlayer VoicesAudioPlayer [get]
 

Private Member Functions

void OnDisable ()
 
SimpleAudioPlayer CreateAudioPlayer (string apName, AudioPlayer.AudioPlayerSettings settings)
 

Private Attributes

bool UseMusicAudioPlayer = true
 
AudioPlayer.AudioPlayerSettings MusicAudioPlayerSettings = new AudioPlayer.AudioPlayerSettings()
 
bool UseAmbientAudioPlayer = true
 
AudioPlayer.AudioPlayerSettings AmbientAudioPlayerSettings = new AudioPlayer.AudioPlayerSettings()
 
bool UseFxAudioPlayer = true
 
AudioPlayer.AudioPlayerSettings FxAudioPlayerSettings = new AudioPlayer.AudioPlayerSettings()
 
bool UseUiFxAudioPlayer = true
 
AudioPlayer.AudioPlayerSettings UiFxAudioPlayerSettings = new AudioPlayer.AudioPlayerSettings()
 
bool UseVoicesAudioPlayer = true
 
AudioPlayer.AudioPlayerSettings VoicesAudioPlayerSettings = new AudioPlayer.AudioPlayerSettings()
 
SimpleAudioPlayer musicAudioPlayer = null
 
SimpleAudioPlayer ambientAudioPlayer = null
 
SimpleAudioPlayer fxAudioPlayer = null
 
SimpleAudioPlayer uiFxAudioPlayer = null
 
SimpleAudioPlayer voicesAudioPlayer = null
 
GameObject audioListenerGO = null
 

Detailed Description

The AudioSystem is responsble of the creation and access of the general purpose AudioPlayers.

This ScriptableObject is created automaticaly.

Definition at line 12 of file AudioSystem.cs.

Member Function Documentation

◆ CreateAudioPlayer()

SimpleAudioPlayer HKI.Core.Audio.AudioSystem.CreateAudioPlayer ( string  apName,
AudioPlayer.AudioPlayerSettings  settings 
)
inlineprivate

Definition at line 167 of file AudioSystem.cs.

◆ Init()

void HKI.Core.Audio.AudioSystem.Init ( )
inline

Implements HKI.Core.Init.IInit.

Definition at line 45 of file AudioSystem.cs.

◆ OnDisable()

void HKI.Core.Audio.AudioSystem.OnDisable ( )
inlineprivate

Definition at line 72 of file AudioSystem.cs.

◆ PlayAudioLocalization()

void HKI.Core.Audio.AudioSystem.PlayAudioLocalization ( AudioLocalization  audioLocalization)
inline

Definition at line 161 of file AudioSystem.cs.

◆ PlayNextSoundClipOfPlaylistWithAmbientAudioPlayer()

void HKI.Core.Audio.AudioSystem.PlayNextSoundClipOfPlaylistWithAmbientAudioPlayer ( Playlist  playlist)
inline

Definition at line 114 of file AudioSystem.cs.

◆ PlayNextSoundClipOfPlaylistWithFxAudioPlayer()

void HKI.Core.Audio.AudioSystem.PlayNextSoundClipOfPlaylistWithFxAudioPlayer ( Playlist  playlist)
inline

Definition at line 127 of file AudioSystem.cs.

◆ PlayNextSoundClipOfPlaylistWithMusicAudioPlayer()

void HKI.Core.Audio.AudioSystem.PlayNextSoundClipOfPlaylistWithMusicAudioPlayer ( Playlist  playlist)
inline

Definition at line 101 of file AudioSystem.cs.

◆ PlayNextSoundClipOfPlaylistWithUiFxAudioPlayer()

void HKI.Core.Audio.AudioSystem.PlayNextSoundClipOfPlaylistWithUiFxAudioPlayer ( Playlist  playlist)
inline

Definition at line 140 of file AudioSystem.cs.

◆ PlayNextSoundClipOfPlaylistWithVoicesAudioPlayer()

void HKI.Core.Audio.AudioSystem.PlayNextSoundClipOfPlaylistWithVoicesAudioPlayer ( Playlist  playlist)
inline

Definition at line 153 of file AudioSystem.cs.

◆ PlaySoundClipWithAmbientAudioPlayer()

void HKI.Core.Audio.AudioSystem.PlaySoundClipWithAmbientAudioPlayer ( SoundClip  soundClip)
inline

Definition at line 109 of file AudioSystem.cs.

◆ PlaySoundClipWithFxAudioPlayer()

void HKI.Core.Audio.AudioSystem.PlaySoundClipWithFxAudioPlayer ( SoundClip  soundClip)
inline

Definition at line 122 of file AudioSystem.cs.

◆ PlaySoundClipWithMusicAudioPlayer()

void HKI.Core.Audio.AudioSystem.PlaySoundClipWithMusicAudioPlayer ( SoundClip  soundclip)
inline

Definition at line 96 of file AudioSystem.cs.

◆ PlaySoundClipWithUiFxAudioPlayer()

void HKI.Core.Audio.AudioSystem.PlaySoundClipWithUiFxAudioPlayer ( SoundClip  soundClip)
inline

Definition at line 135 of file AudioSystem.cs.

◆ PlaySoundClipWithVoicesAudioPlayer()

void HKI.Core.Audio.AudioSystem.PlaySoundClipWithVoicesAudioPlayer ( SoundClip  soundClip)
inline

Definition at line 148 of file AudioSystem.cs.

Member Data Documentation

◆ ambientAudioPlayer

SimpleAudioPlayer HKI.Core.Audio.AudioSystem.ambientAudioPlayer = null
private

Definition at line 30 of file AudioSystem.cs.

◆ AmbientAudioPlayerSettings

AudioPlayer.AudioPlayerSettings HKI.Core.Audio.AudioSystem.AmbientAudioPlayerSettings = new AudioPlayer.AudioPlayerSettings()
private

Definition at line 20 of file AudioSystem.cs.

◆ audioListenerGO

GameObject HKI.Core.Audio.AudioSystem.audioListenerGO = null
private

Definition at line 35 of file AudioSystem.cs.

◆ fxAudioPlayer

SimpleAudioPlayer HKI.Core.Audio.AudioSystem.fxAudioPlayer = null
private

Definition at line 31 of file AudioSystem.cs.

◆ FxAudioPlayerSettings

AudioPlayer.AudioPlayerSettings HKI.Core.Audio.AudioSystem.FxAudioPlayerSettings = new AudioPlayer.AudioPlayerSettings()
private

Definition at line 22 of file AudioSystem.cs.

◆ musicAudioPlayer

SimpleAudioPlayer HKI.Core.Audio.AudioSystem.musicAudioPlayer = null
private

Definition at line 29 of file AudioSystem.cs.

◆ MusicAudioPlayerSettings

AudioPlayer.AudioPlayerSettings HKI.Core.Audio.AudioSystem.MusicAudioPlayerSettings = new AudioPlayer.AudioPlayerSettings()
private

Definition at line 18 of file AudioSystem.cs.

◆ uiFxAudioPlayer

SimpleAudioPlayer HKI.Core.Audio.AudioSystem.uiFxAudioPlayer = null
private

Definition at line 32 of file AudioSystem.cs.

◆ UiFxAudioPlayerSettings

AudioPlayer.AudioPlayerSettings HKI.Core.Audio.AudioSystem.UiFxAudioPlayerSettings = new AudioPlayer.AudioPlayerSettings()
private

Definition at line 24 of file AudioSystem.cs.

◆ UseAmbientAudioPlayer

bool HKI.Core.Audio.AudioSystem.UseAmbientAudioPlayer = true
private

Definition at line 19 of file AudioSystem.cs.

◆ UseFxAudioPlayer

bool HKI.Core.Audio.AudioSystem.UseFxAudioPlayer = true
private

Definition at line 21 of file AudioSystem.cs.

◆ UseMusicAudioPlayer

bool HKI.Core.Audio.AudioSystem.UseMusicAudioPlayer = true
private

Definition at line 17 of file AudioSystem.cs.

◆ UseUiFxAudioPlayer

bool HKI.Core.Audio.AudioSystem.UseUiFxAudioPlayer = true
private

Definition at line 23 of file AudioSystem.cs.

◆ UseVoicesAudioPlayer

bool HKI.Core.Audio.AudioSystem.UseVoicesAudioPlayer = true
private

Definition at line 25 of file AudioSystem.cs.

◆ voicesAudioPlayer

SimpleAudioPlayer HKI.Core.Audio.AudioSystem.voicesAudioPlayer = null
private

Definition at line 33 of file AudioSystem.cs.

◆ VoicesAudioPlayerSettings

AudioPlayer.AudioPlayerSettings HKI.Core.Audio.AudioSystem.VoicesAudioPlayerSettings = new AudioPlayer.AudioPlayerSettings()
private

Definition at line 26 of file AudioSystem.cs.

Property Documentation

◆ AmbientAudioPlayer

SimpleAudioPlayer HKI.Core.Audio.AudioSystem.AmbientAudioPlayer
get

Definition at line 39 of file AudioSystem.cs.

◆ FxAudioPlayer

SimpleAudioPlayer HKI.Core.Audio.AudioSystem.FxAudioPlayer
get

Definition at line 40 of file AudioSystem.cs.

◆ Instance

AudioSystem HKI.Core.Audio.AudioSystem.Instance
staticgetprivate set

Definition at line 15 of file AudioSystem.cs.

◆ MusicAudioPlayer

SimpleAudioPlayer HKI.Core.Audio.AudioSystem.MusicAudioPlayer
get

Definition at line 38 of file AudioSystem.cs.

◆ UiFxAudioPlayer

SimpleAudioPlayer HKI.Core.Audio.AudioSystem.UiFxAudioPlayer
get

Definition at line 41 of file AudioSystem.cs.

◆ VoicesAudioPlayer

SimpleAudioPlayer HKI.Core.Audio.AudioSystem.VoicesAudioPlayer
get

Definition at line 42 of file AudioSystem.cs.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.13