Interface ICrossFading

Allows to set how cross fading audio clips between rooms behaves.

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface ICrossFading

Properties

EaseFadeIn

If the audio clip for the new room is set to fade in, this allows you to set the easing function for the fade in (linear, ease-in, etc).

Declaration

Func<float, float> EaseFadeIn { get; set; }

Property Value

Type	Description
System.Func<System.Single, System.Single>	The ease fade out.

Examples

game.AudioSettings.RoomMusicCrossFading.EaseFadeIn = Ease.CubeInOut;

EaseFadeOut

If the audio clip for the old room is set to fade out, this allows you to set the easing function for the fade out (linear, ease-in, etc).

Declaration

Func<float, float> EaseFadeOut { get; set; }

Property Value

Type	Description
System.Func<System.Single, System.Single>	The ease fade out.

Examples

game.AudioSettings.RoomMusicCrossFading.EaseFadeOut = Ease.QuadOut;

FadeIn

Should the audio clip for the new room fade in while transistioning to the new room?

Declaration

bool FadeIn { get; set; }

Property Value

Type	Description
System.Boolean	true if fade in; otherwise, false.

FadeInSeconds

If the audio clip for the new room is set to fade in, how long (in seconds) should the fade in take?

Declaration

float FadeInSeconds { get; set; }

Property Value

Type	Description
System.Single	The fade in seconds.

FadeOut

Should the audio clip for the old room fade out while transistioning to the new room?

Declaration

bool FadeOut { get; set; }

Property Value

Type	Description
System.Boolean	true if fade out; otherwise, false.

FadeOutSeconds

If the audio clip for the old room is set to fade out, how long (in seconds) should the fade out take?

Declaration

float FadeOutSeconds { get; set; }

Property Value

Type	Description
System.Single	The fade out seconds.