Show / Hide Table of Contents

Namespace E7.TinyAmbience

Classes

Ambience

An asset made of many AmbienceLayer asset. It is playable with AmbienceSource component.

AmbienceLayer

The most granular asset type in Tiny Ambience. Represent one kind of looping sounds inside a complete ambience. Each one can be in one of 3 different modes with different strength : Looping Clip, One Shot Program, or Timeline.

When multiple layers stacked together they become an Ambience.

AmbienceLayerAdjustments

Apply some adjustments on top of what was setup in AmbienceLayer asset.

AmbienceLayerWithAdjustments

AmbienceLayer paired with additional adjustments. This class is exposed because of IAmbienceLayerProvider.

AmbienceOverallAdjustments

Settings on the top of Ambience to make one more adjustments to all its AmbienceLayer. This class is exposed because of IAmbienceLayerProvider.

AmbienceSource

Parallels UnityEngine.AudioSource, but instead of playing UnityEngine.AudioClip it plays an Ambience instead.

Requires a reference to UnityEngine.AudioSource to be an output of each ambience layer.

UnityEventAmbience

Serializable event type that could connect to AmbienceSource and call the Play(Ambience) method.

UnityEventAmbienceOnlyOption

Serializable event type that could connect to AmbienceSource and call the Play(PlayOptions) method.

UnityEventAmbienceWithOption

Serializable event type that could connect to AmbienceSource and call the Play(Ambience, PlayOptions) method.

Structs

PlayOptions

This struct is here ahead of time to not break your code in the future, but currently there is no feature yet.

Interfaces

IAmbienceLayerProvider

An object that can be played by AmbienceSource.

Enums

TimeSourceType

How the ambience will sound like when UnityEngine.Time.timeScale changed.

In This Article
Back to top
A Unity plugin by 5argon from Exceed7 Experiments. Problems/suggestions/contact : 5argon@exceed7.com Discord Unity Forum