[MPTK PRO] Play a Local MIDI file or from a Web site. This class must be used with the prefab MidiExternalPlayer
More...

Inheritance diagram for MidiPlayerTK.MidiExternalPlayer:

Public Types
enum	ModeSpatializer { Channel , Track }

Public Member Functions
int	MPTK_ChannelBankGetIndex (int channel)

int	MPTK_ChannelControllerGet (int channel, int controller)

int	MPTK_ChannelCount ()

bool	MPTK_ChannelEnableGet (int channel)

void	MPTK_ChannelEnableSet (int channel, bool enable)

int	MPTK_ChannelForcedPresetGet (int channel)

bool	MPTK_ChannelForcedPresetSet (int channel, int preset, int bank=-1)

string	MPTK_ChannelInfo (int channel)

int	MPTK_ChannelNoteCount (int channel)

bool	MPTK_ChannelPresetChange (int channel, int preset, int bank=-1)

int	MPTK_ChannelPresetGetIndex (int channel)

string	MPTK_ChannelPresetGetName (int channel)

float	MPTK_ChannelVolumeGet (int channel)

void	MPTK_ChannelVolumeSet (int channel, float volume)

void	MPTK_ChorusSetDefault ()

void	MPTK_ClearAllSound (bool destroyAudioSource=false, int _idSession=-1)

void	MPTK_InitSynth (int channelCount=16)

new MidiLoad	MPTK_Load ()

new void	MPTK_Next ()

MPTKEvent.EnumLength	MPTK_NoteLength (MPTKEvent note)

void	MPTK_Pause (float timeToPauseMS=-1f)

override void	MPTK_Play ()

void	MPTK_Play (byte[] data)

virtual void	MPTK_Play (float delayRampUp, float startDelay=0)

void	MPTK_Play (MidiFileWriter2 mfw2, float delayRampUp=0f)

void	MPTK_PlayNextOrPrevious (int offset)

new void	MPTK_Previous ()

List< MPTKEvent >	MPTK_ReadMidiEvents (long fromTicks=0, long toTicks=long.MaxValue)

void	MPTK_RePlay ()

void	MPTK_ResetStat ()

void	MPTK_ReverbSetDefault ()

bool	MPTK_SearchMidiToPlay (string name)

void	MPTK_SFChorusSetDefault ()

void	MPTK_SFFilterSetDefault ()

void	MPTK_SFReverbSetDefault ()

void	MPTK_StartSequencerMidi ()

void	MPTK_Stop ()

virtual void	MPTK_Stop (float delayRampDown, float stopDelay=0)

void	MPTK_StopSynth ()

void	MPTK_SwitchMidiWithDelay (int index, string name, float volume, float delayToStopMillisecond, float delayToStartMillisecond)

void	MPTK_UnPause ()

IEnumerator	MPTK_WaitAllNotesOff (int _idSession=-1)

delegate void	OnAudioFrameStartHandler (double synthTime)

Public Attributes
bool	MPTK_ApplyModLfo

bool	MPTK_ApplyRealTimeModulator

bool	MPTK_ApplySFChorus

bool	MPTK_ApplySFFilter

bool	MPTK_ApplySFReverb

bool	MPTK_ApplyVibLfo

bool	MPTK_AudioSettingFromUnity

bool	MPTK_AutoBuffer = true

int	MPTK_AutoCleanVoiceLimit

bool	MPTK_CorePlayer

float	MPTK_CutOffVolume = 0.05f

bool	MPTK_DirectSendToPlayer

bool	MPTK_EnableChangeTempo

bool	MPTK_EnableFreeSynthRate = false

bool	MPTK_EnablePanChange

bool	MPTK_EnablePresetDrum

bool	MPTK_KillByExclusiveClass = true

float	MPTK_LeanSynthStarting = 0.05f

bool	MPTK_LogWave

bool	MPTK_PauseOnFocusLoss

bool	MPTK_ReleaseSameNote = true

uint	MPTK_ReleaseTimeMin = 500000

float	MPTK_ReleaseTimeMod = 1f

bool	MPTK_ResetChannel = true

float	MPTK_SFChorusAmplify

float	MPTK_SFFilterFreqOffset = 0f

float	MPTK_SFReverbAmplify

bool	MPTK_SpatialSynthEnabled

bool	MPTK_StartPlayAtFirstNote

LoadingStatusMidiEnum	MPTK_StatusLastMidiLoaded

int	MPTK_StatVoiceCountActive

int	MPTK_StatVoiceCountFree

int	MPTK_StatVoicePlayed

float	MPTK_StatVoiceRatioReused

bool	MPTK_WeakDevice

EventEndMidiClass	OnEventEndPlayMidi

EventNotesMidiClass	OnEventNotesMidi

EventStartMidiClass	OnEventStartPlayMidi

EventSynthClass	OnEventSynthAwake

EventSynthClass	OnEventSynthStarted

Action< MPTKEvent >	OnMidiEvent

bool	playOnlyFirstWave

Static Public Attributes
static List< MidiFilePlayer >	SpatialSynths

Properties
bool	MPTK_ApplyUnityChorus `[get, set]`

bool	MPTK_ApplyUnityReverb `[get, set]`

float	MPTK_ChorusDelay `[get, set]`

float	MPTK_ChorusDepth `[get, set]`

float	MPTK_ChorusDryMix `[get, set]`

float	MPTK_ChorusRate `[get, set]`

float	MPTK_ChorusWetMix1 `[get, set]`

float	MPTK_ChorusWetMix2 `[get, set]`

float	MPTK_ChorusWetMix3 `[get, set]`

string	MPTK_Copyright `[get]`

int	MPTK_DeltaTicksPerQuarterNote `[get]`

TimeSpan	MPTK_Duration `[get]`

float	MPTK_DurationMS `[get]`

int	MPTK_IndexSynthBuffSize `[get, set]`

int	MPTK_IndexSynthRate `[get, set]`

string	MPTK_InstrumentPlayed `[get]`

bool	MPTK_IsPaused `[get]`

bool	MPTK_IsPlaying `[get]`

bool	MPTK_IsSpatialSynthMaster `[get]`

bool	MPTK_KeepEndTrack `[get, set]`

bool	MPTK_KeepNoteOff `[get, set]`

bool	MPTK_KeepPlayingNonLooped `[get, set]`

MPTKEvent	MPTK_LastEventPlayed `[get]`

bool	MPTK_LogEvents `[get, set]`

bool	MPTK_Loop `[get, set]`

float	MPTK_MaxDistance `[get, set]`

List< TrackMidiEvent >	MPTK_MidiEvents `[get]`

new int	MPTK_MidiIndex `[get, set]`

MidiLoad	MPTK_MidiLoaded `[get]`

new string	MPTK_MidiName `[get, set]`

bool	MPTK_PauseOnDistance `[get, set]`

bool	MPTK_PlayOnStart `[get, set]`

TimeSpan	MPTK_PlayTime `[get]`

double	MPTK_Position `[get, set]`

double	MPTK_PositionFirstNote `[get]`

double	MPTK_PositionLastNote `[get]`

string	MPTK_ProgramName `[get]`

double	MPTK_PulseLenght `[get]`

int	MPTK_Quantization `[get, set]`

double	MPTK_RealTime `[get]`

float	MPTK_ReverbDecayHFRatio `[get, set]`

float	MPTK_ReverbDecayTime `[get, set]`

float	MPTK_ReverbDelay `[get, set]`

float	MPTK_ReverbDensity `[get, set]`

float	MPTK_ReverbDiffusion `[get, set]`

float	MPTK_ReverbDryLevel `[get, set]`

float	MPTK_ReverbHFReference `[get, set]`

float	MPTK_ReverbLevel `[get, set]`

float	MPTK_ReverbLFReference `[get, set]`

float	MPTK_ReverbReflectionDelay `[get, set]`

float	MPTK_ReverbReflectionLevel `[get, set]`

float	MPTK_ReverbRoom `[get, set]`

float	MPTK_ReverbRoomHF `[get, set]`

float	MPTK_ReverbRoomLF `[get, set]`

string	MPTK_SequenceTrackName `[get]`

float	MPTK_SFChorusDepth `[get, set]`

float	MPTK_SFChorusLevel `[get, set]`

float	MPTK_SFChorusSpeed `[get, set]`

float	MPTK_SFChorusWidth `[get, set]`

float	MPTK_SFFilterQModOffset `[get, set]`

float	MPTK_SFReverbDamp `[get, set]`

float	MPTK_SFReverbLevel `[get, set]`

float	MPTK_SFReverbRoomSize `[get, set]`

float	MPTK_SFReverbWidth `[get, set]`

bool	MPTK_Spatialize `[get, set]`

int	MPTK_SpatialSynthIndex `[get]`

float	MPTK_Speed `[get, set]`

int	MPTK_SynthRate `[get, set]`

double	MPTK_Tempo `[get, set]`

string	MPTK_TextEvent `[get]`

long	MPTK_TickCurrent `[get, set]`

long	MPTK_TickFirstNote `[get]`

long	MPTK_TickLast `[get]`

long	MPTK_TickLastNote `[get]`

int	MPTK_TrackCount `[get]`

string	MPTK_TrackInstrumentName `[get]`

string	MPTK_TrackName `[get]`

int	MPTK_TransExcludedChannel `[get, set]`

int	MPTK_Transpose `[get, set]`

float	MPTK_Volume `[get, set]`

Events
OnAudioFrameStartHandler	OnAudioFrameStart

Detailed Description

[MPTK PRO] Play a Local MIDI file or from a Web site. This class must be used with the prefab MidiExternalPlayer

There is no need to writing a script. For a simple usage, all the job can be done in the prefab inspector.

But a set of methods are available in this class to drive the music from your script.
This class inherits from MidiFilePlayer and MidiSynth, so all properties, event, methods from MidiFilePlayer and MidiSynth are available in this class.

More information here: https://paxstellar.fr/midi-external-player-v2/

// Example of script. See TestMidiExternalPlayer.cs for a more detailed usage.
// Need for a reference to the Prefab (to be set in the hierarchy or can be done by script)
MidiExternalPlayer midiExternalPlayer;
 
if (midiExternalPlayer==null)  
   Debug.LogError("TestMidiExternalPlayer: there is no MidiExternalPlayer Prefab set in Inspector.");
   
midiExternalPlayer.MPTK_MidiName = "http://www.midiworld.com/midis/other/c2/bolero.mid";
midiExternalPlayer.MPTK_Play();

Member Enumeration Documentation

◆ ModeSpatializer

enum MidiPlayerTK.MidiSynth.ModeSpatializer

inherited

[MPTK PRO] Spatializer Mode for the prefab MidiSpatializer

Enumerator
Channel	Spatial Synth are enabled to dispatch note-on by channels. As a reminder, only one instrument at at time can be played by a MIDI channel Instrument (preset) are defined by channel with the MIDI message MPTKCommand.PatchChange
Track	Spatial Synth are enabled to dispatch note-on by tracks defined in the MIDI. As a reminder, multiple channels can be played on a tracks, so multiple instruments can be played on a Synth. Track name are defined with the Meta MIDI message SequenceTrackName. This MIDI message is always defined in MIDI, so name can be missing.

Member Function Documentation

◆ MPTK_ChannelBankGetIndex()

int MidiPlayerTK.MidiSynth.MPTK_ChannelBankGetIndex ( int channel )

inherited

Get the current bank associated to the channel.
Each MIDI channel can play a different preset and bank.

Parameters

channel MIDI channel must be between 0 and 15

◆ MPTK_ChannelControllerGet()

int MidiPlayerTK.MidiSynth.MPTK_ChannelControllerGet	(	int	channel,
		int	controller
	)

inherited

Get the current preset name for the channel.
Each MIDI channel can play a different preset.

Parameters

channel	MIDI channel must be between 0 and 15
controller	MIDI Controller must be between 0 and 127. See MPTKEvent::Controller

◆ MPTK_ChannelCount()

int MidiPlayerTK.MidiSynth.MPTK_ChannelCount ( )

inherited

Get channel length. The midi norm is 16, but MPTK can manage up to 32 channels (experimental).

Parameters

channel must be between 0 and 15

Returns: channel count

◆ MPTK_ChannelEnableGet()

bool MidiPlayerTK.MidiSynth.MPTK_ChannelEnableGet ( int channel )

inherited

Is channel is enabled or disabled.

Parameters

channel channel, must be between 0 and 15

Returns: true if channel is enabled

◆ MPTK_ChannelEnableSet()

void MidiPlayerTK.MidiSynth.MPTK_ChannelEnableSet	(	int	channel,
		bool	enable
	)

inherited

Disable (mute) or enable (unmute) a MIDI channel.

Parameters

channel	must be between 0 and 15
enable	true to unmute (default), false to mute channel

◆ MPTK_ChannelForcedPresetGet()

int MidiPlayerTK.MidiSynth.MPTK_ChannelForcedPresetGet ( int channel )

inherited

Set forced preset on the channel. MIDI will allways playing with this preset even if a MIDI Preset Change message is received.
Set to -1 to disable this behavior.

Parameters

channel

Returns: preset index, -1 if not set

int preset = midiFilePlayer.MPTK_ChannelForcedPresetGet(channel);
int bank = midiFilePlayer.MPTK_ChannelBankGetIndex(channel);
GUILayout.Label($"{preset} / {bank}");
int forcedPreset = (int)GUILayout.HorizontalSlider(preset, -1f, 127f);
if (forcedPreset != preset)
   midiFilePlayer.MPTK_ChannelForcedPresetSet(channel, forcedPreset);

◆ MPTK_ChannelForcedPresetSet()

bool MidiPlayerTK.MidiSynth.MPTK_ChannelForcedPresetSet	(	int	channel,
		int	preset,
		int	bank = `-1`
	)

inherited

Set a Preset on a channel to force the MIDI Synth to always playing with this instrument even if MIDI 'Preset Change' or 'Bank change' messages are received.
Set Preset to -1 to restore the Preset and Bank defined in the MIDI file.

Parameters

channel	0 to 15 channel
preset	Preset to force in the range 0 to 127 preset. Set to -1 to restore the Preset and Bank known from the MIDI file.
bank	Optionnal. Bank to force in the range 0 to 128. Set to -1 to restore to the last bank known from the MIDI file.

Returns: true if the preset/bank exists in the current SoudFont, otherwise false

// Example of changing the forced preset with the Unity GUI.
// ---------------------------------------------------------
int preset = midiFilePlayer.MPTK_ChannelPresetGetIndex(channel);
 
// Slider to change the preset on this channel from -1 (disable forced) to 127
// The forced bank is defined from the inspector.
int forcePreset = (int)GUILayout.HorizontalSlider(preset, -1f, 127f);
 
if (forcePreset != preset)
{
    // Force a preset whatever the MIDI events from the MIDI file.
    midiFilePlayer.MPTK_ChannelForcedPresetSet(channel, forcePreset);
}

Another example with MidiExternalPlayer.

// To force the preset from the start of the playing,
// the forced preset and the forced bank must be set 
// after the MIDI is loaded and before any MIDI message is played.
// The OnEventStartPlayMidi event is perfect for that.
// ---------------------------------------------------------------
 
// Get the prefab added to the hierarchy of the current scene
MidiExternalPlayer midiPlayer = FindObjectOfType<MidiExternalPlayer>();
 
// Set the listener on the event OnEventStartPlayMidi
midiPlayer.OnEventStartPlayMidi.AddListener((string midiName) =>
    {
        // Each time the MIDI is started this script is run
        // Force preset 70 for note-on on channel 0 (Bassoon is GM SoundFont)
        midiPlayer.MPTK_ChannelForcedPresetSet(0, 70, 1);
    });

◆ MPTK_ChannelInfo()

string MidiPlayerTK.MidiSynth.MPTK_ChannelInfo ( int channel )

inherited

Build an information string about the channel. It's also a good pretext to display an example of Channel API.
Exemple of return

Channel:2 Enabled [Preset:18, Bank:0] 'Rock Organ' Count:1 Volume:1
Channel:4 Muted [Preset:F44, Bank:0] 'Stereo Strings Trem' Count:33 Volume:0,50

Parameters

channel index channel

Returns: Information string

 
            GUILayout.BeginHorizontal();
            GUILayout.Label("Channel  Preset                                                Preset / Bank                   Count            Enabled       Volume", myStyle.TitleLabel3);
            GUILayout.EndHorizontal();
            for (int channel = 0; channel < midiFilePlayer.MPTK_ChannelCount(); channel++)
            {
                GUILayout.BeginHorizontal();
 
                // Display channel number and log info
                if (GUILayout.Button($"   {channel:00}", myStyle.TitleLabel3, GUILayout.Width(60)))
                    Debug.Log(midiFilePlayer.MPTK_ChannelInfo(channel));
 
                // Display preset
                GUILayout.Label(midiFilePlayer.MPTK_ChannelPresetGetName(channel) ?? "not set", myStyle.TitleLabel3, GUILayout.MaxWidth(150));
 
                // Display preset and bank index
                string sPreset = "";
                int presetForced = midiFilePlayer.MPTK_ChannelForcedPresetGet(channel);
                if (presetForced == -1)
                {
                    // Preset not forced, get the preset defined on this channel by the Midi
                    sPreset = midiFilePlayer.MPTK_ChannelPresetGetIndex(channel).ToString();
                }
                else
                {
                    sPreset = $"F{presetForced}";
                }
 
                int bankIndex = midiFilePlayer.MPTK_ChannelBankGetIndex(channel);
                GUILayout.Label($"{sPreset} / {bankIndex}", myStyle.LabelRight/*, GUILayout.Width(80)*/);
 
                int current = midiFilePlayer.MPTK_ChannelPresetGetIndex(channel);
                // Slider to change the preset on this channel from -1 (disable forced) to 127.
                // Forced bank from the inspector.
                int forcePreset = (int)GUILayout.HorizontalSlider(current,
                                                    -1f, 127f, myStyle.SliderBar, myStyle.SliderThumb, GUILayout.Width(100));
                if (forcePreset != current)
                {
                    // Force a preset and a bank whatever the MIDI events from the MIDI file.
                    // set forcePreset to -1 to restore to the last preset and bank value known from the MIDI file.
                    // let forcebank to -1 to not force the bank.
                    midiFilePlayer.MPTK_ChannelForcedPresetSet(channel, forcePreset, forceBank);
                }
 
                // Display count note by channel
                GUILayout.Label($"{midiFilePlayer.MPTK_ChannelNoteCount(channel),-5}", myStyle.LabelRight, GUILayout.Width(60));
 
                // Toggle to enable or disable a channel
                GUILayout.Label("   ", myStyle.TitleLabel3, GUILayout.Width(60));
                bool state = GUILayout.Toggle(midiFilePlayer.MPTK_ChannelEnableGet(channel), "", GUILayout.MaxWidth(20));
                if (state != midiFilePlayer.MPTK_ChannelEnableGet(channel))
                {
                    midiFilePlayer.MPTK_ChannelEnableSet(channel, state);
                    Debug.LogFormat("Channel {0} state:{1}, preset:{2}", channel, state, midiFilePlayer.MPTK_ChannelPresetGetName(channel) ?? "not set"); /*2.84*/
                }
 
                // Slider to change volume
                float currentVolume = midiFilePlayer.MPTK_ChannelVolumeGet(channel);
                GUILayout.Label($"{Math.Round(currentVolume, 2)}", myStyle.LabelRight, GUILayout.Width(40));
                float volume = GUILayout.HorizontalSlider(currentVolume, 0f, 1f, myStyle.SliderBar, myStyle.SliderThumb, GUILayout.Width(60));
                if (volume != currentVolume)
                {
                    midiFilePlayer.MPTK_ChannelVolumeSet(channel, volume);
                }
 
                GUILayout.EndHorizontal();
            }
 

◆ MPTK_ChannelNoteCount()

int MidiPlayerTK.MidiSynth.MPTK_ChannelNoteCount ( int channel )

inherited

Get count of notes played since the start of the MIDI.

Parameters

channel must be between 0 and 15

◆ MPTK_ChannelPresetChange()

bool MidiPlayerTK.MidiSynth.MPTK_ChannelPresetChange	(	int	channel,
		int	preset,
		int	bank = `-1`
	)

inherited

Change the Preset and/or Bank associated to a Channel.
The new value of the bank or preset are registered in the channel even if the preset or bannk is not found.
Each channel can have a different bank/preset set.
Note 1: When bank is changed, the preset list is not updated (MidiPlayerGlobal.MPTK_ListPreset). Call MidiPlayerGlobal.MPTK_SelectBankInstrument to refresh this list.
Note 2: When playing a MIDI file, MIDI messages like "Patch Change" and "ControlChange BankSelectMsb" will override value registered with this method.
Note 3: To change globally the bank, use instead the global methods: MidiPlayerGlobal.MPTK_SelectBankInstrument or MidiPlayerGlobal.MPTK_SelectBankDrum.
Note 4: The method MPTK_ChannelForcedPresetSet can be used to force the preset whatever the MIDI messages.

 
                // Change bank or preset with free value with MPTK_ChannelPresetChange
                // -------------------------------------------------------------------
 
                // Select any value in the range 0 and 128 for the bank 
                int bank = (int)Slider("Free Bank", midiStreamPlayer.MPTK_ChannelBankGetIndex(StreamChannel), 0, 128, false, 100, 200);
                // Select any value in the range 0 and 127 for the preset
                int prst = (int)Slider("Free Preset", midiStreamPlayer.MPTK_ChannelPresetGetIndex(StreamChannel), 0, 127, true, 100, 200);
                // If user made change for bank or preset ...
                if (bank != midiStreamPlayer.MPTK_ChannelBankGetIndex(StreamChannel) ||
                    prst != midiStreamPlayer.MPTK_ChannelPresetGetIndex(StreamChannel))
                {
                    // ... apply the change to the MidiStreamPlayer for the current channel.
                    // If the bank or the preset doestn't exist 
                    //      - the method returns false 
                    //      - the bank and preset are still registered in the channel
                    //      - when a note-on is received on this channel, the first preset of the first bank is used to play (usually piano).
                    bool ret = midiStreamPlayer.MPTK_ChannelPresetChange(StreamChannel, prst, bank);
 
                    // Read the current bank, preset and preset name selected
                    int newbank = midiStreamPlayer.MPTK_ChannelBankGetIndex(StreamChannel);
                    int newpreset = midiStreamPlayer.MPTK_ChannelPresetGetIndex(StreamChannel);
                    string newname = midiStreamPlayer.MPTK_ChannelPresetGetName(StreamChannel);
                    Debug.Log($"MPTK_ChannelPresetChange result:{ret} bank:{newbank} preset:{newpreset} '{newname}'");
                }

Parameters

channel	0 to 15. There is 16 channels available in the MIDI norm.
preset	The total number of presets available depend on the soundfont selected
bank	Optionnal, if not set or -1 the current bank will be applied (or default bank if never set). Default bank is defined globally: menu MPTK / SoundFont Setup.

Returns: true if the bank and the preset were found else false

◆ MPTK_ChannelPresetGetIndex()

int MidiPlayerTK.MidiSynth.MPTK_ChannelPresetGetIndex ( int channel )

inherited

Get channel preset index.

Parameters

channel must be between 0 and 15

◆ MPTK_ChannelPresetGetName()

string MidiPlayerTK.MidiSynth.MPTK_ChannelPresetGetName ( int channel )

inherited

Get the current preset name for the channel.
Each MIDI channel can play a different preset.

Parameters

channel MIDI channel must be between 0 and 15

◆ MPTK_ChannelVolumeGet()

float MidiPlayerTK.MidiSynth.MPTK_ChannelVolumeGet ( int channel )

inherited

Get the volume of the channel

Parameters

channel must be between 0 and 15

Returns: volume of the channel, between 0 and 1

◆ MPTK_ChannelVolumeSet()

void MidiPlayerTK.MidiSynth.MPTK_ChannelVolumeSet	(	int	channel,
		float	volume
	)

inherited

Set the volume for a channel as a percentage.

Parameters

channel	must be between 0 and 15 or -1 to apply to all channels
volume	percentage of volume from the global volume for the channel, must be between 0 and 1

◆ MPTK_ChorusSetDefault()

void MidiPlayerTK.MidiSynth.MPTK_ChorusSetDefault ( )

inherited

[MPTK PRO] Set Chorus Unity default value as defined with Unity.

◆ MPTK_ClearAllSound()

void MidiPlayerTK.MidiSynth.MPTK_ClearAllSound	(	bool	destroyAudioSource = `false`,
		int	_idSession = `-1`
	)

inherited

Clear all sound by sending note off.
That could take some seconds because release time for sample need to be played.

if (GUILayout.Button("Clear"))

midiStreamPlayer.MPTK_ClearAllSound(true);

Parameters

destroyAudioSource	usefull only in non core mode
_idSession	clear only for sample playing with this session, -1 for all (default)

◆ MPTK_InitSynth()

void MidiPlayerTK.MidiSynth.MPTK_InitSynth ( int channelCount = 16 )

inherited

Initialize the synthetizer: channel, voices, modulator.
It's not usefull to call this method if you are using prefabs (MidiFilePlayer, MidiStreamPlayer, ...).
Each gameObjects created from these prefabs have their own, autonomous and isolated synth.

Parameters

channelCount Number of channel to create, default 16. Any other values are experimental!

◆ MPTK_Load()

new MidiLoad MidiPlayerTK.MidiExternalPlayer.MPTK_Load ( )

Not applicable for external

◆ MPTK_Next()

new void MidiPlayerTK.MidiExternalPlayer.MPTK_Next ( )

Not applicable for external

◆ MPTK_NoteLength()

MPTKEvent.EnumLength MidiPlayerTK.MidiFilePlayer.MPTK_NoteLength ( MPTKEvent note )

inherited

Return note length as https://en.wikipedia.org/wiki/Note_value

Parameters

note

Returns: MPTKEvent.EnumLength

◆ MPTK_Pause()

void MidiPlayerTK.MidiFilePlayer.MPTK_Pause ( float timeToPauseMS = -1f )

inherited

Pause the current playing

Parameters

timeToPauseMS time to pause in milliseconds. default or < 0 : indefinitely

◆ MPTK_Play() [1/4]

override void MidiPlayerTK.MidiExternalPlayer.MPTK_Play ( )

virtual

Play the midi file defined in MPTK_MidiName

Reimplemented from MidiPlayerTK.MidiFilePlayer.

◆ MPTK_Play() [2/4]

void MidiPlayerTK.MidiFilePlayer.MPTK_Play ( byte[] data )

inherited

Play the midi file from a byte array.
Look at MPTK_StatusLastMidiLoaded to get status.

// Example of using with Windows or MACOs
using (Stream fsMidi = new FileStream(filepath, FileMode.Open, FileAccess.Read))
{
      byte[] data = new byte[fsMidi.Length];
      fsMidi.Read(data, 0, (int) fsMidi.Length);
      midiFilePlayer.MPTK_Play(data);
}

◆ MPTK_Play() [3/4]

virtual void MidiPlayerTK.MidiFilePlayer.MPTK_Play	(	float	delayRampUp,
		float	startDelay = `0`
	)

virtualinherited

[MPTK PRO] Play the midi file defined with MPTK_MidiName or MPTK_MidiIndex with ramp-up to the volume defined with MPTK_Volume.
The time to get a MIDI playing at full MPTK_Volume is delayRampUp + startDelay.
A delayed start can also be set.

Parameters

delayRampUp	ramp-up delay in milliseconds to get the default volume
startDelay	delayed start in milliseconds V2.89.1

◆ MPTK_Play() [4/4]

void MidiPlayerTK.MidiFilePlayer.MPTK_Play	(	MidiFileWriter2	mfw2,
		float	delayRampUp = `0f`
	)

inherited

[MPTK PRO] Play the midi from a MidiFileWriter2 object

Parameters

mfw2	aMidiFileWriter2 object
delayRampUp

◆ MPTK_PlayNextOrPrevious()

void MidiPlayerTK.MidiFilePlayer.MPTK_PlayNextOrPrevious ( int offset )

inherited

[MPTK PRO] Play next or previous Midi from the MidiDB list.

Parameters

offset Forward or backward count in the list. 1:the next, -1:the previous

◆ MPTK_Previous()

new void MidiPlayerTK.MidiExternalPlayer.MPTK_Previous ( )

Not applicable for external

◆ MPTK_ReadMidiEvents()

List< MPTKEvent > MidiPlayerTK.MidiFilePlayer.MPTK_ReadMidiEvents	(	long	fromTicks = `0`,
		long	toTicks = `long.MaxValue`
	)

inherited

V2.88.2 - Read the list of midi events available in the MIDI from a ticks position to an end position.

 
        private void TheMostSimpleDemoForMidiPlayer()
        {
            MidiFilePlayer midiplayer = FindObjectOfType<MidiFilePlayer>();
            if (midiplayer == null)
            {
                Debug.LogWarning("Can't find a MidiFilePlayer Prefab in the current Scene Hierarchy. Add it with the MPTK menu.");
                return;
            }
 
            // Index of the midi from the Midi DB (find it with 'Midi File Setup' from the menu MPTK)
            midiplayer.MPTK_MidiIndex = 10;
 
            // Open and load the Midi
            midiplayer.MPTK_Load();
 
            // Read midi event to a List<>
            List<MPTKEvent> mptkEvents = midiplayer.MPTK_ReadMidiEvents();
 
            // Loop on each Midi events
            foreach (MPTKEvent mptkEvent in mptkEvents)
            {
                // Log if event is a note on
                if (mptkEvent.Command == MPTKCommand.NoteOn)
                    Debug.Log($"Note on Time:{mptkEvent.RealTime} millisecond  Note:{mptkEvent.Value}  Duration:{mptkEvent.Duration} millisecond  Velocity:{mptkEvent.Velocity}");
 
                // Uncomment to display all Midi events
                //Debug.Log(mptkEvent.ToString());
            }
        }

Parameters

fromTicks	ticks start, default 0
toTicks	ticks end, default end of MIDI file

Returns

◆ MPTK_RePlay()

void MidiPlayerTK.MidiFilePlayer.MPTK_RePlay ( )

inherited

Restart playing of the current midi file

◆ MPTK_ResetStat()

void MidiPlayerTK.MidiSynth.MPTK_ResetStat ( )

inherited

Reset voices statistics

◆ MPTK_ReverbSetDefault()

void MidiPlayerTK.MidiSynth.MPTK_ReverbSetDefault ( )

inherited

[MPTK PRO] Set Reverb Unity default value as defined with Unity.

◆ MPTK_SearchMidiToPlay()

bool MidiPlayerTK.MidiFilePlayer.MPTK_SearchMidiToPlay ( string name )

inherited

[MPTK PRO] Find a Midi in the Unity resources folder MidiDB which contains the name (case sensitive)
Tips: Add Midi files to your project with the Unity menu MPTK or add it directly in the ressource folder and open Midi File Setup to automatically integrate Midi in MPTK.

// Find the first Midi file name in MidiDB which contains "Adagio"
midiFilePlayer.MPTK_SearchMidiToPlay("Adagio");
// And play it
midiFilePlayer.MPTK_Play();

Parameters

name	case sensitive part of a midi file name

Returns: true if found else false

◆ MPTK_SFChorusSetDefault()

void MidiPlayerTK.MidiSynth.MPTK_SFChorusSetDefault ( )

inherited

[MPTK PRO] Set Chrous SoundFont default value as defined in fluidsynth.
FLUID_CHORUS_DEFAULT_N 3
FLUID_CHORUS_DEFAULT_LEVEL 2.0 but set to 0.9 (thank John)
FLUID_CHORUS_DEFAULT_SPEED 0.3
FLUID_CHORUS_DEFAULT_DEPTH 8.0
FLUID_CHORUS_DEFAULT_TYPE FLUID_CHORUS_MOD_SINE
WIDTH 10

◆ MPTK_SFFilterSetDefault()

void MidiPlayerTK.MidiSynth.MPTK_SFFilterSetDefault ( )

inherited

[MPTK PRO] Set Filter SoundFont default value as defined in fluidsynth.

◆ MPTK_SFReverbSetDefault()

void MidiPlayerTK.MidiSynth.MPTK_SFReverbSetDefault ( )

inherited

[MPTK PRO] Set Reverb SoundFont default value as defined in fluidsynth.
FLUID_REVERB_DEFAULT_ROOMSIZE 0.2f
FLUID_REVERB_DEFAULT_DAMP 0.0f
FLUID_REVERB_DEFAULT_WIDTH 0.5f
FLUID_REVERB_DEFAULT_LEVEL 0.9f

Default chorus voice count

◆ MPTK_StartSequencerMidi()

void MidiPlayerTK.MidiSynth.MPTK_StartSequencerMidi ( )

inherited

Start the MIDI sequencer: each midi events are read and play in a dedicated thread.
This thread is automatically started by prefabs MidiFilePlayer, MidiListPlayer, MidiExternalPlayer.

◆ MPTK_Stop() [1/2]

void MidiPlayerTK.MidiFilePlayer.MPTK_Stop ( )

inherited

Stop playing

◆ MPTK_Stop() [2/2]

virtual void MidiPlayerTK.MidiFilePlayer.MPTK_Stop	(	float	delayRampDown,
		float	stopDelay = `0`
	)

virtualinherited

[MPTK PRO] Stop playing within a delay. After the stop delay (0 by default), the volume decrease until the playing is stopped.
The time to get a real MIDI stop is delayRampDown + stopDelay.

Parameters

delayRampDown	decrease time in millisconds
stopDelay	delayed stop in milliseconds V2.89.1

◆ MPTK_StopSynth()

void MidiPlayerTK.MidiSynth.MPTK_StopSynth ( )

inherited

Stop processing samples by the synth and the MIDI sequencer.

◆ MPTK_SwitchMidiWithDelay()

void MidiPlayerTK.MidiFilePlayer.MPTK_SwitchMidiWithDelay	(	int	index,
		string	name,
		float	volume,
		float	delayToStopMillisecond,
		float	delayToStartMillisecond
	)

inherited

[MPTK PRO] Switch playing between two MIDIs with ramp-up.
This method is useful for an integration with Bolt: main MIDI parameters are defined in one call.

Parameters

index	Index of the MIDI to play. Index is used only if name parameter is null or empty.
name	Name of the MIDI to play. Can be part of the MIDI Name. If set, this parameter has the priority over index parameter.
volume	Volume of the MIDI. -1 to not change the default volume
delayToStopMillisecond	Delay to stop the current MIDI playing (with volume decrease) or delay before playing the MIDI if no MIDI is playing
delayToStartMillisecond	Delay to get the MIDI at full volume (ramp-up volume)

◆ MPTK_UnPause()

void MidiPlayerTK.MidiFilePlayer.MPTK_UnPause ( )

inherited

UnPause the current playing

◆ MPTK_WaitAllNotesOff()

IEnumerator MidiPlayerTK.MidiSynth.MPTK_WaitAllNotesOff ( int _idSession = -1 )

inherited

Wait until all notes are off.
That could take some seconds due to the samples release time.
Therefore, the method exit after a timeout of 3 seconds.
*** Use this method only as a coroutine ***

     // Call this method with: StartCoroutine(NextPreviousWithWait(false)); 
     // See TestMidiFilePlayerScripting.cs
     public IEnumerator NextPreviousWithWait(bool next)
     {
         midiFilePlayer.MPTK_Stop();
         yield return midiFilePlayer.MPTK_WaitAllNotesOff(midiFilePlayer.IdSession);
         if (next)
             midiFilePlayer.MPTK_Next();
         else
             midiFilePlayer.MPTK_Previous();
         CurrentIndexPlaying = midiFilePlayer.MPTK_MidiIndex;
     yield return 0;
}

Parameters

_idSession clear only for samples playing with this session, -1 for all

Returns

◆ OnAudioFrameStartHandler()

delegate void MidiPlayerTK.MidiSynth.OnAudioFrameStartHandler ( double synthTime )

inherited

[MPTK PRO] Delegate for the event OnAudioFrameStartHandler. see OnAudioFrameStart

Parameters

synthTime

Member Data Documentation

◆ MPTK_ApplyModLfo

bool MidiPlayerTK.MidiSynth.MPTK_ApplyModLfo

inherited

Apply LFO effect defined in the SoundFont

◆ MPTK_ApplyRealTimeModulator

bool MidiPlayerTK.MidiSynth.MPTK_ApplyRealTimeModulator

inherited

Apply real time modulatoreffect defined in the SoundFont: pitch bend, control change, enveloppe modulation

◆ MPTK_ApplySFChorus

bool MidiPlayerTK.MidiSynth.MPTK_ApplySFChorus

inherited

[MPTK PRO] Apply chorus effect as defined in the SoundFont.
This effect is processed with the fluidsynth algo independently on each voices but with a small decrease of performace (10%).

◆ MPTK_ApplySFFilter

bool MidiPlayerTK.MidiSynth.MPTK_ApplySFFilter

inherited

[MPTK PRO] Apply frequency low-pass filter as defined in the SoundFont.
This effect is processed with the fluidsynth algo independently on each voices but with a small decrease of performace (40%).

◆ MPTK_ApplySFReverb

bool MidiPlayerTK.MidiSynth.MPTK_ApplySFReverb

inherited

[MPTK PRO] Apply reverberation effect as defined in the SoundFont.
This effect is processed with the fluidsynth algo independently on each voices but with a small decrease of performace (40%).

◆ MPTK_ApplyVibLfo

bool MidiPlayerTK.MidiSynth.MPTK_ApplyVibLfo

inherited

Apply vibrato effect defined in the SoundFont

◆ MPTK_AudioSettingFromUnity

bool MidiPlayerTK.MidiSynth.MPTK_AudioSettingFromUnity

inherited

If true then rate synth and buffer size will be automatically defined by Unity in accordance of the capacity of the hardware. - V2.89.0 -
Look at Unity menu "Edit / Project Settings..." and select between best latency and best performance.
If false, then rate and buffer size can be defined manually ... but with the risk of bad audio quality. It's more an experimental capacities!

◆ MPTK_AutoBuffer

bool MidiPlayerTK.MidiSynth.MPTK_AutoBuffer = true

inherited

Voice buffering is important to get better performance. But you can disable this fonction with this parameter.

◆ MPTK_AutoCleanVoiceLimit

int MidiPlayerTK.MidiSynth.MPTK_AutoCleanVoiceLimit

inherited

Free voices older than MPTK_AutoCleanVoiceLimit are removed when count is over than MPTK_AutoCleanVoiceTime

◆ MPTK_CorePlayer

bool MidiPlayerTK.MidiSynth.MPTK_CorePlayer

inherited

If true then MIDI events are read and play from a dedicated thread.
If false, MidiSynth will use AudioSource gameobjects to play sound.
This properties must be defined before running the application from the inspector.
The default is true.
Warning: The non core mode player (MPTK_CorePlayer=false) will be removed with the next major version (V3)

◆ MPTK_CutOffVolume

float MidiPlayerTK.MidiSynth.MPTK_CutOffVolume = 0.05f

inherited

When amplitude is below this value the playing of sample is stopped (voice_off).
Can be increase for better performance but with degraded quality because sample could be stopped earlier. Remember: Amplitude can varying between 0 and 1.

◆ MPTK_DirectSendToPlayer

bool MidiPlayerTK.MidiSynth.MPTK_DirectSendToPlayer

inherited

If true (default) then MIDI events are sent automatically to the midi player.
Set to false if you want to process events without playing sound.
OnEventNotesMidi Unity Event can be used to process each notes.

◆ MPTK_EnableChangeTempo

bool MidiPlayerTK.MidiSynth.MPTK_EnableChangeTempo

inherited

Should accept change tempo from MIDI Events ?

◆ MPTK_EnableFreeSynthRate

bool MidiPlayerTK.MidiSynth.MPTK_EnableFreeSynthRate = false

inherited

Allow direct setting of the Synth Rate

◆ MPTK_EnablePanChange

bool MidiPlayerTK.MidiSynth.MPTK_EnablePanChange

inherited

Should change pan from MIDI Events or from SoundFont ?
Pan is disabled when Spatialization is activated.

◆ MPTK_EnablePresetDrum

bool MidiPlayerTK.MidiSynth.MPTK_EnablePresetDrum

inherited

Should accept change Preset for Drum canal 10 ?
Disabled by default. Could sometimes create bad sound with midi files not really compliant with the MIDI norm.

◆ MPTK_KillByExclusiveClass

bool MidiPlayerTK.MidiSynth.MPTK_KillByExclusiveClass = true

inherited

V2.83 Find the exclusive class of this voice. If set, kill all voices that match the exclusive class
and are younger than the first voice process created by this noteon event.

◆ MPTK_LeanSynthStarting

float MidiPlayerTK.MidiSynth.MPTK_LeanSynthStarting = 0.05f

inherited

V2.873 - A lean startup of the volume of the synth is useful to avoid weird sound at the beginning of the application (in some cases).
This parameter sets the speed of the increase of the volume of the audio source.
Set to 1 for an immediate full volume at start.

◆ MPTK_LogWave

bool MidiPlayerTK.MidiSynth.MPTK_LogWave

inherited

Log for each wave to be played

◆ MPTK_PauseOnFocusLoss

bool MidiPlayerTK.MidiFilePlayer.MPTK_PauseOnFocusLoss

inherited

Should the MIDI playing must be paused when the application lost the focus?

◆ MPTK_ReleaseSameNote

bool MidiPlayerTK.MidiSynth.MPTK_ReleaseSameNote = true

inherited

V2.83. If the same note is hit twice on the same channel, then the older voice process is advanced to the release stage.
It's the default Midi processing.

◆ MPTK_ReleaseTimeMin

uint MidiPlayerTK.MidiSynth.MPTK_ReleaseTimeMin = 500000

inherited

[Only when CorePlayer=False] Define a minimum release time at noteoff in 100 iem nanoseconds.
Default 50 ms is a good tradeoff. Below some unpleasant sound could be heard. Useless when MPTK_CorePlayer is true.

◆ MPTK_ReleaseTimeMod

float MidiPlayerTK.MidiSynth.MPTK_ReleaseTimeMod = 1f

inherited

When a note is stopped with a noteoff or when the duration is over, note continue to play for a short time depending the instrument.

This parameter is a multiplier to increase or decrease the default release time defined in the SoundFont for each instrument.
Recommended values between 0.1 and 10. Default is 1 (no modification of the release time).
Performance issue: the longer it lasts the more CPU is used after the noteon. With a long release time, a lot of samples will be played simultaneously.

◆ MPTK_ResetChannel

bool MidiPlayerTK.MidiSynth.MPTK_ResetChannel = true

inherited

Reset channel information when MIDI start playing. V2.89.0

◆ MPTK_SFChorusAmplify

float MidiPlayerTK.MidiSynth.MPTK_SFChorusAmplify

inherited

[MPTK PRO] Chorus level is defined in the SoundFont in the range [0, 1].
This parameter is added to the the default SoundFont value.
Range must be [-1, 1]

◆ MPTK_SFFilterFreqOffset

float MidiPlayerTK.MidiSynth.MPTK_SFFilterFreqOffset = 0f

inherited

[MPTK PRO] Frequency cutoff is defined in the SoundFont for each notes.
This parameter increase or decrease the default SoundFont value. Range: -2000 to 3000

◆ MPTK_SFReverbAmplify

float MidiPlayerTK.MidiSynth.MPTK_SFReverbAmplify

inherited

[MPTK PRO] Reverberation level is defined in the SoundFont in the range [0, 1].
This parameter is added to the the default SoundFont value.
Range must be [-1, 1]

◆ MPTK_SpatialSynthEnabled

bool MidiPlayerTK.MidiSynth.MPTK_SpatialSynthEnabled

inherited

[MPTK PRO] In spatialization mode not all MidiSynths are enabled.

◆ MPTK_StartPlayAtFirstNote

bool MidiPlayerTK.MidiFilePlayer.MPTK_StartPlayAtFirstNote

inherited

When the value is true, the playing begins at the first note found
. Often, the first note is not set at the beginning of the MIDI file (tick=0).
So there is a delay before playing the first note.
This setting is useful to start the playing at the first note found. Apply also when looping.
No impact on MPTK_Duration which stay the same, so there is a shift between the real time of the MIDI and the theoretical duration.

◆ MPTK_StatusLastMidiLoaded

LoadingStatusMidiEnum MidiPlayerTK.MidiFilePlayer.MPTK_StatusLastMidiLoaded

inherited

Status of the last midi loaded. The status is updated in a coroutine, so the status can change at each frame.

◆ MPTK_StatVoiceCountActive

int MidiPlayerTK.MidiSynth.MPTK_StatVoiceCountActive

inherited

Count of the active voices (playing) - Readonly

◆ MPTK_StatVoiceCountFree

int MidiPlayerTK.MidiSynth.MPTK_StatVoiceCountFree

inherited

Count of the free voices for reusing on need.
Voice older than AutoCleanVoiceTime are removed but only when count is over than AutoCleanVoiceLimit - Readonly

◆ MPTK_StatVoicePlayed

int MidiPlayerTK.MidiSynth.MPTK_StatVoicePlayed

inherited

Count of voice played since the start of the synth

◆ MPTK_StatVoiceRatioReused

float MidiPlayerTK.MidiSynth.MPTK_StatVoiceRatioReused

inherited

Percentage of voice reused during the synth life. 0: any reuse, 100:all voice reused (unattainable, of course!)

◆ MPTK_WeakDevice

bool MidiPlayerTK.MidiSynth.MPTK_WeakDevice

inherited

Should play on a weak device (cheaper smartphone) ? Apply only with AudioSource mode (MPTK_CorePlayer=False).
Playing MIDI files with WeakDevice activated could cause some bad interpretation of MIDI Event, consequently bad sound.

◆ OnEventEndPlayMidi

EventEndMidiClass MidiPlayerTK.MidiFilePlayer.OnEventEndPlayMidi

inherited

Define the Unity event to be triggered at end of playing the midi.

using MidiPlayerTK; // Add a reference to the MPTK namespace at the top of your script
using UnityEngine;        
 
public class YourClass : MonoBehaviour
{
    MidiFilePlayer midiFilePlayer;
 
    void Start()
    {
        // Get a reference to the prefab MidiFilePlayer from the hierarchy in the scene
        midiFilePlayer = FindObjectOfType<MidiFilePlayer>(); 
         
        // Add a listener on the MIDI File Player.
        // NotesToPlay will be called for each new group of notes read by the MIDI sequencer from the MIDI file.
    midiFilePlayer.OnEventEndPlayMidi.AddListener(EndPlay);
    }
 
    public void EndPlay(string midiname, EventEndMidiEnum reason)
    {
        Debug.LogFormat($"End playing midi {midiname} reason:{reason}");
    }
}

◆ OnEventNotesMidi

EventNotesMidiClass MidiPlayerTK.MidiFilePlayer.OnEventNotesMidi

inherited

Define the Unity event to be triggered when notes are available from the MIDI file.
It's not possible to alter playing music by modifying note properties (pitch, velocity, ....) here.

using MidiPlayerTK; // Add a reference to the MPTK namespace at the top of your script
using UnityEngine;        
 
public class YourClass : MonoBehaviour
{
    
    MidiFilePlayer midiFilePlayer;
 
    void Start()
    {
        // Get a reference to the prefab MidiFilePlayer from the hierarchy in the scene
        midiFilePlayer = FindObjectOfType<MidiFilePlayer>(); 
         
        // Add a listener on the MIDI File Player.
        // NotesToPlay will be called for each new group of notes read by the MIDI sequencer from the MIDI file.
        midiFilePlayer.OnEventNotesMidi.AddListener(NotesToPlay);
    }
 
    // This method will be called by the MIDI sequencer just before the notes
    // are playing by the MIDI synthesizer (if 'Send To Synth' is enabled)
    public void NotesToPlay(List<MPTKEvent> mptkEvents)
    {
        Debug.Log("Received " + mptkEvents.Count + " MIDI Events");
        // Loop on each MIDI events
        foreach (MPTKEvent mptkEvent in mptkEvents)
        {
            // Log if event is a note on
            if (mptkEvent.Command == MPTKCommand.NoteOn)
                Debug.Log($"Note on Time:{mptkEvent.RealTime} millisecond  Note:{mptkEvent.Value}  Duration:{mptkEvent.Duration} millisecond  Velocity:{mptkEvent.Velocity}");
                
            // Uncomment to display all MIDI events
            // Debug.Log(mptkEvent.ToString());
        }
    }
}

◆ OnEventStartPlayMidi

EventStartMidiClass MidiPlayerTK.MidiFilePlayer.OnEventStartPlayMidi

inherited

Define the Unity event to be triggered at start of playing the Midi.
MIDI File is loaded, Midi Synth is initialized, but so far any MIDI event has been read.
This is the right time to defined some specific behaviors.

using MidiPlayerTK; // Add a reference to the MPTK namespace at the top of your script
using UnityEngine;        
 
public class YourClass : MonoBehaviour
{
    MidiFilePlayer midiFilePlayer;
 
    void Start()
    {
        // Get a reference to the prefab MidiFilePlayer from the hierarchy in the scene
        midiFilePlayer = FindObjectOfType<MidiFilePlayer>(); 
         
        // Add a listener on the MIDI File Player.
        // NotesToPlay will be called for each new group of notes read by the MIDI sequencer from the MIDI file.
        midiFilePlayer.OnEventStartPlayMidi.AddListener(StartPlay);
    }
 
    public void StartPlay(string midiname)
    {
        Debug.LogFormat($"Start playing midi {midiname}");
        
        // Disable MIDI channel 9 (generally drums)
        midiFilePlayer.MPTK_ChannelEnableSet(9, false);
        
        // Set start position
        midiFilePlayer.MPTK_TickCurrent = 500;        
    }
} 

◆ OnEventSynthAwake

EventSynthClass MidiPlayerTK.MidiSynth.OnEventSynthAwake

inherited

Unity event fired at awake of the synthesizer. Name of the gameobject component is passed as a parameter.
Setting this callback function by script (AddListener) is not recommended. It's better to set callback function from the inspector.

Example of script (but it's recommended to set callback function from the inspector).

...
   midiStreamPlayer.OnEventSynthAwake.AddListener(StartLoadingSynth);
...
public void StartLoadingSynth(string name)
{
    Debug.LogFormat("Synth {0} loading", name);
}

◆ OnEventSynthStarted

EventSynthClass MidiPlayerTK.MidiSynth.OnEventSynthStarted

inherited

Unity event fired at start of the synthesizer. Name of the gameobject component is passed as a parameter.
Setting this callback function by script (AddListener) is not recommended. It's better to set callback function from the inspector.

Example of script (it's recommended to set callback function from the inspector).

 
        public void EndLoadingSynth(string name)
        {
            Debug.LogFormat($"Synth {name} loaded, now change bank and preset");
 
            // It's recommended to defined callback method (here EndLoadingSynth) in the prefab MidiStreamPlayer from the Unity editor inspector. 
            // EndLoadingSynth will be called when the synthesizer will be ready.
            // These calls will not work in Unity Awake() or Startup() because Midi synth must be ready when changing preset and/or bank.
 
            // Mandatory for updating UI list but not for playing sample.
            // The default instrument and drum banks are defined with the popup "SoundFont Setup Alt-F" in the Unity editor.
            // This method can be used by script to change the instrument bank and build presets available for it: MPTK_ListPreset.
            MidiPlayerGlobal.MPTK_SelectBankInstrument(CurrentBank);
 
            // Don't forget to initialize your MidiStreamPlayer variable, see link below:
            // https://paxstellar.fr/api-mptk-v2/#DefinedVariablePrefab
 
            // Channel 0: set Piano (if SoundFont is GeneralUser GS v1.471)
            // Define bank with CurrentBank (value defined in inspector to 0).
            midiStreamPlayer.MPTK_PlayEvent(new MPTKEvent() { Command = MPTKCommand.ControlChange, Controller = MPTKController.BankSelectMsb, Value = CurrentBank, Channel = StreamChannel, });
            Debug.LogFormat($"   Bank '{CurrentBank}' defined on channel {StreamChannel}");
 
            // Defined preset with CurrentPreset (value defined in inspector to 0).
            midiStreamPlayer.MPTK_ChannelPresetChange(StreamChannel, CurrentPreset);
            Debug.LogFormat($"   Preset '{midiStreamPlayer.MPTK_ChannelPresetGetName(0)}' defined on channel {StreamChannel}");
 
            // Playing a preset from another bank in the channel 1
 
            // Channel 1: set Laser Gun (if SoundFont is GeneralUser GS v1.471)
            int channel = 1, bank = 2, preset = 127;
            midiStreamPlayer.MPTK_PlayEvent(new MPTKEvent() { Command = MPTKCommand.ControlChange, Controller = MPTKController.BankSelectMsb, Value = bank, Channel = channel, });
            midiStreamPlayer.MPTK_ChannelPresetChange(channel, preset);
            // MPTK_GetPatchName mandatory for getting the patch nane when the bank is not the default bank.
            Debug.LogFormat($"   Preset '{MidiPlayerGlobal.MPTK_GetPatchName(bank, preset)}' defined on channel {channel} and bank {bank}");
        }
 

◆ OnMidiEvent

Action<MPTKEvent> MidiPlayerTK.MidiSynth.OnMidiEvent

inherited

[MPTK PRO] V2.89.0 - This function is called by the MIDI sequencer before sending the MIDI message to the MIDI synthesizer.
It can be used like a MIDI events preprocessor: it's possible to change the value of the MIDI events and therefore change the playback of the song.
The callback function receives a MPTKEvent object by reference (normal, it's a C# class).
Look at https://mptkapi.paxstellar.com/d9/d50/class_midi_player_t_k_1_1_m_p_t_k_event.html
A lot change is possible on the MIDI event: change note, velocity, channel, ..., even changing the MIDI type of the message!!!
See below some examples of changes.

Note 1: the callback is running on a system thread not on the Unity thread. Unity API call is not possible except for the Debug.Log (to be gently used, it consumes CPU)
Note 2: avoid heavy processing or waiting inside the callback otherwise MIDI playing accuracy will be bad.
Note 3: the midiEvent is passed by reference to the callback, so re-instanciate object (midiEvent = new MPTKEvent()) or set to null, has no effect!
Note 4: MIDI position attributs (Tick and RealTime) can be used in your algo but changing their values has no effect, it's too late!
Note 5: Changing SetTempo event is too late for the MIDI Sequencer (already taken into account). But you can use midiFilePlayer.MPTK_Tempo to change the tempo

// See TestMidiFilePlayerScripting.cs for the demo.

void Start()

{

MidiFilePlayer midiFilePlayer = FindObjectOfType<MidiFilePlayer>();

midiFilePlayer.OnMidiEvent = PreProcessMidi;

}

// Some example

void PreProcessMidi(MPTKEvent midiEvent)

{

switch (midiEvent.Command)

{

case MPTKCommand.NoteOn:

if (midiEvent.Channel != 9)

// transpose 2 octaves

midiEvent.Value += 24;

else

// Drums are muted

midiEvent.Velocity = 0;

break;

case MPTKCommand.PatchChange:

// Remove all patch change: all channels will played the default preset 0!!!

midiEvent.Command = MPTKCommand.MetaEvent;

midiEvent.Meta = MPTKMeta.TextEvent;

midiEvent.Info = "Patch Change removed";

break;

case MPTKCommand.MetaEvent:

if (midiEvent.Meta == MPTKMeta.SetTempo)

// Tempo forced to 100

midiFilePlayer.MPTK_Tempo = 100

break;

}

}

MidiPlayerTK.MPTKEvent.Meta
MPTKMeta Meta
Definition: MPTKEvent.cs:450

MidiPlayerTK.MPTKEvent.Channel
int Channel
Definition: MPTKEvent.cs:507

MidiPlayerTK.MPTKMeta
MPTKMeta
Definition: MPTKEvent.cs:318

◆ playOnlyFirstWave

bool MidiPlayerTK.MidiSynth.playOnlyFirstWave

inherited

Preset are often composed with 2 or more samples, classically for left and right channel. Check this to play only the first sample found

◆ SpatialSynths

List<MidiFilePlayer> MidiPlayerTK.MidiSynth.SpatialSynths

staticinherited

Contains each Midi Synth for each channel or track when the prefab MidiSpatializer is used and IsMidiChannelSpace=true.
Warning: only one MidiSpatializer can be used in a hierarchy.

Property Documentation

◆ MPTK_ApplyUnityChorus

bool MidiPlayerTK.MidiSynth.MPTK_ApplyUnityChorus

getsetinherited

[MPTK PRO] Apply Chorus Unity effect to the AudioSource. The effect is applied to all voices.

◆ MPTK_ApplyUnityReverb

bool MidiPlayerTK.MidiSynth.MPTK_ApplyUnityReverb

getsetinherited

[MPTK PRO] Apply Reverb Unity effect to the AudioSource. The effect is applied to all voices.

◆ MPTK_ChorusDelay

float MidiPlayerTK.MidiSynth.MPTK_ChorusDelay

getsetinherited

[MPTK PRO] Chorus delay in ms.
Range from 0.1 to 100. Default = 40 ms.

◆ MPTK_ChorusDepth

float MidiPlayerTK.MidiSynth.MPTK_ChorusDepth

getsetinherited

[MPTK PRO] Chorus modulation depth.
Range from 0 to 1. Default = 0.03.

◆ MPTK_ChorusDryMix

float MidiPlayerTK.MidiSynth.MPTK_ChorusDryMix

getsetinherited

[MPTK PRO] Volume of original signal to pass to output.
Range from 0 to 1. Default = 0.5.

◆ MPTK_ChorusRate

float MidiPlayerTK.MidiSynth.MPTK_ChorusRate

getsetinherited

[MPTK PRO] Chorus modulation rate in hz.
Range from 0 to 20. Default = 0.8 hz.

◆ MPTK_ChorusWetMix1

float MidiPlayerTK.MidiSynth.MPTK_ChorusWetMix1

getsetinherited

[MPTK PRO] Volume of 1st chorus tap.
Range from 0 to 1. Default = 0.5.

◆ MPTK_ChorusWetMix2

float MidiPlayerTK.MidiSynth.MPTK_ChorusWetMix2

getsetinherited

[MPTK PRO] 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.

◆ MPTK_ChorusWetMix3

float MidiPlayerTK.MidiSynth.MPTK_ChorusWetMix3

getsetinherited

[MPTK PRO] 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.

◆ MPTK_Copyright

string MidiPlayerTK.MidiFilePlayer.MPTK_Copyright

getinherited

Get Copyright if defined in the MIDI file with MIDI MetaEventType = Copyright
See detail here https://ccrma.stanford.edu/~craig/14q/midifile/MidiFileFormat.html
Can be used only when the MIDI is playing.

◆ MPTK_DeltaTicksPerQuarterNote

int MidiPlayerTK.MidiFilePlayer.MPTK_DeltaTicksPerQuarterNote

getinherited

Delta Ticks Per Quarter Note. Indicate the duration time in "ticks" which make up a quarter-note.
For instance, if 96, then a duration of an eighth-note in the file would be 48.
More info here https://paxstellar.fr/2020/09/11/midi-timing/

Move forward one quarter

midiFilePlayer.MPTK_TickCurrent = midiFilePlayer.MPTK_TickCurrent + midiFilePlayer.MPTK_DeltaTicksPerQuarterNote;

◆ MPTK_Duration

TimeSpan MidiPlayerTK.MidiFilePlayer.MPTK_Duration

getinherited

Real duration expressed in TimeSpan of the full midi from the first event (tick=0) to the last event.
If MPTK_KeepEndTrack is false, the MIDI events End Track are not considered to calculate this time.
The tempo changes are taken into account if MPTK_EnableChangeTempo is set to true before loading the MIDI.

◆ MPTK_DurationMS

float MidiPlayerTK.MidiFilePlayer.MPTK_DurationMS

getinherited

Real duration expressed in milliseconds of the full midi from the first event (tick=0) to the last event.
If MPTK_KeepEndTrack is false, the MIDI events End Track are not considered to calculate this time.
The tempo changes are taken into account if MPTK_EnableChangeTempo is set to true before loading the MIDI.

◆ MPTK_IndexSynthBuffSize

int MidiPlayerTK.MidiSynth.MPTK_IndexSynthBuffSize

getsetinherited

Set or Get synth buffer size -1:default, 0:64, 1;128, 2:256, 3:512, 4:1024, 5:2048.
The change is global for all prefab. It's better to stop playing for all prefab before changing on fly to avoid bad noise or crash.

◆ MPTK_IndexSynthRate

int MidiPlayerTK.MidiSynth.MPTK_IndexSynthRate

getsetinherited

Set or Get sample rate output of the synth. -1:default, 0:24000, 1:36000, 2:48000, 3:60000, 4:72000, 5:84000, 6:96000.
It's better to stop playing before changing on fly to avoid bad noise.

◆ MPTK_InstrumentPlayed

string MidiPlayerTK.MidiSynth.MPTK_InstrumentPlayed

getinherited

[MPTK PRO] If spatialization is track mode, contains the last instrument played on this track

◆ MPTK_IsPaused

bool MidiPlayerTK.MidiFilePlayer.MPTK_IsPaused

getinherited

Is MIDI file playing is paused ?

◆ MPTK_IsPlaying

bool MidiPlayerTK.MidiFilePlayer.MPTK_IsPlaying

getinherited

Is MIDI file is playing ?

◆ MPTK_IsSpatialSynthMaster

bool MidiPlayerTK.MidiSynth.MPTK_IsSpatialSynthMaster

getinherited

[MPTK PRO] True if this MidiSynth is the master synth responsible to read midi events and to dispatch to other MidiSynths

◆ MPTK_KeepEndTrack

bool MidiPlayerTK.MidiFilePlayer.MPTK_KeepEndTrack

getsetinherited

When set to true, meta MIDI event End Track are keep. Default is false.
If set to true, the End Track Event are taken into account for calculate the full duration of the MIDI.
See MPTK_DurationMS.

◆ MPTK_KeepNoteOff

bool MidiPlayerTK.MidiFilePlayer.MPTK_KeepNoteOff

getsetinherited

When the value is true, MIDI NoteOff events are keep from the MIDI file.
NoteOff in the stream have any impact on the MIDI synthesizer because
samples are stopped after a duration not from the NoteOff event.

◆ MPTK_KeepPlayingNonLooped

bool MidiPlayerTK.MidiSynth.MPTK_KeepPlayingNonLooped

getsetinherited

V2.83 When the value is true, NoteOff and Duration for non-looped samples are ignored and the samples play through to the end.

◆ MPTK_LastEventPlayed

MPTKEvent MidiPlayerTK.MidiFilePlayer.MPTK_LastEventPlayed

getinherited

Last MIDI event read or played

◆ MPTK_LogEvents

bool MidiPlayerTK.MidiFilePlayer.MPTK_LogEvents

getsetinherited

Log midi events

◆ MPTK_Loop

bool MidiPlayerTK.MidiFilePlayer.MPTK_Loop

getsetinherited

When the value is true, the current MIDI playing is restarted when it reaches the end.
The MIDI file doesn't need to be reloaded, the looping is almost immediate.

◆ MPTK_MaxDistance

float MidiPlayerTK.MidiSynth.MPTK_MaxDistance

getsetinherited

If MPTK_Spatialize is enabled, the volume of the audio source depends on the distance between the audio source and the listener.
Beyong this distance, the volume is set to 0 and the midi player is paused. No effect if MPTK_Spatialize is disabled.

◆ MPTK_MidiEvents

List<TrackMidiEvent> MidiPlayerTK.MidiFilePlayer.MPTK_MidiEvents

getinherited

[DEPRECATED] Get all the raw midi events available in the midi file.
Use rather the method MPTK_ReadMidiEvents from the prefab class MidiFileLoader or from MidiFilePrefab (Pro only).

◆ MPTK_MidiIndex

new int MidiPlayerTK.MidiExternalPlayer.MPTK_MidiIndex

getset

Not applicable for external

◆ MPTK_MidiLoaded

MidiLoad MidiPlayerTK.MidiFilePlayer.MPTK_MidiLoaded

getinherited

Get detailed information about the MIDI playing. This readonly properties is available only when a MIDI has been loaded.

◆ MPTK_MidiName

new string MidiPlayerTK.MidiExternalPlayer.MPTK_MidiName

getset

Full path to Midi file or URL to play. Must start with file:// or http:// or https://. Example: MPTK_MidiName="http://www.midiworld.com/midis/other/c2/bolero.mid"; See https://en.wikipedia.org/wiki/File_URI_scheme for example of URI file

◆ MPTK_PauseOnDistance

bool MidiPlayerTK.MidiSynth.MPTK_PauseOnDistance

getsetinherited

[obsolete] replaced by MPTK_Spatialize"); V2.83

◆ MPTK_PlayOnStart

bool MidiPlayerTK.MidiFilePlayer.MPTK_PlayOnStart

getsetinherited

Should the MIDI start playing when the application starts ?

◆ MPTK_PlayTime

TimeSpan MidiPlayerTK.MidiFilePlayer.MPTK_PlayTime

getinherited

Time from the start of playing the current midi

◆ MPTK_Position

double MidiPlayerTK.MidiFilePlayer.MPTK_Position

getsetinherited

Set or get the current position in the MIDI.
Note 1: works only when the MIDI is playing.
Note 2: you can't set the position before or just after MPTK_Play() because MPTK_Play() reset the position at the start.
Note 3: rather, set the position when the event OnEventStartPlayMidi() is triggered. See example bellow.
Note 4: look also the properties MPTK_TickCurrent to change the position by MIDI ticks.
Note 5: when the MIDI is playing look at the inspector of the MidiFilePlayer prefab to read (or change) the current position in seconds and find the position you want.
Here, there is more info about Midi Timing https://paxstellar.fr/2020/09/11/midi-timing/
See example:

public MidiFilePlayer midiFilePlayer;
void Start()
{
   // Find the prefab MidiFilePlayer in your scene
   midiFilePlayer = FindObjectOfType<MidiFilePlayer>();
   // Event trigger when midi file start playing
   midiFilePlayer.OnEventStartPlayMidi.AddListener(info => StartPlay("Event set by script"));
   // beginning playing
   midiFilePlayer.MPTK_Play();
}
 
// Method executed when the MIDI file start playing
public void StartPlay(string name)
{
    // The MIDI will start playing at 5 seconds from the beginning of the MIDI
    midiFilePlayer.MPTK_Position = 5000;
}
 
void Update()
{
    if ('condition from your application is true')
        // The MIDI will continue playing at 10 seconds from the beginning of the MIDI
        midiFilePlayer.MPTK_Position = 10000;
}

◆ MPTK_PositionFirstNote

double MidiPlayerTK.MidiFilePlayer.MPTK_PositionFirstNote

getinherited

Real time position in millisecond for the first note-on found.
Most MIDI don't start playing a note immediately. There is often a delay.
Use this attribute to known the real time wich it will start.
See also MPTK_TickFirstNote

◆ MPTK_PositionLastNote

double MidiPlayerTK.MidiFilePlayer.MPTK_PositionLastNote

getinherited

Real time position in millisecond for the last note-on found in the MIDI.
There is often other MIDI events after the last note-on: for example event track-end.
Use this attribute to known the real time when all sound will be stop.
See also the MPTK_DurationMS which provides the full time of all MIDI events including track-end, control at the beginning and at the end, ....
See also MPTK_TickLastNote

◆ MPTK_ProgramName

string MidiPlayerTK.MidiFilePlayer.MPTK_ProgramName

getinherited

Get Program track name if defined in the MIDI file with MIDI MetaEventType = ProgramName
See detail here https://ccrma.stanford.edu/~craig/14q/midifile/MidiFileFormat.html
Can be used only when the MIDI is playing.

◆ MPTK_PulseLenght

double MidiPlayerTK.MidiFilePlayer.MPTK_PulseLenght

getinherited

Lenght in millisecond of a MIDI tick. The pulse length is the minimum time in millisecond between two MIDI events.
It's like a definition of resolution: the MIDI sequencer will not be able to play
two separate MIDI events in a time below this value.
Obviously depends on the current tempo and the ticks per quarter.
PulseLenght = tempo / DeltaTicksPerQuarterNote / 1000 / Speed

◆ MPTK_Quantization

int MidiPlayerTK.MidiFilePlayer.MPTK_Quantization

getsetinherited

Level of quantization :

0 = None
1 = Quarter Note
2 = Eighth Note
3 = 16th Note
4 = 32th Note
5 = 64th Note
6 = 128th Note

◆ MPTK_RealTime

double MidiPlayerTK.MidiFilePlayer.MPTK_RealTime

getinherited

V2.89.0 - Real time in milliseconds from the beginning of playing of the MIDI.
MPTK_Tempo or MPTK_Speed change have no impact, it's just a system timer not linked to MIDI information.

◆ MPTK_ReverbDecayHFRatio

float MidiPlayerTK.MidiSynth.MPTK_ReverbDecayHFRatio

getsetinherited

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

◆ MPTK_ReverbDecayTime

float MidiPlayerTK.MidiSynth.MPTK_ReverbDecayTime

getsetinherited

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

◆ MPTK_ReverbDelay

float MidiPlayerTK.MidiSynth.MPTK_ReverbDelay

getsetinherited

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

◆ MPTK_ReverbDensity

float MidiPlayerTK.MidiSynth.MPTK_ReverbDensity

getsetinherited

[MPTK PRO] Reverberation density (modal density) in percent.
Ranges from 0 to 1.

◆ MPTK_ReverbDiffusion

float MidiPlayerTK.MidiSynth.MPTK_ReverbDiffusion

getsetinherited

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

◆ MPTK_ReverbDryLevel

float MidiPlayerTK.MidiSynth.MPTK_ReverbDryLevel

getsetinherited

[MPTK PRO] Mix level of dry signal in output.
Ranges from 0 to 1.

◆ MPTK_ReverbHFReference

float MidiPlayerTK.MidiSynth.MPTK_ReverbHFReference

getsetinherited

[MPTK PRO] Reference high frequency in Hz.
Ranges from 1000 to 20000. Default is 5000

◆ MPTK_ReverbLevel

float MidiPlayerTK.MidiSynth.MPTK_ReverbLevel

getsetinherited

[MPTK PRO] Late reverberation level relative to room effect.
Ranges from 0 to 1.

◆ MPTK_ReverbLFReference

float MidiPlayerTK.MidiSynth.MPTK_ReverbLFReference

getsetinherited

[MPTK PRO] Reference low-frequency in Hz.
Ranges from 20 to 1000. Default is 250

◆ MPTK_ReverbReflectionDelay

float MidiPlayerTK.MidiSynth.MPTK_ReverbReflectionDelay

getsetinherited

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

◆ MPTK_ReverbReflectionLevel

float MidiPlayerTK.MidiSynth.MPTK_ReverbReflectionLevel

getsetinherited

[MPTK PRO] Early reflections level relative to room effect.
Ranges from 0 to 1.

◆ MPTK_ReverbRoom

float MidiPlayerTK.MidiSynth.MPTK_ReverbRoom

getsetinherited

[MPTK PRO] Room effect level at low frequencies.
Ranges from 0 to 1.

◆ MPTK_ReverbRoomHF

float MidiPlayerTK.MidiSynth.MPTK_ReverbRoomHF

getsetinherited

[MPTK PRO] Room effect high-frequency level.
Ranges from 0 to 1.

◆ MPTK_ReverbRoomLF

float MidiPlayerTK.MidiSynth.MPTK_ReverbRoomLF

getsetinherited

[MPTK PRO] Room effect low-frequency level.
Ranges from 0 to 1.

◆ MPTK_SequenceTrackName

string MidiPlayerTK.MidiFilePlayer.MPTK_SequenceTrackName

getinherited

Get sequence track name if defined in the MIDI file with MIDI MetaEventType = SequenceTrackName
See detail here https://ccrma.stanford.edu/~craig/14q/midifile/MidiFileFormat.html
Can be used only when the MIDI is playing.

◆ MPTK_SFChorusDepth

float MidiPlayerTK.MidiSynth.MPTK_SFChorusDepth

getsetinherited

[MPTK PRO] Set the SoundFont chorus effect depth
Chorus depth [0, 256]
V2.88.2

◆ MPTK_SFChorusLevel

float MidiPlayerTK.MidiSynth.MPTK_SFChorusLevel

getsetinherited

[MPTK PRO] Set the SoundFont chorus effect level [0, 10]
V2.88.2 - becomes a parameter and default value set to 0.9 (was 2f, thank John)

◆ MPTK_SFChorusSpeed

float MidiPlayerTK.MidiSynth.MPTK_SFChorusSpeed

getsetinherited

[MPTK PRO] Set the SoundFont chorus effect speed
Chorus speed in Hz [0.1, 5]
V2.88.2

◆ MPTK_SFChorusWidth

float MidiPlayerTK.MidiSynth.MPTK_SFChorusWidth

getsetinherited

[MPTK PRO] Set the SoundFont chorus effect width
The chorus unit process a monophonic input signal and produces stereo output controlled by WIDTH macro.
Width allows to get a gradually stereo effect from minimum (monophonic) to maximum stereo effect. [0, 10]
V2.88.2

◆ MPTK_SFFilterQModOffset

float MidiPlayerTK.MidiSynth.MPTK_SFFilterQModOffset

getsetinherited

[MPTK PRO] Quality Factor is defined in the SoundFont for each notes.
This parameter increase or decrease the default SoundFont value. Range: -96 to 96.

◆ MPTK_SFReverbDamp

float MidiPlayerTK.MidiSynth.MPTK_SFReverbDamp

getsetinherited

[MPTK PRO] Set the SoundFont reverb effect damp [0,1].
Controls the reverb time frequency dependency. This controls the reverb time for the frequency sample rate/2
When 0, the reverb time for high frequencies is the same as for DC frequency.
When > 0, high frequencies have less reverb time than lower frequencies.
V2.88.2

◆ MPTK_SFReverbLevel

float MidiPlayerTK.MidiSynth.MPTK_SFReverbLevel

getsetinherited

[MPTK PRO] Set the SoundFont reverb effect level
V2.88.2

◆ MPTK_SFReverbRoomSize

float MidiPlayerTK.MidiSynth.MPTK_SFReverbRoomSize

getsetinherited

[MPTK PRO] Set the SoundFont reverb effect room size. Controls concave reverb time between 0 (0.7 s) and 1 (12.5 s)
V2.88.2

◆ MPTK_SFReverbWidth

float MidiPlayerTK.MidiSynth.MPTK_SFReverbWidth

getsetinherited

[MPTK PRO] Set the SoundFont reverb effect width [0,100].
Controls the left/right output separation.
When 0, there are no separation and the signal on left and right output is the same.This sounds like a monophonic signal.
When 100, the separation between left and right is maximum.
V2.88.2

◆ MPTK_Spatialize

bool MidiPlayerTK.MidiSynth.MPTK_Spatialize

getsetinherited

Should the Spatialization effect must be enabled?
See here how to setup spatialization with Unity https://paxstellar.fr/midi-file-player-detailed-view-2/#Foldout-Spatialization-Parameters if MPTK_Spatialize is true:
AudioSource.maxDistance = MPTK_MaxDistance
AudioSource.spatialBlend = 1
AudioSource.spatialize = true
AudioSource.spatializePostEffects = true

◆ MPTK_SpatialSynthIndex

int MidiPlayerTK.MidiSynth.MPTK_SpatialSynthIndex

getinherited

Index of the MidiSynth for the dedicated Channel or Track when the prefab MidiSpatializer is used.
If MPTK_ModeSpatializer = Channel then represent the playing channel.
If MPTK_ModeSpatializer = Track then represent the playing track.
The value is -1 for the Midi reader because no voice is played.

◆ MPTK_Speed

float MidiPlayerTK.MidiFilePlayer.MPTK_Speed

getsetinherited

Percentage value of the playing speed. Range 0.1 (10%) to 10 (1000%). Default is 1 for normal speed.

◆ MPTK_SynthRate

int MidiPlayerTK.MidiSynth.MPTK_SynthRate

getsetinherited

Get the the current synth rate or set free value (only if MPTK_EnableFreeSynthRate is true).

◆ MPTK_Tempo

double MidiPlayerTK.MidiFilePlayer.MPTK_Tempo

getsetinherited

Get or change the current tempo played by the internal MIDI sequencer (independent from MPTK_Speed).
Return QuarterPerMinuteValue similar to BPM (Beat Per Measure).
Notes:

Can be handle only when the MIDI is playing.
Changing the current tempo when playing has no impact on the calculated duration of the MIDI.

◆ MPTK_TextEvent

string MidiPlayerTK.MidiFilePlayer.MPTK_TextEvent

getinherited

Get Text if defined in the MIDI file with MIDI MetaEventType = TextEvent
See detail here https://ccrma.stanford.edu/~craig/14q/midifile/MidiFileFormat.html
Can be used only when the MIDI is playing.

◆ MPTK_TickCurrent

long MidiPlayerTK.MidiFilePlayer.MPTK_TickCurrent

getsetinherited

Set or get the current tick position in the MIDI.
MIDI tick is an easy way to identify a position in a song independently of the time which could vary with tempo change.
The count of ticks for a quarter is constant all along a Midi: see properties MPTK_DeltaTicksPerQuarterNote.
Example: with a time signature of 4/4 the ticks length of a bar is 4 * MPTK_DeltaTicksPerQuarterNote.
Note 1: works only when the MIDI is playing.
Note 2: you can't set the position before or just after MPTK_Play() because MPTK_Play() reset the position at the start.
Note 3: rather, set the position when the event OnEventStartPlayMidi() is triggereed. See example below.
Note 4: look also the properties MPTK_Position to change the position by milliseconds.
Note 5: when the MIDI is playing look at the inspector of the MidiFilePlayer prefab to read (or change) the current tick and find the position you want.
Here, there is more info about Midi Timing https://paxstellar.fr/2020/09/11/midi-timing/
See example:

public MidiFilePlayer midiFilePlayer;
void Start()
{
   // Find the prefab MidiFilePlayer in your scene
   midiFilePlayer = FindObjectOfType<MidiFilePlayer>();
   // Event trigger when midi file start playing
   midiFilePlayer.OnEventStartPlayMidi.AddListener(info => StartPlay("Event set by script"));
   // beginning playing
   midiFilePlayer.MPTK_Play();
}
 
// Method executed when the MIDI file start playing
public void StartPlay(string name)
{
    // The MIDI will start playing at tick 10000 
    midiFilePlayer.MPTK_TickCurrent = 10000;
}
 
void Update()
{
    if ('condition from your application is true')
        // The MIDI will continue playing at ticks 20000
        midiFilePlayer.MPTK_TickCurrent = 20000;
}

◆ MPTK_TickFirstNote

long MidiPlayerTK.MidiFilePlayer.MPTK_TickFirstNote

getinherited

Tick position for the first note-on found.
Most MIDI don't start playing a note immediately. There is often a delay.
Use this attribute to known the tick position where the will start to play a sound.
See also MPTK_PositionFirstNote

◆ MPTK_TickLast

long MidiPlayerTK.MidiFilePlayer.MPTK_TickLast

getinherited

Last tick position in Midi: it's the value of the tick for the last MIDI event in sequence expressed in number of "ticks".

◆ MPTK_TickLastNote

long MidiPlayerTK.MidiFilePlayer.MPTK_TickLastNote

getinherited

Tick position for the last note-on found.
There is often other MIDI events after the last note-on: for example event track-end.
Use this attribute to known the tick position time when all sound will be stop.
See also the MPTK_PositionLastNote which provides the last time of the MIDI.

◆ MPTK_TrackCount

int MidiPlayerTK.MidiFilePlayer.MPTK_TrackCount

getinherited

Count of track read in the MIDI file

◆ MPTK_TrackInstrumentName

string MidiPlayerTK.MidiFilePlayer.MPTK_TrackInstrumentName

getinherited

Get Instrument track name if defined in the MIDI file with MIDI MetaEventType = TrackInstrumentName
See detail here https://ccrma.stanford.edu/~craig/14q/midifile/MidiFileFormat.html
Can be used only when the MIDI is playing.

◆ MPTK_TrackName

string MidiPlayerTK.MidiSynth.MPTK_TrackName

getinherited

[MPTK PRO] If spatialization is track mode, contains the last name of the track

◆ MPTK_TransExcludedChannel

int MidiPlayerTK.MidiSynth.MPTK_TransExcludedChannel

getsetinherited

Transpose will apply to all channels except this one. Set to -1 to apply to all channel. V2.89.0
Default is 9 because generally we don't want to transpose drum channel.

◆ MPTK_Transpose

int MidiPlayerTK.MidiSynth.MPTK_Transpose

getsetinherited

Transpose note from -24 to 24

◆ MPTK_Volume

float MidiPlayerTK.MidiSynth.MPTK_Volume

getsetinherited

Global Volume. apply to all channels.
Must be >=0 and <= 1

Event Documentation

◆ OnAudioFrameStart

OnAudioFrameStartHandler MidiPlayerTK.MidiSynth.OnAudioFrameStart

inherited

[MPTK PRO] this event is triggered at each start of a new audio frame from the audio engine.
The parameter (double) is the current synth time in milliseconds. See example of use.
The callbach function will not run on the Unity thread, so you can't call Unity API except Debug.Log.

// See Assets\MidiPlayer\Demo\ProDemos\Script\EuclideSeq\TestEuclideanRhythme.cs for the full code.
public void Play()
{
    if (IsPlaying)
        midiStream.OnAudioFrameStart += PlayHits;
    else
        midiStream.OnAudioFrameStart -= PlayHits;
}
private void PlayHits(double synthTimeMS)
{
    if (lastSynthTime <= 0d)
        // First call, init the last time
        lastSynthTime = synthTimeMS;
    // Calculate time in millisecond since the last loop
    double deltaTime = synthTimeMS - lastSynthTime;
    lastSynthTime = synthTimeMS;
    timeMidiFromStartPlay += deltaTime;
 
    // Calculate time since last beat played
    timeSinceLastBeat += deltaTime;
 
    // Slider SldTempo in BPM.
    //  60 BPM means 60 beats in each minute, 1 beat per second, 1000 ms between beat.
    // 120 BPM would be twice as fast: 120 beats in each minute, 2 per second, 500 ms between beat.
    // Calculate the delay between two quarter notes in millisecond
    CurrentTempo = (60d / SldTempo.Value) * 1000d;
 
    // Is it time to play a hit ?
    if (IsPlaying && timeSinceLastBeat > CurrentTempo)
    {
        timeSinceLastBeat = 0d;
        CurrentBeat++;
    }
}

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Properties

Events

Detailed Description

Member Enumeration Documentation

◆ ModeSpatializer

Member Function Documentation

◆ MPTK_ChannelBankGetIndex()

◆ MPTK_ChannelControllerGet()

◆ MPTK_ChannelCount()

◆ MPTK_ChannelEnableGet()

◆ MPTK_ChannelEnableSet()

◆ MPTK_ChannelForcedPresetGet()

◆ MPTK_ChannelForcedPresetSet()

◆ MPTK_ChannelInfo()

◆ MPTK_ChannelNoteCount()

◆ MPTK_ChannelPresetChange()

◆ MPTK_ChannelPresetGetIndex()

◆ MPTK_ChannelPresetGetName()

◆ MPTK_ChannelVolumeGet()

◆ MPTK_ChannelVolumeSet()

◆ MPTK_ChorusSetDefault()

◆ MPTK_ClearAllSound()

◆ MPTK_InitSynth()

◆ MPTK_Load()

◆ MPTK_Next()

◆ MPTK_NoteLength()

◆ MPTK_Pause()

◆ MPTK_Play() [1/4]

◆ MPTK_Play() [2/4]

◆ MPTK_Play() [3/4]

◆ MPTK_Play() [4/4]

◆ MPTK_PlayNextOrPrevious()

◆ MPTK_Previous()

◆ MPTK_ReadMidiEvents()

◆ MPTK_RePlay()

◆ MPTK_ResetStat()

◆ MPTK_ReverbSetDefault()

◆ MPTK_SearchMidiToPlay()

◆ MPTK_SFChorusSetDefault()

◆ MPTK_SFFilterSetDefault()

◆ MPTK_SFReverbSetDefault()

◆ MPTK_StartSequencerMidi()

◆ MPTK_Stop() [1/2]

◆ MPTK_Stop() [2/2]

◆ MPTK_StopSynth()

◆ MPTK_SwitchMidiWithDelay()

◆ MPTK_UnPause()

◆ MPTK_WaitAllNotesOff()

◆ OnAudioFrameStartHandler()

Member Data Documentation

◆ MPTK_ApplyModLfo

◆ MPTK_ApplyRealTimeModulator

◆ MPTK_ApplySFChorus

◆ MPTK_ApplySFFilter

◆ MPTK_ApplySFReverb

◆ MPTK_ApplyVibLfo

◆ MPTK_AudioSettingFromUnity

◆ MPTK_AutoBuffer

◆ MPTK_AutoCleanVoiceLimit

◆ MPTK_CorePlayer

◆ MPTK_CutOffVolume

◆ MPTK_DirectSendToPlayer

◆ MPTK_EnableChangeTempo

◆ MPTK_EnableFreeSynthRate

◆ MPTK_EnablePanChange

◆ MPTK_EnablePresetDrum

◆ MPTK_KillByExclusiveClass

◆ MPTK_LeanSynthStarting

◆ MPTK_LogWave

◆ MPTK_PauseOnFocusLoss

◆ MPTK_ReleaseSameNote

◆ MPTK_ReleaseTimeMin

◆ MPTK_ReleaseTimeMod

◆ MPTK_ResetChannel

◆ MPTK_SFChorusAmplify

◆ MPTK_SFFilterFreqOffset