Maestro - Midi Player Tool Kit for Unity Version 2.19.0
Loading...
Searching...
No Matches
MidiPlayerTK.MPTKEffectUnity
Effects Processing » Unity Effects

Unlike SoundFont effects, Unity effects are applied to the whole player.
Unity effect parameters are richer and are based on Unity audio algorithms.
https://docs.unity3d.com/Manual/class-AudioEffectMixer.html
Only the most important effects are integrated in Maestro: Reverb and Chorus. Additional Unity effects can be added if needed. More...

Public Member Functions

void DefaultAll ()
 Sets all Unity effects to default values as defined by Unity.
void DefaultReverb ()
 Sets Reverb Unity default values as defined by Unity.
void DefaultChorus ()
 Sets Chorus Unity default values as defined by Unity.

Properties

bool EnableReverb [get, set]
 Applies the Reverb Unity effect to the AudioSource. The effect is applied to all voices.
float ReverbDryLevel [get, set]
 Mix level of dry signal in output.
Ranges from 0 to 1.
float ReverbRoom [get, set]
 Room effect level at low frequencies.
Ranges from 0 to 1.
float ReverbRoomHF [get, set]
 Room effect high-frequency level.
Ranges from 0 to 1.
float ReverbRoomLF [get, set]
 Room effect low-frequency level.
Ranges from 0 to 1.
float ReverbDecayTime [get, set]
 Reverberation decay time at low-frequencies in seconds.
Ranges from 0.1 to 20. Default is 1.
float ReverbDecayHFRatio [get, set]
 Decay HF Ratio : High-frequency to low-frequency decay time ratio.
Ranges from 0.1 to 2.0.
float ReverbReflectionLevel [get, set]
 Early reflections level relative to room effect.
Ranges from 0 to 1.
float ReverbReflectionDelay [get, set]
 Late reverberation level relative to room effect.
Ranges from -10000.0 to 2000.0. Default is 0.0.
float ReverbLevel [get, set]
 Late reverberation level relative to room effect.
Ranges from 0 to 1.
float ReverbDelay [get, set]
 Late reverberation delay time relative to first reflection in seconds.
Ranges from 0 to 0.1. Default is 0.04.
float ReverbHFReference [get, set]
 Reference high frequency in Hz.
Ranges from 1000 to 20000. Default is 5000.
float ReverbLFReference [get, set]
 Reference low-frequency in Hz.
Ranges from 20 to 1000. Default is 250.
float ReverbDiffusion [get, set]
 Reverberation diffusion (echo density) in percent.
Ranges from 0 to 1. Default is 1.
float ReverbDensity [get, set]
 Reverberation density (modal density) in percent.
Ranges from 0 to 1.
bool EnableChorus [get, set]
 Applies the Chorus Unity effect to the AudioSource. The effect is applied to all voices.
float ChorusDryMix [get, set]
 Volume of original signal to pass to output.
Range from 0 to 1. Default = 0.5.
float ChorusWetMix1 [get, set]
 Volume of 1st chorus tap.
Range from 0 to 1. Default = 0.5.
float ChorusWetMix2 [get, set]
 Volume of 2nd chorus tap. This tap is 90 degrees out of phase of the first tap.
Range from 0 to 1. Default = 0.5.
float ChorusWetMix3 [get, set]
 Volume of 3rd chorus tap. This tap is 90 degrees out of phase of the second tap.
Range from 0 to 1. Default = 0.5.
float ChorusDelay [get, set]
 Chorus delay in ms.
Range from 0.1 to 100. Default = 40 ms.
float ChorusRate [get, set]
 Chorus modulation rate in Hz.
Range from 0 to 20. Default = 0.8 Hz.
float ChorusDepth [get, set]
 Chorus modulation depth.
Range from 0 to 1. Default = 0.03.

Detailed Description

Unlike SoundFont effects, Unity effects are applied to the whole player.
Unity effect parameters are richer and are based on Unity audio algorithms.
https://docs.unity3d.com/Manual/class-AudioEffectMixer.html
Only the most important effects are integrated in Maestro: Reverb and Chorus. Additional Unity effects can be added if needed.

Unlike SoundFont effects, these are applied to the whole player. Unity effect parameters are richer and are based on Unity algorithms.
https://docs.unity3d.com/Manual/class-AudioEffectMixer.html
Only the most important effects are integrated in Maestro: Reverb and Chorus. If needed, other effects could be added.

Version
Maestro Pro
Note
  • Unity effect integration modules are available only in Maestro MPTK Pro.
  • By default, these effects are disabled in Maestro.
  • To enable them, adjust settings in the prefab inspector: Synth Parameters / Unity Effect.
  • Each setting is also available by script.
// Find an MPTK prefab (also works for MidiStreamPlayer, MidiExternalPlayer, and all classes that inherit from MidiSynth).
MidiFilePlayer fp = FindFirstObjectByType<MidiFilePlayer>();
fp.MPTK_EffectUnity.EnableReverb = true;
fp.MPTK_EffectUnity.ReverbDelay = 0.09f;
MidiPlayerTK.MidiFilePlayer
Plays a MIDI file from the MidiDB. This class must be used with the prefab MidiFilePlayer....
Definition MidiFilePlayer.cs:69
Version
Maestro Pro
Note
  • Unity effect integration modules are available only in Maestro MPTK Pro.
  • By default, these effects are disabled in Maestro.
  • To enable them, adjust settings in the prefab inspector: Synth Parameters / Unity Effect.
  • Each setting is available by script.
// Find an MPTK prefab; this also works for MidiStreamPlayer, MidiExternalPlayer, and all classes that inherit from MidiSynth.
MidiFilePlayer fp = FindFirstObjectByType<MidiFilePlayer>();
fp.MPTK_EffectUnity.EnableReverb = true;
fp.MPTK_EffectUnity.ReverbDelay = 0.09f;

Member Function Documentation

◆ DefaultAll()

void MidiPlayerTK.MPTKEffectUnity.DefaultAll ( )

Sets all Unity effects to default values as defined by Unity.

midiFilePlayer.MPTK_EffectUnity.DefaultAll();

◆ DefaultReverb()

void MidiPlayerTK.MPTKEffectUnity.DefaultReverb ( )

Sets Reverb Unity default values as defined by Unity.

Version
Maestro Pro

◆ DefaultChorus()

void MidiPlayerTK.MPTKEffectUnity.DefaultChorus ( )

Sets Chorus Unity default values as defined by Unity.

Version
Maestro Pro

Property Documentation

◆ EnableReverb

bool MidiPlayerTK.MPTKEffectUnity.EnableReverb
getset

Applies the Reverb Unity effect to the AudioSource. The effect is applied to all voices.

Version
Maestro Pro
midiFilePlayer.MPTK_EffectUnity.EnableReverb= true;

◆ ReverbDryLevel

float MidiPlayerTK.MPTKEffectUnity.ReverbDryLevel
getset

Mix level of dry signal in output.
Ranges from 0 to 1.

Version
Maestro Pro

◆ ReverbRoom

float MidiPlayerTK.MPTKEffectUnity.ReverbRoom
getset

Room effect level at low frequencies.
Ranges from 0 to 1.

Version
Maestro Pro

◆ ReverbRoomHF

float MidiPlayerTK.MPTKEffectUnity.ReverbRoomHF
getset

Room effect high-frequency level.
Ranges from 0 to 1.

Version
Maestro Pro

◆ ReverbRoomLF

float MidiPlayerTK.MPTKEffectUnity.ReverbRoomLF
getset

Room effect low-frequency level.
Ranges from 0 to 1.

Version
Maestro Pro

◆ ReverbDecayTime

float MidiPlayerTK.MPTKEffectUnity.ReverbDecayTime
getset

Reverberation decay time at low-frequencies in seconds.
Ranges from 0.1 to 20. Default is 1.

Version
Maestro Pro

◆ ReverbDecayHFRatio

float MidiPlayerTK.MPTKEffectUnity.ReverbDecayHFRatio
getset

Decay HF Ratio : High-frequency to low-frequency decay time ratio.
Ranges from 0.1 to 2.0.

Version
Maestro Pro

◆ ReverbReflectionLevel

float MidiPlayerTK.MPTKEffectUnity.ReverbReflectionLevel
getset

Early reflections level relative to room effect.
Ranges from 0 to 1.

Version
Maestro Pro

◆ ReverbReflectionDelay

float MidiPlayerTK.MPTKEffectUnity.ReverbReflectionDelay
getset

Late reverberation level relative to room effect.
Ranges from -10000.0 to 2000.0. Default is 0.0.

Version
Maestro Pro

◆ ReverbLevel

float MidiPlayerTK.MPTKEffectUnity.ReverbLevel
getset

Late reverberation level relative to room effect.
Ranges from 0 to 1.

Version
Maestro Pro

◆ ReverbDelay

float MidiPlayerTK.MPTKEffectUnity.ReverbDelay
getset

Late reverberation delay time relative to first reflection in seconds.
Ranges from 0 to 0.1. Default is 0.04.

Version
Maestro Pro

◆ ReverbHFReference

float MidiPlayerTK.MPTKEffectUnity.ReverbHFReference
getset

Reference high frequency in Hz.
Ranges from 1000 to 20000. Default is 5000.

Version
Maestro Pro

◆ ReverbLFReference

float MidiPlayerTK.MPTKEffectUnity.ReverbLFReference
getset

Reference low-frequency in Hz.
Ranges from 20 to 1000. Default is 250.

Version
Maestro Pro

◆ ReverbDiffusion

float MidiPlayerTK.MPTKEffectUnity.ReverbDiffusion
getset

Reverberation diffusion (echo density) in percent.
Ranges from 0 to 1. Default is 1.

Version
Maestro Pro

◆ ReverbDensity

float MidiPlayerTK.MPTKEffectUnity.ReverbDensity
getset

Reverberation density (modal density) in percent.
Ranges from 0 to 1.

Version
Maestro Pro

◆ EnableChorus

bool MidiPlayerTK.MPTKEffectUnity.EnableChorus
getset

Applies the Chorus Unity effect to the AudioSource. The effect is applied to all voices.

Version
Maestro Pro

◆ ChorusDryMix

float MidiPlayerTK.MPTKEffectUnity.ChorusDryMix
getset

Volume of original signal to pass to output.
Range from 0 to 1. Default = 0.5.

Version
Maestro Pro

◆ ChorusWetMix1

float MidiPlayerTK.MPTKEffectUnity.ChorusWetMix1
getset

Volume of 1st chorus tap.
Range from 0 to 1. Default = 0.5.

Version
Maestro Pro

◆ ChorusWetMix2

float MidiPlayerTK.MPTKEffectUnity.ChorusWetMix2
getset

Volume of 2nd chorus tap. This tap is 90 degrees out of phase of the first tap.
Range from 0 to 1. Default = 0.5.

Version
Maestro Pro

◆ ChorusWetMix3

float MidiPlayerTK.MPTKEffectUnity.ChorusWetMix3
getset

Volume of 3rd chorus tap. This tap is 90 degrees out of phase of the second tap.
Range from 0 to 1. Default = 0.5.

Version
Maestro Pro

◆ ChorusDelay

float MidiPlayerTK.MPTKEffectUnity.ChorusDelay
getset

Chorus delay in ms.
Range from 0.1 to 100. Default = 40 ms.

Version
Maestro Pro

◆ ChorusRate

float MidiPlayerTK.MPTKEffectUnity.ChorusRate
getset

Chorus modulation rate in Hz.
Range from 0 to 20. Default = 0.8 Hz.

Version
Maestro Pro

◆ ChorusDepth

float MidiPlayerTK.MPTKEffectUnity.ChorusDepth
getset

Chorus modulation depth.
Range from 0 to 1. Default = 0.03.

Version
Maestro Pro