Class SoundyService
Specialized class that manages the audio players that play sounds and music and handles the audio players pool.
Inherited Members
Namespace: Doozy.Runtime.Soundy
Assembly: cs.temp.dll.dll
Syntax
public class SoundyService : SingletonBehaviour<SoundyService>Properties
musicPlayers
Pool of audio players that play music
Declaration
public SoundyService.AudioPlayerPool musicPlayers { get; }Property Value
| Type | Description |
|---|---|
| SoundyService.AudioPlayerPool |
settings
Reference to the SoundySettings asset that contains all the settings for the Soundy system
Declaration
public static SoundySettings settings { get; }Property Value
| Type | Description |
|---|---|
| SoundySettings |
soundPlayers
Pool of audio players that play sounds
Declaration
public SoundyService.AudioPlayerPool soundPlayers { get; }Property Value
| Type | Description |
|---|---|
| SoundyService.AudioPlayerPool |
Methods
Awake()
Declaration
protected override void Awake()Overrides
FadeOutAndStopAllMusic()
Fade out and stop all music that is currently playing (including looping music).
Declaration
public static void FadeOutAndStopAllMusic()FadeOutAndStopAllSounds()
Fade out and stop all sounds that are currently playing (including looping sounds).
Declaration
public static void FadeOutAndStopAllSounds()FadeOutAndStopMusic(MusicId)
Stop all music that is currently playing (including looping music) the given music id.
Declaration
public static void FadeOutAndStopMusic(MusicId musicId)Parameters
| Type | Name | Description |
|---|---|---|
| MusicId | musicId | MusicId reference |
FadeOutAndStopMusic(MusicObject)
Stop all music that is currently playing (including looping music) from a given library and with a given name.
Declaration
public static void FadeOutAndStopMusic(MusicObject musicObject)Parameters
| Type | Name | Description |
|---|---|---|
| MusicObject | musicObject | MusicObject reference |
FadeOutAndStopMusic(String, String)
Stop all music that is currently playing (including looping music) from a given library and with a given name.
Declaration
public static void FadeOutAndStopMusic(string libraryName, string soundName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
| String | soundName | Sound name |
FadeOutAndStopMusicLibrary(MusicLibrary)
Fade out and stop all music that is currently playing (including looping music) from a given library.
Declaration
public static void FadeOutAndStopMusicLibrary(MusicLibrary musicLibrary)Parameters
| Type | Name | Description |
|---|---|---|
| MusicLibrary | musicLibrary | Music library |
FadeOutAndStopMusicLibrary(MusicLibraryId)
Fade out and stop all music that is currently playing (including looping music) from a given library.
Declaration
public static void FadeOutAndStopMusicLibrary(MusicLibraryId musicLibraryId)Parameters
| Type | Name | Description |
|---|---|---|
| MusicLibraryId | musicLibraryId | Music library id |
FadeOutAndStopMusicLibrary(String)
Fade out and stop all music that is currently playing (including looping music) from a given library.
Declaration
public static void FadeOutAndStopMusicLibrary(string libraryName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
FadeOutAndStopSound(SoundId)
Fade out and stop all sounds that are currently playing (including looping sounds) the given sound id.
Declaration
public static void FadeOutAndStopSound(SoundId soundId)Parameters
| Type | Name | Description |
|---|---|---|
| SoundId | soundId | SoundId reference |
FadeOutAndStopSound(SoundObject)
Fade out and stop all sounds that are currently playing (including looping sounds) the given sound object.
Declaration
public static void FadeOutAndStopSound(SoundObject soundObject)Parameters
| Type | Name | Description |
|---|---|---|
| SoundObject | soundObject | SoundObject reference |
FadeOutAndStopSound(String, String)
Fade out and stop all sounds that are currently playing (including looping sounds) from a given library and with a given name.
Declaration
public static void FadeOutAndStopSound(string libraryName, string soundName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
| String | soundName | Sound name |
FadeOutAndStopSoundLibrary(SoundLibrary)
Fade out and stop all sounds that are currently playing (including looping sounds) from a given library.
Declaration
public static void FadeOutAndStopSoundLibrary(SoundLibrary soundLibrary)Parameters
| Type | Name | Description |
|---|---|---|
| SoundLibrary | soundLibrary | Sound library |
FadeOutAndStopSoundLibrary(SoundLibraryId)
Fade out and stop all sounds that are currently playing (including looping sounds) from a given library and with a given name.
Declaration
public static void FadeOutAndStopSoundLibrary(SoundLibraryId soundLibraryId)Parameters
| Type | Name | Description |
|---|---|---|
| SoundLibraryId | soundLibraryId | Sound library id |
FadeOutAndStopSoundLibrary(String)
Fade out and stop all sounds that are currently playing (including looping sounds) from a given library and with a given name.
Declaration
public static void FadeOutAndStopSoundLibrary(string libraryName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
GetMusicLibrary(String)
Get a music library by its name.
This method searches for the first MusicLibrary with the given name. And returns the MusicLibrary reference if found, otherwise returns null.
Declaration
public static MusicLibrary GetMusicLibrary(string libraryName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
Returns
| Type | Description |
|---|---|
| MusicLibrary | MusicLibrary reference if found, otherwise returns null |
GetMusicObject(String, String)
Get a music object by its name and its library name.
This method searches for the first MusicLibrary with the given name. Then it searches for the MusicObject with the given name in that library. And returns the MusicObject reference if found, otherwise returns null.
Declaration
public static MusicObject GetMusicObject(string libraryName, string musicName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
| String | musicName | Music name |
Returns
| Type | Description |
|---|---|
| MusicObject | MusicObject reference if found, otherwise returns null |
GetMusicPlayer()
Get an audio player used for playing music. This method will return an audio player from the pool of AudioPlayers that play music. If no audio player is available, a new one will be created and returned.
Note that the audio player pool for music is separate from the audio player pool for sounds.
Declaration
public static AudioPlayer GetMusicPlayer()Returns
| Type | Description |
|---|---|
| AudioPlayer | An audio player used for playing music |
GetSoundLibrary(String)
Get a sound library by its name.
This method searches for the first SoundLibrary with the given name. And returns the SoundLibrary reference if found, otherwise returns null.
Declaration
public static SoundLibrary GetSoundLibrary(string libraryName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
Returns
| Type | Description |
|---|---|
| SoundLibrary | SoundLibrary reference if found, otherwise returns null |
GetSoundObject(String, String)
Get a sound object by its name and its library name.
This method searches for the first SoundLibrary with the given name. Then it searches for the SoundObject with the given name in that library. And returns the SoundObject reference if found, otherwise returns null.
Declaration
public static SoundObject GetSoundObject(string libraryName, string soundName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
| String | soundName | Sound name |
Returns
| Type | Description |
|---|---|
| SoundObject | SoundObject reference if found, otherwise returns null |
GetSoundPlayer()
Get an audio player used for playing sounds. This method will return an audio player from the pool of AudioPlayers that play sounds. If no audio player is available, a new one will be created and returned.
Note that the audio player pool for sounds is separate from the audio player pool for music.
Declaration
public static AudioPlayer GetSoundPlayer()Returns
| Type | Description |
|---|---|
| AudioPlayer | An audio player used for playing sounds |
Initialize()
Initialize the AudioEngine
Declaration
public static void Initialize()MusicLibraryExists(String)
Check if a music library with a given name exists. This will return false if the library name is null or empty, or if the library name is the default library name or the none library name. Does not check for multiple libraries with the same name. Does not check for sound libraries.
Declaration
public static bool MusicLibraryExists(string libraryName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
Returns
| Type | Description |
|---|---|
| Boolean | True if the library exists, false otherwise |
MusicObjectExists(String, String)
Check if a music object with a given name exists in a given library. This will return false if the library name is null or empty, or if the library name is the default library name or the none library name. Does not check for multiple libraries with the same name. Does not check for sound libraries.
Declaration
public static bool MusicObjectExists(string libraryName, string musicName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
| String | musicName | Music name |
Returns
| Type | Description |
|---|---|
| Boolean | True if the music object exists, false otherwise |
MuteAll()
Mute all sounds and music that are currently playing (including looping sounds and music). This will not mute sounds and music that are scheduled to be played in the future.
Declaration
public static void MuteAll()MuteAllMusic()
Mute all music that is currently playing (including looping music).
Declaration
public static void MuteAllMusic()MuteAllSounds()
Mute all sounds that are currently playing (including looping sounds).
Declaration
public static void MuteAllSounds()MuteMusic(MusicId)
Mute all music that is currently playing (including looping music) the given music id.
Declaration
public static void MuteMusic(MusicId musicId)Parameters
| Type | Name | Description |
|---|---|---|
| MusicId | musicId | MusicId reference |
MuteMusic(MusicObject)
Mute all music that is currently playing (including looping music) the given music object.
Declaration
public static void MuteMusic(MusicObject musicObject)Parameters
| Type | Name | Description |
|---|---|---|
| MusicObject | musicObject | MusicObject reference |
MuteMusic(String, String)
Mute all music that is currently playing (including looping music) from a given library and with a given name.
Declaration
public static void MuteMusic(string libraryName, string soundName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
| String | soundName | Sound name |
MuteMusicLibrary(MusicLibrary)
Mute all music that is currently playing (including looping music) from a given library.
Declaration
public static void MuteMusicLibrary(MusicLibrary musicLibrary)Parameters
| Type | Name | Description |
|---|---|---|
| MusicLibrary | musicLibrary | Music library |
MuteMusicLibrary(MusicLibraryId)
Mute all music that is currently playing (including looping music) from a given library.
Declaration
public static void MuteMusicLibrary(MusicLibraryId musicLibraryId)Parameters
| Type | Name | Description |
|---|---|---|
| MusicLibraryId | musicLibraryId | Music library id |
MuteMusicLibrary(String)
Mute all music that is currently playing (including looping music) from a given library.
Declaration
public static void MuteMusicLibrary(string libraryName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
MuteSound(SoundId)
Mute all sounds that are currently playing (including looping sounds) the given sound id.
Declaration
public static void MuteSound(SoundId soundId)Parameters
| Type | Name | Description |
|---|---|---|
| SoundId | soundId | SoundId reference |
MuteSound(SoundObject)
Mute all sounds that are currently playing (including looping sounds) the given sound object.
Declaration
public static void MuteSound(SoundObject soundObject)Parameters
| Type | Name | Description |
|---|---|---|
| SoundObject | soundObject | SoundObject reference |
MuteSound(String, String)
Mute all sounds that are currently playing (including looping sounds) from a given library and with a given name.
Declaration
public static void MuteSound(string libraryName, string soundName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
| String | soundName | Sound name |
MuteSoundLibrary(SoundLibrary)
Mute all sounds that are currently playing (including looping sounds) from a given library.
Declaration
public static void MuteSoundLibrary(SoundLibrary soundLibrary)Parameters
| Type | Name | Description |
|---|---|---|
| SoundLibrary | soundLibrary | Sound library |
MuteSoundLibrary(SoundLibraryId)
Mute all sounds that are currently playing (including looping sounds) from a given library.
Declaration
public static void MuteSoundLibrary(SoundLibraryId soundLibraryId)Parameters
| Type | Name | Description |
|---|---|---|
| SoundLibraryId | soundLibraryId | Sound library id |
MuteSoundLibrary(String)
Mute all sounds that are currently playing (including looping sounds) from a given library.
Declaration
public static void MuteSoundLibrary(string libraryName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
PauseAll()
Pause all sounds and music that are currently playing (including looping sounds and music). This will not pause sounds and music that are scheduled to be played in the future.
Declaration
public static void PauseAll()PauseAllMusic()
Pause all music that is currently playing (including looping music).
Declaration
public static void PauseAllMusic()PauseAllSounds()
Pause all sounds that are currently playing (including looping sounds).
Declaration
public static void PauseAllSounds()PauseMusic(MusicId)
Pause all music that is currently playing (including looping music) the given music id.
Declaration
public static void PauseMusic(MusicId musicId)Parameters
| Type | Name | Description |
|---|---|---|
| MusicId | musicId | MusicId reference |
PauseMusic(MusicObject)
Pause all music that is currently playing (including looping music) the given music object.
Declaration
public static void PauseMusic(MusicObject musicObject)Parameters
| Type | Name | Description |
|---|---|---|
| MusicObject | musicObject | MusicObject reference |
PauseMusic(String, String)
Pause all music that is currently playing (including looping music) the given library and with a given name.
Declaration
public static void PauseMusic(string libraryName, string soundName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
| String | soundName | Sound name |
PauseMusicLibrary(MusicLibrary)
Pause all music that is currently playing (including looping music) from a given library.
Declaration
public static void PauseMusicLibrary(MusicLibrary musicLibrary)Parameters
| Type | Name | Description |
|---|---|---|
| MusicLibrary | musicLibrary | Music library |
PauseMusicLibrary(MusicLibraryId)
Pause all music that is currently playing (including looping music) from a given library.
Declaration
public static void PauseMusicLibrary(MusicLibraryId musicLibraryId)Parameters
| Type | Name | Description |
|---|---|---|
| MusicLibraryId | musicLibraryId | Music library id |
PauseMusicLibrary(String)
Pause all music that is currently playing (including looping music) from a given library.
Declaration
public static void PauseMusicLibrary(string libraryName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
PauseSound(SoundId)
Pause all sounds that are currently playing (including looping sounds) the given sound id.
Declaration
public static void PauseSound(SoundId soundId)Parameters
| Type | Name | Description |
|---|---|---|
| SoundId | soundId | SoundId reference |
PauseSound(SoundObject)
Pause all sounds that are currently playing (including looping sounds) the given sound object.
Declaration
public static void PauseSound(SoundObject soundObject)Parameters
| Type | Name | Description |
|---|---|---|
| SoundObject | soundObject | SoundObject reference |
PauseSound(String, String)
Pause all sounds that are currently playing (including looping sounds) from a given library and with a given name.
Declaration
public static void PauseSound(string libraryName, string soundName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
| String | soundName | Sound name |
PauseSoundLibrary(SoundLibrary)
Pause all sounds that are currently playing (including looping sounds) from a given library.
Declaration
public static void PauseSoundLibrary(SoundLibrary soundLibrary)Parameters
| Type | Name | Description |
|---|---|---|
| SoundLibrary | soundLibrary | Sound library |
PauseSoundLibrary(SoundLibraryId)
Pause all sounds that are currently playing (including looping sounds) from a given library.
Declaration
public static void PauseSoundLibrary(SoundLibraryId soundLibraryId)Parameters
| Type | Name | Description |
|---|---|---|
| SoundLibraryId | soundLibraryId | Sound library id |
PauseSoundLibrary(String)
Pause all sounds that are currently playing (including looping sounds) from a given library.
Declaration
public static void PauseSoundLibrary(string libraryName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
PlayMusic(MusicId, AudioMixerGroup)
Play a music from a given library and with a given name and return the audio player that is playing it. You can also specify an output audio mixer group for the audio player (if null, the audio mixer group set in the library will be used).
Declaration
public static AudioPlayer PlayMusic(MusicId musicId, AudioMixerGroup outputAudioMixerGroup = null)Parameters
| Type | Name | Description |
|---|---|---|
| MusicId | musicId | Music id |
| AudioMixerGroup | outputAudioMixerGroup | Output audio mixer group |
Returns
| Type | Description |
|---|---|
| AudioPlayer | Audio player that is playing the sound. If the sound could not be played, returns null |
PlayMusic(MusicObject, AudioMixerGroup)
Play a music from a given library and with a given name and return the audio player that is playing it. You can also specify an output audio mixer group for the audio player (if null, the audio mixer group set in the library will be used).
Declaration
public static AudioPlayer PlayMusic(MusicObject musicObject, AudioMixerGroup outputAudioMixerGroup = null)Parameters
| Type | Name | Description |
|---|---|---|
| MusicObject | musicObject | Music object |
| AudioMixerGroup | outputAudioMixerGroup | Output audio mixer group |
Returns
| Type | Description |
|---|---|
| AudioPlayer | Audio player that is playing the music. If the music could not be played, returns null |
PlayMusic(String, String, AudioMixerGroup)
Play a music from a given library and with a given name and return the audio player that is playing it. You can also specify an output audio mixer group for the audio player (if null, the audio mixer group set in the library will be used).
Declaration
public static AudioPlayer PlayMusic(string libraryName, string musicName, AudioMixerGroup outputAudioMixerGroup = null)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
| String | musicName | Music name |
| AudioMixerGroup | outputAudioMixerGroup | Output audio mixer group |
Returns
| Type | Description |
|---|---|
| AudioPlayer | Audio player that is playing the music. If the music could not be played, returns null |
PlaySound(SoundId, AudioMixerGroup)
Play a sound from a given library and with a given name and return the audio player that is playing it. You can also specify an output audio mixer group for the audio player (if null, the audio mixer group set in the library will be used).
Declaration
public static AudioPlayer PlaySound(SoundId soundId, AudioMixerGroup outputAudioMixerGroup = null)Parameters
| Type | Name | Description |
|---|---|---|
| SoundId | soundId | Sound id |
| AudioMixerGroup | outputAudioMixerGroup | Output audio mixer group |
Returns
| Type | Description |
|---|---|
| AudioPlayer | Audio player that is playing the sound. If the sound could not be played, returns null |
PlaySound(SoundObject, AudioMixerGroup)
Play a sound from a given library and with a given name and return the audio player that is playing it. You can also specify an output audio mixer group for the audio player (if null, the audio mixer group set in the library will be used).
Declaration
public static AudioPlayer PlaySound(SoundObject soundObject, AudioMixerGroup outputAudioMixerGroup = null)Parameters
| Type | Name | Description |
|---|---|---|
| SoundObject | soundObject | Sound object |
| AudioMixerGroup | outputAudioMixerGroup | Output audio mixer group |
Returns
| Type | Description |
|---|---|
| AudioPlayer | Audio player that is playing the sound. If the sound could not be played, returns null |
PlaySound(String, String, AudioMixerGroup)
Play a sound from a given library and with a given name and return the audio player that is playing it. You can also specify an output audio mixer group for the audio player (if null, the audio mixer group set in the library will be used).
Declaration
public static AudioPlayer PlaySound(string libraryName, string soundName, AudioMixerGroup outputAudioMixerGroup = null)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
| String | soundName | Sound name |
| AudioMixerGroup | outputAudioMixerGroup | Output audio mixer group |
Returns
| Type | Description |
|---|---|
| AudioPlayer | Audio player that is playing the sound. If the sound could not be played, returns null |
RemoveIdleMusicPlayers(Int32)
Remove all idle audio players that are not in use and are used for playing music.
Declaration
public static void RemoveIdleMusicPlayers(int minPlayersToKeepAlive)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | minPlayersToKeepAlive | Minimum number of players to keep alive |
RemoveIdlePlayers(Int32, Int32)
Remove all idle audio players that are not in use.
Declaration
public static void RemoveIdlePlayers(int minSoundPlayersToKeepAlive, int minMusicPlayersToKeepAlive)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | minSoundPlayersToKeepAlive | Minimum number of sound players to keep alive |
| Int32 | minMusicPlayersToKeepAlive | Minimum number of music players to keep alive |
RemoveIdleSoundPlayers(Int32)
Remove all idle audio players that are not in use and are used for playing sounds.
Declaration
public static void RemoveIdleSoundPlayers(int minPlayersToKeepAlive)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | minPlayersToKeepAlive | Minimum number of players to keep alive |
SoundLibraryExists(String)
Check if a sound library with a given name exists. This will return false if the library name is null or empty, or if the library name is the default library name or the none library name. Does not check for multiple libraries with the same name. Does not check for music libraries.
Declaration
public static bool SoundLibraryExists(string libraryName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
Returns
| Type | Description |
|---|---|
| Boolean | True if the library exists, false otherwise |
SoundObjectExists(String, String)
Check if a sound object with a given name exists in a given library. This will return false if the library name is null or empty, or if the library name is the default library name or the none library name. Does not check for multiple libraries with the same name. Does not check for music libraries.
Declaration
public static bool SoundObjectExists(string libraryName, string soundName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
| String | soundName | Sound name |
Returns
| Type | Description |
|---|---|
| Boolean | True if the sound object exists, false otherwise |
StopAll()
Stop all sounds and music that are currently playing (including looping sounds and music). This will not stop sounds and music that are scheduled to be played in the future.
Declaration
public static void StopAll()StopAllMusic()
Stop all music that is currently playing (including looping music).
Declaration
public static void StopAllMusic()StopAllSounds()
Stop all sounds that are currently playing (including looping sounds).
Declaration
public static void StopAllSounds()StopMusic(MusicId)
Stop all music that is currently playing (including looping music) the given music id. This will not stop music that is scheduled to be played in the future.
Declaration
public static void StopMusic(MusicId musicId)Parameters
| Type | Name | Description |
|---|---|---|
| MusicId | musicId | MusicId reference |
StopMusic(MusicObject)
Stop all music that is currently playing (including looping music) the given music object. This will not stop music that is scheduled to be played in the future.
Declaration
public static void StopMusic(MusicObject musicObject)Parameters
| Type | Name | Description |
|---|---|---|
| MusicObject | musicObject | MusicObject reference |
StopMusic(String, String)
Stop all music that is currently playing (including looping music) from a given library and with a given name. This will not stop music that is scheduled to be played in the future.
Declaration
public static void StopMusic(string libraryName, string soundName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
| String | soundName | Sound name |
StopMusicLibrary(MusicLibrary)
Stop all music that is currently playing (including looping music) from a given library.
Declaration
public static void StopMusicLibrary(MusicLibrary musicLibrary)Parameters
| Type | Name | Description |
|---|---|---|
| MusicLibrary | musicLibrary | Music library |
StopMusicLibrary(MusicLibraryId)
Stop all music that is currently playing (including looping music) from a given library.
Declaration
public static void StopMusicLibrary(MusicLibraryId musicLibraryId)Parameters
| Type | Name | Description |
|---|---|---|
| MusicLibraryId | musicLibraryId | Music library id |
StopMusicLibrary(String)
Stop all music that is currently playing (including looping music) from a given library.
Declaration
public static void StopMusicLibrary(string libraryName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
StopSound(SoundId)
Stop all sounds that are currently playing (including looping sounds) the given sound id.
Declaration
public static void StopSound(SoundId soundId)Parameters
| Type | Name | Description |
|---|---|---|
| SoundId | soundId | SoundId reference |
StopSound(SoundObject)
Stop all sounds that are currently playing (including looping sounds) the given sound object.
Declaration
public static void StopSound(SoundObject soundObject)Parameters
| Type | Name | Description |
|---|---|---|
| SoundObject | soundObject | SoundObject reference |
StopSound(String, String)
Stop all sounds that are currently playing (including looping sounds) from a given library and with a given name.
Declaration
public static void StopSound(string libraryName, string soundName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
| String | soundName | Sound name |
StopSoundLibrary(SoundLibrary)
Stop all sounds that are currently playing (including looping sounds) from a given library.
Declaration
public static void StopSoundLibrary(SoundLibrary soundLibrary)Parameters
| Type | Name | Description |
|---|---|---|
| SoundLibrary | soundLibrary | Sound library |
StopSoundLibrary(SoundLibraryId)
Stop all sounds that are currently playing (including looping sounds) from a given library.
Declaration
public static void StopSoundLibrary(SoundLibraryId soundLibraryId)Parameters
| Type | Name | Description |
|---|---|---|
| SoundLibraryId | soundLibraryId | Sound library id |
StopSoundLibrary(String)
Stop all sounds that are currently playing (including looping sounds) from a given library.
Declaration
public static void StopSoundLibrary(string libraryName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
UnMuteAll()
Unmute all sounds and music that are currently playing (including looping sounds and music). This will not unmute sounds and music that are scheduled to be played in the future.
Declaration
public static void UnMuteAll()UnMuteAllMusic()
Unmute all music that is currently playing (including looping music).
Declaration
public static void UnMuteAllMusic()UnMuteAllSounds()
Unmute all sounds that are currently playing (including looping sounds).
Declaration
public static void UnMuteAllSounds()UnMuteMusic(MusicId)
Unmute all music that is currently playing (including looping music) the given music id.
Declaration
public static void UnMuteMusic(MusicId musicId)Parameters
| Type | Name | Description |
|---|---|---|
| MusicId | musicId | MusicId reference |
UnMuteMusic(MusicObject)
Unmute all music that is currently playing (including looping music) the given music object.
Declaration
public static void UnMuteMusic(MusicObject musicObject)Parameters
| Type | Name | Description |
|---|---|---|
| MusicObject | musicObject | MusicObject reference |
UnMuteMusic(String, String)
Unmute all music that is currently playing (including looping music) from a given library and with a given name.
Declaration
public static void UnMuteMusic(string libraryName, string soundName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
| String | soundName | Sound name |
UnMuteMusicLibrary(MusicLibrary)
Unmute all music that is currently playing (including looping music) from a given library.
Declaration
public static void UnMuteMusicLibrary(MusicLibrary musicLibrary)Parameters
| Type | Name | Description |
|---|---|---|
| MusicLibrary | musicLibrary | Music library |
UnMuteMusicLibrary(MusicLibraryId)
Unmute all music that is currently playing (including looping music) from a given library.
Declaration
public static void UnMuteMusicLibrary(MusicLibraryId musicLibraryId)Parameters
| Type | Name | Description |
|---|---|---|
| MusicLibraryId | musicLibraryId | Music library id |
UnMuteMusicLibrary(String)
Unmute all music that is currently playing (including looping music) from a given library.
Declaration
public static void UnMuteMusicLibrary(string libraryName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
UnMuteSound(SoundId)
Unmute all sounds that are currently muted (including looping sounds) the given sound id.
Declaration
public static void UnMuteSound(SoundId soundId)Parameters
| Type | Name | Description |
|---|---|---|
| SoundId | soundId | SoundId reference |
UnMuteSound(SoundObject)
Unmute all sounds that are currently muted (including looping sounds) the given sound object.
Declaration
public static void UnMuteSound(SoundObject soundObject)Parameters
| Type | Name | Description |
|---|---|---|
| SoundObject | soundObject | SoundObject reference |
UnMuteSound(String, String)
Unmute all sounds that are currently muted (including looping sounds) from a given library and with a given name.
Declaration
public static void UnMuteSound(string libraryName, string soundName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
| String | soundName | Sound name |
UnMuteSoundLibrary(SoundLibrary)
Unmute all sounds that are currently playing (including looping sounds) from a given library.
Declaration
public static void UnMuteSoundLibrary(SoundLibrary soundLibrary)Parameters
| Type | Name | Description |
|---|---|---|
| SoundLibrary | soundLibrary | Sound library |
UnMuteSoundLibrary(SoundLibraryId)
Unmute all sounds that are currently playing (including looping sounds) from a given library.
Declaration
public static void UnMuteSoundLibrary(SoundLibraryId soundLibraryId)Parameters
| Type | Name | Description |
|---|---|---|
| SoundLibraryId | soundLibraryId | Sound library id |
UnMuteSoundLibrary(String)
Unmute all sounds that are currently playing (including looping sounds) from a given library.
Declaration
public static void UnMuteSoundLibrary(string libraryName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
UnPauseAll()
Unpause all sounds and music that are currently playing (including looping sounds and music). This will not unpause sounds and music that are scheduled to be played in the future.
Declaration
public static void UnPauseAll()UnPauseAllMusic()
Unpause all music that is currently playing (including looping music) and are paused.
Declaration
public static void UnPauseAllMusic()UnPauseAllSounds()
Unpause all sounds that are currently playing (including looping sounds) and are paused.
Declaration
public static void UnPauseAllSounds()UnPauseMusic(MusicId)
Unpause all music that is currently playing (including looping music) the given music id.
Declaration
public static void UnPauseMusic(MusicId musicId)Parameters
| Type | Name | Description |
|---|---|---|
| MusicId | musicId | MusicId reference |
UnPauseMusic(MusicObject)
Unpause all music that is currently playing (including looping music) the given music object.
Declaration
public static void UnPauseMusic(MusicObject musicObject)Parameters
| Type | Name | Description |
|---|---|---|
| MusicObject | musicObject | MusicObject reference |
UnPauseMusic(String, String)
Unpause all music that is currently playing (including looping music) the given library and with a given name.
Declaration
public static void UnPauseMusic(string libraryName, string soundName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
| String | soundName | Sound name |
UnPauseMusicLibrary(MusicLibrary)
Unpause all music that is currently playing (including looping music) from a given library.
Declaration
public static void UnPauseMusicLibrary(MusicLibrary musicLibrary)Parameters
| Type | Name | Description |
|---|---|---|
| MusicLibrary | musicLibrary | Music library |
UnPauseMusicLibrary(MusicLibraryId)
Unpause all music that is currently playing (including looping music) from a given library.
Declaration
public static void UnPauseMusicLibrary(MusicLibraryId musicLibraryId)Parameters
| Type | Name | Description |
|---|---|---|
| MusicLibraryId | musicLibraryId | Music library id |
UnPauseMusicLibrary(String)
Unpause all music that is currently playing (including looping music) from a given library.
Declaration
public static void UnPauseMusicLibrary(string libraryName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
UnPauseSound(SoundId)
Unpause all sounds that are currently paused (including looping sounds) the given sound id.
Declaration
public static void UnPauseSound(SoundId soundId)Parameters
| Type | Name | Description |
|---|---|---|
| SoundId | soundId | SoundId reference |
UnPauseSound(SoundObject)
Unpause all sounds that are currently paused (including looping sounds) the given sound object.
Declaration
public static void UnPauseSound(SoundObject soundObject)Parameters
| Type | Name | Description |
|---|---|---|
| SoundObject | soundObject | SoundObject reference |
UnPauseSound(String, String)
Unpause all sounds that are currently paused (including looping sounds) from a given library and with a given name.
Declaration
public static void UnPauseSound(string libraryName, string soundName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName | Library name |
| String | soundName | Sound name |
UnPauseSoundLibrary(SoundLibrary)
Unpause all sounds that are currently playing (including looping sounds) from a given library.
Declaration
public static void UnPauseSoundLibrary(SoundLibrary soundLibrary)Parameters
| Type | Name | Description |
|---|---|---|
| SoundLibrary | soundLibrary | Sound library |
UnPauseSoundLibrary(SoundLibraryId)
Unpause all sounds that are currently playing (including looping sounds) and are paused from a given library.
Declaration
public static void UnPauseSoundLibrary(SoundLibraryId soundLibraryId)Parameters
| Type | Name | Description |
|---|---|---|
| SoundLibraryId | soundLibraryId | Sound library id |
UnPauseSoundLibrary(String)
Unpause all sounds that are currently playing (including looping sounds) and are paused from a given library.
Declaration
public static void UnPauseSoundLibrary(string libraryName)Parameters
| Type | Name | Description |
|---|---|---|
| String | libraryName |