Public Member Functions | Properties | List of all members
MidiPlayerTK.MPTKEffectUnity

Unlike SoundFont effects, they applied to the whole player. On the other hand, the Unity effects parameters are rich and, obviously based on Uniy algo!
https://docs.unity3d.com/Manual/class-AudioEffectMixer.html
Only most important effect are integrated in Maestro: Reverb and Chorus. On need, others effects could be added. More...

Inherits ScriptableObject, and ScriptableObject.

Public Member Functions

void DefaultAll ()
 Set all Unity effects to default value as defined with Unity. More...
 
void DefaultChorus ()
 
void DefaultReverb ()
 

Properties

float ChorusDelay [get, set]
 
float ChorusDepth [get, set]
 
float ChorusDryMix [get, set]
 
float ChorusRate [get, set]
 
float ChorusWetMix1 [get, set]
 
float ChorusWetMix2 [get, set]
 
float ChorusWetMix3 [get, set]
 
bool EnableChorus [get, set]
 
bool EnableReverb [get, set]
 
float ReverbDecayHFRatio [get, set]
 
float ReverbDecayTime [get, set]
 
float ReverbDelay [get, set]
 
float ReverbDensity [get, set]
 
float ReverbDiffusion [get, set]
 
float ReverbDryLevel [get, set]
 
float ReverbHFReference [get, set]
 
float ReverbLevel [get, set]
 
float ReverbLFReference [get, set]
 
float ReverbReflectionDelay [get, set]
 
float ReverbReflectionLevel [get, set]
 
float ReverbRoom [get, set]
 
float ReverbRoomHF [get, set]
 
float ReverbRoomLF [get, set]
 

Detailed Description

Unlike SoundFont effects, they applied to the whole player. On the other hand, the Unity effects parameters are rich and, obviously based on Uniy algo!
https://docs.unity3d.com/Manual/class-AudioEffectMixer.html
Only most important effect are integrated in Maestro: Reverb and Chorus. On need, others effects could be added.

Version
Maestro Pro
Note
  • Unity effects integration modules are exclusively available with the Maestro MPTK Pro version.
  • By default, these effects are disabled in Maestro.
  • To enable them, you’ll need to adjust the settings from the prefab inspector: Synth Parameters / Unity Effect.
  • Each settings are available by script.
    // Find a MPTK Prefab, will works also for MidiStreamPlayer, MidiExternalPlayer ... all classes which inherit from MidiSynth.
    MidiFilePlayer fp = FindFirstObjectByType<MidiFilePlayer>();
    fp.MPTK_EffectUnity.EnableReverb = true;
    fp.MPTK_EffectUnity.ReverbDelay= 0.09f;
    MidiPlayerTK.MPTKEffectUnity.ReverbDelay
    float ReverbDelay
    Definition: MPTKEffectUnityPro.cs:231
    MidiPlayerTK.MidiFilePlayer
    Play a MIDI file from the MidiDB. This class must be used with the prefab MidiFilePlayer....
    Definition: MidiFilePlayer.cs:69
    MidiPlayerTK.MidiSynth.MPTK_EffectUnity
    MPTKEffectUnity MPTK_EffectUnity
    Unlike SoundFont effects, they applied to the whole player. On the other hand, the Unity effects para...
    Definition: MidiSynthPro.cs:203

Member Function Documentation

◆ DefaultAll()

void MidiPlayerTK.MPTKEffectUnity.DefaultAll ( )

Set all Unity effects to default value as defined with Unity.

midiFilePlayer.MPTK_EffectUnity.DefaultAll();

◆ DefaultChorus()

void MidiPlayerTK.MPTKEffectUnity.DefaultChorus ( )

Set Chorus Unity default value as defined with Unity.

Version
Maestro Pro

◆ DefaultReverb()

void MidiPlayerTK.MPTKEffectUnity.DefaultReverb ( )

Set Reverb Unity default value as defined with Unity.

Version
Maestro Pro

Property Documentation

◆ ChorusDelay

float MidiPlayerTK.MPTKEffectUnity.ChorusDelay
getset

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

Version
Maestro Pro

◆ ChorusDepth

float MidiPlayerTK.MPTKEffectUnity.ChorusDepth
getset

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

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

◆ ChorusRate

float MidiPlayerTK.MPTKEffectUnity.ChorusRate
getset

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

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

◆ EnableChorus

bool MidiPlayerTK.MPTKEffectUnity.EnableChorus
getset

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

Version
Maestro Pro

◆ EnableReverb

bool MidiPlayerTK.MPTKEffectUnity.EnableReverb
getset

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

Version
Maestro Pro
midiFilePlayer.MPTK_EffectUnity.EnableReverb= true;

◆ 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

◆ 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

◆ 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

◆ ReverbDensity

float MidiPlayerTK.MPTKEffectUnity.ReverbDensity
getset

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

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

◆ ReverbDryLevel

float MidiPlayerTK.MPTKEffectUnity.ReverbDryLevel
getset

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

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

◆ ReverbLevel

float MidiPlayerTK.MPTKEffectUnity.ReverbLevel
getset

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

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

◆ 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

◆ ReverbReflectionLevel

float MidiPlayerTK.MPTKEffectUnity.ReverbReflectionLevel
getset

Early reflections level relative to room effect.
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