AudioFader Class

Attach it to a GameObject with an AudioSource and this component will allow you to play, pause, stop, and change volume or clip with the volume fading in/out.

Inheritance Hierarchy

SystemObject
  Object
    Component
      Behaviour
        MonoBehaviour
          Kit.BehavioursAudioFader

Namespace: Kit.Behaviours
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0

Syntax

Copy

public class AudioFader : MonoBehaviour

Request Example View Source

The AudioFader type exposes the following members.

Properties

	Name	Description
	Clip	Returns the audio currently playing or allows to change it while fading.
	IsBusy	Returns whether the audio is fading (in or out).
	IsPlaying	Returns whether an audio is currently playing or allows to play or pause it.
	Volume	Returns the current volume or allows to set it while fading.

Top

Methods

	Name	Description
	Pause	Pause and fade-out the audio.
	Play	Play and fade-in the audio.
	Play(AudioClip)	Play an audio.
	Stop	Stop and fade out the audio.

Top

Fields

	Name	Description
	Audio	AudioSource to fade. Will use the one on the same GameObject if not specified.
	FadeOnSceneChange	Should the audio automatically fade in/out when changing the scene with SceneDirector?
	FadeWithScreen	Should the audio automatically fade in/out with the scene when you use SceneDirector?
	Speed	How fast to fade the audio.

Top

Extension Methods

	Name	Description
	Destroy	Destroy the object. (Defined by UnityObjectExtensions.)
	Disable	Set the enabled property to . (Defined by BehaviourExtensions.)
	Enable	Set the enabled property to . (Defined by BehaviourExtensions.)
	GetBounds	Returns the bounds of the Component. (Defined by ComponentExtensions.)
	IsPrefab	Returns whether the Component is a part of a prefab. (Defined by ComponentExtensions.)

Top

Remarks

Just attaching it to an AudioSource with playOnAwake will fade the audio in on Awake.

Reference

Kit.Behaviours Namespace

KitSceneDirector