Class TimeScaleAudioModifiers

Helper struct for params in AudioSettings.

Inheritance
Object
TimeScaleAudioModifiers
Namespace: OmiyaGames.Audio
Assembly: cs.temp.dll.dll
Syntax
[Serializable]
public class TimeScaleAudioModifiers
Remarks

The MIT License (MIT)

Copyright (c) 2022 Omiya Games

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

RevisionDescription
Version: 0.1.0-exp.1
Date: 3/7/2022
Author: Taro Omiya 		Initial draft.

Properties

DefaultSnapshot

The snapshot to Mixer that reverts mixer to a no-effects, default state.

Declaration
public AudioMixerSnapshot DefaultSnapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
Remarks

This variable is set in the Unity Project Settings dialog.

EnableFast

Enable effects expressed in FastTimeSnapshot.

Declaration
public bool EnableFast { get; }
Property Value
Type Description
Boolean
Remarks

This variable is set in the Unity Project Settings dialog.

EnablePause

Enable effects expressed in PausedSnapshot.

Declaration
public bool EnablePause { get; }
Property Value
Type Description
Boolean
Remarks

This variable is set in the Unity Project Settings dialog.

EnableSlow

Enable effects expressed in SlowTimeSnapshot.

Declaration
public bool EnableSlow { get; }
Property Value
Type Description
Boolean
Remarks

This variable is set in the Unity Project Settings dialog.

FastPitchRange

The pitch Mixer will be set to based on where falls in FastTimeRange.

Declaration
public Vector2 FastPitchRange { get; }
Property Value
Type Description
Vector2
Remarks

This variable is set in the Unity Project Settings dialog.

FastTimeRange

The range needs to be set to cause mixing of DefaultSnapshot and FastTimeSnapshot.

The and represents minimum and maximum range, respectively.

Declaration
public Vector2 FastTimeRange { get; }
Property Value
Type Description
Vector2
Remarks

This variable is set in the Unity Project Settings dialog.

FastTimeSnapshot

The snapshot to Mixer that kicks in when time quickens. This snapshot is mixed with DefaultSnapshot depending on .

Declaration
public AudioMixerSnapshot FastTimeSnapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
Remarks

This variable is set in the Unity Project Settings dialog.

Mixer

The audio mixer that plays the effect.

Declaration
public AudioMixer Mixer { get; }
Property Value
Type Description
AudioMixer
Remarks

This variable is set in the Unity Project Settings dialog.

PausedSnapshot

The snapshot to Mixer that kicks in when user pauses.

Declaration
public AudioMixerSnapshot PausedSnapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
Remarks

This variable is set in the Unity Project Settings dialog.

PitchParam

The parameter name to Mixer that changes the pitch.

Declaration
public string PitchParam { get; }
Property Value
Type Description
String
Remarks

This variable is set in the Unity Project Settings dialog.

SlowPitchRange

The pitch Mixer will be set to based on where falls in SlowTimeRange.

Declaration
public Vector2 SlowPitchRange { get; }
Property Value
Type Description
Vector2
Remarks

This variable is set in the Unity Project Settings dialog.

SlowTimeRange

The range needs to be set to cause mixing of DefaultSnapshot and SlowTimeSnapshot.

The and represents minimum and maximum range, respectively.

Declaration
public Vector2 SlowTimeRange { get; }
Property Value
Type Description
Vector2
Remarks

This variable is set in the Unity Project Settings dialog.

SlowTimeSnapshot

The snapshot to Mixer that kicks in when time slows. This snapshot is mixed with DefaultSnapshot depending on .

Declaration
public AudioMixerSnapshot SlowTimeSnapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
Remarks

This variable is set in the Unity Project Settings dialog.