Namespace OmiyaGames.Audio

Classes

AssetRef

Contains helper enums for AssetRef<TObject>.

AssetRefSerialized<TObject>

Helper serialized class to display in Unity inspector. Generates an AssetRef<TObject>.

AudioHistory

Retains a history of BackgroundAudio, capped by MaxCapacity.

AudioHistory.AddArgs

The event argument when calling Add(in AssetRef<BackgroundAudio>).

AudioHistory.RemoveArgs

The event argument when calling RemoveOldest() or RemoveNewest().

AudioLayer

Base info on each audio category.

AudioLayer.Background

Audio category applicable to ones predominately used in the background, i.e. music and ambience.

AudioLayer.PlayerArgs

Event arguments for fading in a BackgroundAudio.Player

AudioLayer.Spatial

Audio category applicable to ones predominately used in spatial context, i.e. sound effects and voices.

AudioLayer.SubLayer

A sublayer to AudioLayer

AudioManager

A manager file that allows adjusting an from settings.

AudioPlayerManager

Handles managing BackgroundAudio.Players, including generating and auto-removing unused players. Generally used like a , where BackgroundAudio is mapped to a list of BackgroundAudio.Players.

AudioSettings

Scriptable object with settings info.

BackgroundAudio

An interface for music, used to generate playing a clip.

BackgroundAudio.Player

The that plays a BackgroundAudio.

ChangeAudioOnStart

Changes the background music on scene start.

ChangeAudioOnTrigger

Changes the background music on collision trigger enter.

FadeInArgs

Provides configuration details to MixerGroupManager on how to fade in a BackgroundAudio.

FadeOutArgs

Provides configuration details to MixerGroupManager on how to fade out a BackgroundAudio.

MixerGroupFader

Unity inspector class for pairing a with a parameter name for changing its volume.

MixerGroupManager

Manager for , used to fade in and out various BackgroundAudio.Players.

PlaybackArgs

Provides configuration details to BackgroundAudio.Player on how to play a BackgroundAudio.

PlaybackBehavior

Helper serialized class to display in Unity inspector. Generates details for fade-ins and fade-outs.

SingleLoopingMusic

A BackgroundAudio representing a looping music and optionally an intro stinger.

SoundEffect

A script for playing sound effects, with extra options such as clip, pitch, and volume mutation. Also allows configuring sound effects' volume.

TimeScaleAudioModifiers

Helper struct for params in AudioSettings.

Structs

AssetRef<TObject>

A common wrapper to an asset. Use this to represent Assets that could either be a direct reference to a project asset, or an addressable reference.

Enums

AssetRef.State

Provides the state of AssetRef<TObject>, and whether it's referencing a project asset or addressable asset.

AudioLayer.PlayerArgs.PlayerState

Indicates how the BackgroundAudio.Player was selected.

AudioPlayerManager.AudioState

An equivalent of BackgroundAudio.PlayState, where multiple values can be combined like a flag.

BackgroundAudio.PlayState

The state of BackgroundAudio.Player.

ChangeAudioOnStart.Behavior

The behavior at the end of ChangeAudioOnStart.

PlaybackBehavior.FadeBehavior

The action to take.

SoundEffect.Layer

Delegates

AudioHistory.OnAdd

Standard format for events called by Add(in AssetRef<BackgroundAudio>).

AudioHistory.OnRemove

Standard format for events called by RemoveOldest() and RemoveNewest().

AudioLayer.Background.OnCoroutineFinished

Called at the end of s called by AudioLayer.Background.