SoundEvent Functions

Reference of all the SoundEvent functions

The SoundEvent can be played directly from itself instead of playing via the SoundManager. A SoundManager instance in the scene is required to play SoundEvents.

Example code:

using UnityEngine;
using Sonity;

public class PlayStopExample : MonoBehaviour {

    public SoundEvent soundEvent;

    void PlayExample() {
        // Plays the SoundEvent at the position of the transform
        soundEvent.Play(transform);
    }

    void StopExample() {
        // Stops the SoundEvent playing at the transform
        soundEvent.Stop(transform);
    }
}

Play

// Plays the SoundEvent at the position of the owner Transform
public void Play(Transform owner);
public void Play(Transform owner, SoundTag localSoundTag);
public void Play(Transform owner, params SoundParameterInternals[] soundParameterInternals);
public void Play(Transform owner, SoundTag localSoundTag, params SoundParameterInternals[] soundParameterInternals);

Parameters
owner	The owner Transform
localSoundTag	The SoundTag which will determine the Local SoundTag of the SoundEvent
soundParameterInternals	For example SoundParameterVolumeDecibel is used to modify how the SoundEvent is played

PlayAtPosition

// Plays the SoundEvent at the Vector3 position with another Transform as the owner
public void PlayAtPosition(Transform owner, Vector3 position);
public void PlayAtPosition(Transform owner, Vector3 position, SoundTag localSoundTag);
public void PlayAtPosition(Transform owner, Vector3 position, params SoundParameterInternals[] soundParameterInternals);
public void PlayAtPosition(Transform owner, Vector3 position, SoundTag localSoundTag, params SoundParameterInternals[] soundParameterInternals);

// Plays the SoundEvent at the Transform position with another Transform as the owner
public void PlayAtPosition(Transform owner, Transform position);
public void PlayAtPosition(Transform owner, Transform position, SoundTag localSoundTag);
public void PlayAtPosition(Transform owner, Transform position, params SoundParameterInternals[] soundParameterInternals);
public void PlayAtPosition(Transform owner, Transform position, SoundTag localSoundTag, params SoundParameterInternals[] soundParameterInternals);

Parameters
owner	The owner Transform
position	The Transform or Vector3 where is should play at (Transform can follow position)
localSoundTag	The SoundTag which will determine the Local SoundTag of the SoundEvent
soundParameterInternals	For example SoundParameterVolumeDecibel is used to modify how the SoundEvent is played

Stop

💡 TIP - Stopping Loops You really only need to use stop for looping or longer oneshot sounds (or the SoundContainer “Stop if Transform is Null” setting). Use the polyphony setting in the SoundEvent to manage the number of instances playing.

// Pauses/unpauses the SoundEvent with the owner Transform locally
public void Pause(Transform owner, bool forcePause = false);
public void Unpause(Transform owner);

// Pauses/unpauses all SoundEvents with the owner Transform locally
public void PauseAllAtOwner(bool forcePause = false);
public void UnpauseAllAtOwner();

// Pauses/unpauses the SoundEvent everywhere locally
public void PauseEverywhere(bool forcePause = false);
public void UnpauseEverywhere();

// Pauses/unpauses the SoundEvent everywhere locally
public void PauseEverything(bool forcePause = false);
public void UnpauseEverything();

Parameters
owner	The owner Transform
position	The position Transform
allowFadeOut	If the SoundEvent should be allowed to fade out. Otherwise it is going to be stopped immediately

Pause and Unpause

// Pauses/unpauses the SoundEvent with the owner Transform locally
public void Pause(Transform owner, bool forcePause = false);
public void Unpause(Transform owner);

// Pauses/unpauses all SoundEvents with the owner Transform locally
public void PauseAllAtOwner(bool forcePause = false);
public void UnpauseAllAtOwner();

// Pauses/unpauses the SoundEvent everywhere locally
public void PauseEverywhere(bool forcePause = false);
public void UnpauseEverywhere();

// Pauses/unpauses the SoundEvent everywhere locally
public void PauseEverything(bool forcePause = false);
public void UnpauseEverything();

Parameters
owner	The owner Transform
forcePause	If the SoundEvent should be paused even if it is set to "Ignore Local Pause"

Get State, Length, Time and Contains Loop

// If playing it returns SoundEventState.Playing
// If paused either locally or globally it returns SoundEventState.Paused
// If not playing, but it is delayed it returns SoundEventState.Delayed
// If not playing and it is not delayed it returns SoundEventState.NotPlaying
// If the SoundEvent or Transform is null it returns SoundEventState.NotPlaying
public SoundEventState GetSoundEventState(Transform owner);

// Returns the length (in seconds) of the AudioClip in the last played AudioSource
// Returns Mathf.Infinity if the InstanceSoundEvent is not playing
// Returns Mathf.Infinity if the SoundEvent or Transform is null
// pitchSpeed determines if it should be scaled by pitch. E.g. -12 semitones will be twice as long
public float GetLastPlayedClipLength(Transform owner, bool pitchSpeed);

// Returns the current time (in seconds) of the AudioClip in the last played AudioSource
// Returns 0 if the InstanceSoundEvent is not playing
// Returns 0 if the SoundEvent or Transform is null
// pitchSpeed determines if it should be scaled by pitch. E.g. -12 semitones will be twice as long
public float GetLastPlayedClipTimeSeconds(Transform owner, bool pitchSpeed);

// Returns the current time (in range 0 to 1) of the AudioClip in the last played AudioSource
// Returns 0 if the InstanceSoundEvent is not playing
// Returns 0 if the SoundEvent or Transform is null
public float GetLastPlayedClipTimeRatio(Transform owner);

// Returns the max length (in seconds) of the SoundEvent (calculated from the longest audioClip)
// Is scaled by the pitch of the SoundEvent and SoundContainer
// Does not take into account random, intensity or parameter pitch
public float GetMaxLength();

// Returns the time (in seconds) since the SoundEvent was played
// Is calculated using the time scale selected in the SoundManager
// Returns 0 if the InstanceSoundEvent is not playing
// Returns 0 if the SoundEvent or Transform is null
public float GetTimePlayed(Transform owner);

// Returns if any SoundContainers in the SoundEvent is set to looping
public bool GetContainsLoop();

Parameters
owner	The owner Transform
pitchSpeed	Determines if it should be scaled by pitch. E.g. -12 semitones will be twice as long

Get Spectrum Data

// Provides a block of spectrum data from AudioSources
public void GetSpectrumData(Transform owner, ref float[] samples, int channel, FFTWindow window, SpectrumDataFrom spectrumDataFrom);

Parameters
owner	The owner Transform
samples	The array to populate with audio samples. Its length must be a power of 2
channel	The channel to sample from
window	The FFTWindow type to use when sampling
spectrumDataFrom	Where to get the spectrum data from

Get Last Played AudioSource

// Returns the last played AudioSource
// Note that the AudioSource might be stolen or reused for different Voices over time
public AudioSource GetLastPlayedAudioSource(Transform owner);

Parameters
owner	The owner Transform

Load or Unload Audio Data

// Loads the audio data of any AudioClips assigned to the SoundContainers of the SoundEvent
public void LoadAudioData();

// Unloads the audio data of any AudioClips assigned to the SoundContainers of the SoundEvent
public void UnloadAudioData();

UI Functions

Useful if you want to play SoundEvents without passing an owner.

UI Play

// Plays the SoundEvent with the UI Transform as owner
// Useful to play e.g. UI or other 2D sounds without having to pass a Transform
// To make the sound 2D you still need to disable distance and set spatial blend to 0 in the SoundContainer
public void UIPlay();
public void UIPlay(SoundTag localSoundTag);
public void UIPlay(params SoundParameterInternals[] soundParameterInternals);
public void UIPlay(SoundTag localSoundTag, params SoundParameterInternals[] soundParameterInternals);

// Plays the SoundEvent at the position with the UI Transform as owner (Useful for UnityEvents because it only has one parameter)
public void UIPlayAtPosition(Vector3 position);
public void UIPlayAtPosition(Transform position);

Parameters
localSoundTag	The SoundTag which will determine the Local SoundTag of the SoundEvent
soundParameterInternals	For example SoundParameterVolumeDecibel is used to modify how the SoundEvent is played
position	The Transform or Vector3 where is should play at (Transform can follow position)

UI Stop

// Stops the SoundEvent at the UI Transform
public void UIStop(bool allowFadeOut = true);

// Stops all SoundEvents at the UI Transform
public void UIStopAll(bool allowFadeOut = true);

Parameters
allowFadeOut	If the SoundEvent should be allowed to fade out. Otherwise it is going to be stopped immediately

UI Pause and Unpause

// Pauses/unpauses the SoundEvent at the UI Transform locally
public void UIPause(bool forcePause = false);
public void UIUnpause();

// Pauses/unpauses all SoundEvents at the UI Transform locally
public void UIPauseAll(bool forcePause = false);
public void UIUnpauseAll();

Parameters
forcePause	If the SoundEvent should be paused even if it is set to "Ignore Local Pause"

UI Get State, Length and Time

// Uses the UI owner Transform
// If playing it returns SoundEventState.Playing
// If paused either locally or globally it returns SoundEventState.Paused
// If not playing, but it is delayed it returns SoundEventState.Delayed
// If not playing and it is not delayed it returns SoundEventState.NotPlaying
// If the SoundEvent or Transform is null it returns SoundEventState.NotPlaying
public SoundEventState UIGetSoundEventState();

// Uses the UI owner Transform
// Returns the length (in seconds) of the AudioClip in the last played AudioSource
// Returns Mathf.Infinity if the InstanceSoundEvent is not playing
// Returns Mathf.Infinity if the SoundEvent or Transform is null
// pitchSpeed determines if it should be scaled by pitch. E.g. -12 semitones will be twice as long
public float UIGetLastPlayedClipLength(bool pitchSpeed);

// Uses the UI owner Transform
// Returns the current time (in seconds) of the AudioClip in the last played AudioSource
// Returns 0 if the InstanceSoundEvent is not playing
// Returns 0 if the SoundEvent or Transform is null
// pitchSpeed determines if it should be scaled by pitch. E.g. -12 semitones will be twice as long
public float UIGetLastPlayedClipTimeSeconds(bool pitchSpeed);

// Uses the UI owner Transform
// Returns the current time (in range 0 to 1) of the AudioClip in the last played AudioSource
// Returns 0 if the InstanceSoundEvent is not playing
// Returns 0 if the SoundEvent or Transform is null
public float UIGetLastPlayedClipTimeRatio();

// Uses the UI owner Transform
// Returns the time (in seconds) since the SoundEvent was played
// Is calculated using the time scale selected in the SoundManager
// Returns 0 if the InstanceSoundEvent is not playing
// Returns 0 if the SoundEvent or Transform is null
public float UIGetTimePlayed();

// Returns the owner Transform used by UIPlay() etc
public Transform UIGetTransform();

Parameters
pitchSpeed	Determines if it should be scaled by pitch. E.g. -12 semitones will be twice as long

Music Functions

Music Play

Useful if you want to play music with automatic stopping of the old music when playing a new song.

// Plays the SoundEvent at the SoundManagers music Transform
public void MusicPlay(bool stopAllOtherMusic = true, bool allowFadeOut = true);
public void MusicPlay(bool stopAllOtherMusic = true, bool allowFadeOut = true, params SoundParameterInternals[] soundParameterInternals);

// Plays allowing fade out (Useful for UnityEvents because it only has one parameter)
public void MusicPlayAllowFadeOut(bool stopAllOtherMusic = true);

// Plays without fade out (Useful for UnityEvents because it only has one parameter)
public void MusicPlayImmediate(bool stopAllOtherMusic = true);

Parameters
stopAllOtherMusic	If all other SoundEvents played at the SoundManager music Transform should be stopped
allowFadeOut	If the other stopped SoundEvent should be allowed to fade out. Otherwise they are going to be stopped immediately
soundParameterInternals	For example SoundParameterVolumeDecibel is used to modify how the SoundEvent is played

Music Stop

// Stops the SoundEvent playing at the Music Transform
public void MusicStop(bool allowFadeOut = true);

// Stops all the SoundEvents playing at the Music music Transform
public void AllMusicStop(bool allowFadeOut = true);

Parameters
allowFadeOut	If the other stopped SoundEvent should be allowed to fade out. Otherwise they are going to be stopped immediately

Music Pause and Unpause

// Pauses/unpauses the SoundEvent at the Music Transform locally
public void MusicPause(bool forcePause = false);
public void MusicUnpause();

// Pauses/unpauses all SoundEvents at the Music Transform locally
public void AllMusicPause(bool forcePause = false);
public void AllMusicUnpause();

Parameters
forcePause	If the SoundEvent should be paused even if it is set to "Ignore Local Pause"

Music Get State, Length and Time

// Uses the Music owner Transform
// If playing it returns SoundEventState.Playing
// If paused either locally or globally it returns SoundEventState.Paused
// If not playing, but it is delayed it returns SoundEventState.Delayed
// If not playing and it is not delayed it returns SoundEventState.NotPlaying
// If the SoundEvent or Transform is null it returns SoundEventState.NotPlaying
public SoundEventState MusicGetSoundEventState();

// Uses the Music owner Transform
// Returns the length (in seconds) of the AudioClip in the last played AudioSource
// Returns Mathf.Infinity if the InstanceSoundEvent is not playing
// Returns Mathf.Infinity if the SoundEvent or Transform is null
// pitchSpeed determines if it should be scaled by pitch. E.g. -12 semitones will be twice as long
public float MusicGetLastPlayedClipLength(bool pitchSpeed);

// Uses the Music owner Transform
// Returns the current time (in seconds) of the AudioClip in the last played AudioSource
// Returns 0 if the InstanceSoundEvent is not playing
// Returns 0 if the SoundEvent or Transform is null
// pitchSpeed determines if it should be scaled by pitch. E.g. -12 semitones will be twice as long
public float MusicGetLastPlayedClipTimeSeconds(bool pitchSpeed);

// Uses the Music owner Transform
// Returns the current time (in range 0 to 1) of the AudioClip in the last played AudioSource
// Returns 0 if the InstanceSoundEvent is not playing
// Returns 0 if the SoundEvent or Transform is null
public float MusicGetLastPlayedClipTimeRatio();

// Uses the Music owner Transform
// Returns the time (in seconds) since the SoundEvent was played
// Is calculated using the time scale selected in the SoundManager
// Returns 0 if the InstanceSoundEvent is not playing
// Returns 0 if the SoundEvent or Transform is null
public float MusicGetTimePlayed();

// Returns the owner Transform used by PlayMusic() etc
public Transform MusicGetTransform();

Parameters
pitchSpeed	Determines if it should be scaled by pitch. E.g. -12 semitones will be twice as long