Singleton class to manage all global MPTK features. More information here: https://paxstellar.fr/midiplayerglobal/ More...

Inherits MonoBehaviour, and MonoBehaviour.

Static Public Member Functions
static float	MPTK_DistanceToListener (Transform trf)

static int	MPTK_FindMidi (string name)

static string	MPTK_GetPatchName (int bank, int patch)

static bool	MPTK_IsReady (float delay=0.5f)

static bool	MPTK_LoadLiveSF (string pPathSF=null, int defaultBank=-1, int drumBank=-1, bool restartPlayer=true, bool useCache=true, bool log=false)

static void	MPTK_Quit ()

static bool	MPTK_SelectBankDrum (int nbank)

static bool	MPTK_SelectBankInstrument (int nbank)

static void	MPTK_SelectSoundFont (string name, bool restartPlayer=true)

static void	MPTK_Stop ()

Public Attributes
string	MPTK_LiveSoundFont

Static Public Attributes
static int	MPTK_CountWaveLoaded

static List< MPTKListItem >	MPTK_ListBank

static List< MPTKListItem >	MPTK_ListMidi

static List< MPTKListItem >	MPTK_ListPreset

static List< MPTKListItem >	MPTK_ListPresetDrum

static bool	MPTK_SoundFontLoaded = false

static string	MPTK_SoundFontName
	Current Soundfont name More...

static LoadingStatusSoundFontEnum	MPTK_StatusLastSoundFontLoaded

Properties
static int	MPTK_CountPresetLoaded `[get]`

static List< string >	MPTK_ListSoundFont `[get]`

static bool	MPTK_LoadSoundFontAtStartup `[get, set]`

static string	MPTK_PathSoundFontCache `[get]`

static string	MPTK_PathToResources `[get]`

static bool	MPTK_SoundFontIsReady `[get]`
	Loading status for SoundFont from local resources folder. For runtime loading status use MPTK_SoundFontLoaded. More...

static TimeSpan	MPTK_TimeToDownloadSoundFont `[get]`

static TimeSpan	MPTK_TimeToLoadSoundFont `[get]`

static TimeSpan	MPTK_TimeToLoadWave `[get]`

static UnityEvent	OnEventPresetLoaded `[get, set]`

static bool	VerboseGlobal `[get, set]`

Detailed Description

Singleton class to manage all global MPTK features. More information here: https://paxstellar.fr/midiplayerglobal/

Member Function Documentation

◆ MPTK_DistanceToListener()

static float MidiPlayerTK.MidiPlayerGlobal.MPTK_DistanceToListener ( Transform trf )

static

Calculate distance with the AudioListener.

Parameters

trf	Transform of the object to calculate the distance.

Returns

◆ MPTK_FindMidi()

static int MidiPlayerTK.MidiPlayerGlobal.MPTK_FindMidi ( string name )

static

Find index of a Midi by name. Use the exact name defined in Unity resources folder MidiDB without any path or extension.
Tips: Add Midi files to your project with the Unity menu MPTK or add it directly in the resource folder and open Midi File Setup to automatically integrate Midi in MPTK.

Parameters

name	name of the midi without path nor extension

Returns: -1 if not found else return the index of the midi.

◆ MPTK_GetPatchName()

static string MidiPlayerTK.MidiPlayerGlobal.MPTK_GetPatchName	(	int	bank,
		int	patch
	)

static

Return the name of the preset (patch) from a bank and patch number.

Parameters

bank
patch

Returns: Name of the preset or empty if not found.

◆ MPTK_IsReady()

static bool MidiPlayerTK.MidiPlayerGlobal.MPTK_IsReady ( float delay = 0.5f )

static

Warning: MPTK_IsReady has been deprecated, please investigate MPTK_Pulse in place <midiSynth>.MPTK_SoundFont.IsReady
// Check that SoundFont is loaded for the midistream synth.

if (!midiStreamPlayer.MPTK_SoundFont.IsReady)

return;

Parameters

delay

Returns

◆ MPTK_LoadLiveSF()

static bool MidiPlayerTK.MidiPlayerGlobal.MPTK_LoadLiveSF	(	string	pPathSF = `null`,
		int	defaultBank = `-1`,
		int	drumBank = `-1`,
		bool	restartPlayer = `true`,
		bool	useCache = `true`,
		bool	log = `false`
	)

static

Warning: MPTK_LoadLiveSF has been deprecated; use <midiSynth>.MPTK_SoundFont.IsReady instead. Loads a SoundFont on the fly while the application is running.
The SoundFont is loaded from a local file, from the web, or from a cache.
If some MIDIs are playing, they are restarted.
Loading is done in the background (coroutine), so the method returns immediately.

Version: Maestro Pro - updated 2.11.2

Note

Look also:

Parameters

pPathSF	Full path to the SoundFont file. Must start with `file://` for local desktop loading, or `http://` / `https://` for a web resource. If null, the path defined in MPTK_LiveSoundFont is used.
defaultBank	Default bank to use for instruments; use -1 to select the first bank.
drumBank	Bank to use for the drum kit; use -1 to select the last bank.
restartPlayer	Restart the MIDI player if needed. Default is true.
useCache	Reuse an already downloaded SoundFont if it exists. Default is true.
log	Display logs. Default is false.

Returns

true if loading is in progress; use OnEventPresetLoaded to get information when loading is complete (for example, MPTK_StatusLastSoundFontLoaded)
false if an error is detected in the parameters. The OnEventPresetLoaded callback is not called if false is returned.

◆ MPTK_Quit()

static void MidiPlayerTK.MidiPlayerGlobal.MPTK_Quit ( )

static

Stops all MIDI synthesizers and exits the application.

◆ MPTK_SelectBankDrum()

static bool MidiPlayerTK.MidiPlayerGlobal.MPTK_SelectBankDrum ( int nbank )

static

The default instrument and drum banks are defined with the popup "SoundFont Setup Alt-F" in the Unity editor.
This method change the default instrument drum bank and the presets list associated. See MPTK_ListPresetDrum.
Note 1: this call doesn't change the current MIDI bank used to play a drum, only the content of MPTK_ListPresetDrum.
Note 2: to apply the bank to all channels, the synth must be restarted: call MidiFilePlayer.MPTK_InitSynth.
Note 3: to change the current bank, rather use MidiFilePlayer.MPTK_ChannelPresetChange

Parameters

nbank Number of the SoundFont Bank to load for drum.

Returns: true if bank has been found else false.

◆ MPTK_SelectBankInstrument()

static bool MidiPlayerTK.MidiPlayerGlobal.MPTK_SelectBankInstrument ( int nbank )

static

The default instrument and drum banks are defined with the popup "SoundFont Setup Alt-F" in the Unity editor.
This method change the default instrument drum bank and build the presets list associated. See MPTK_ListPreset.
Note 1: this call doesn't change the current MIDI bank used to play an instrument, only the content of MPTK_ListPreset.
Note 2: to apply the bank to all channels, the synth must be restarted: call MidiFilePlayer.MPTK_InitSynth.
Note 3: to change the current bank, rather use MidiFilePlayer.MPTK_ChannelPresetChange

Parameters

nbank Number of the SoundFont Bank to load for instrument.

Returns: true if bank has been found else false.

◆ MPTK_SelectSoundFont()

static void MidiPlayerTK.MidiPlayerGlobal.MPTK_SelectSoundFont	(	string	name,
		bool	restartPlayer = `true`
	)

static

Changes the current SoundFont on the fly. If MidiFilePlayers are running, they are stopped and optionally restarted.

Version: Maestro Pro

Parameters

name	SoundFont name
restartPlayer	If a MIDI is playing, restart the currently playing MIDI.

◆ MPTK_Stop()

static void MidiPlayerTK.MidiPlayerGlobal.MPTK_Stop ( )

static

Search for each MidiFilePlayer and stop playing and stop the MIDI synth.

Member Data Documentation

◆ MPTK_CountWaveLoaded

int MidiPlayerTK.MidiPlayerGlobal.MPTK_CountWaveLoaded

static

Number of samples loaded

◆ MPTK_ListBank

List<MPTKListItem> MidiPlayerTK.MidiPlayerGlobal.MPTK_ListBank

static

Gets the list of banks available.
The default bank can be changed with MPTK_SelectBankInstrument or MPTK_SelectBankDrum or with the menu "MPTK / SoundFont" or Alt-F in the Unity editor.

◆ MPTK_ListMidi

List<MPTKListItem> MidiPlayerTK.MidiPlayerGlobal.MPTK_ListMidi

static

List of MIDI files available. Add or remove MIDI from the Unity editor menu "MPTK / Midi File Setup" or Alt-M

◆ MPTK_ListPreset

List<MPTKListItem> MidiPlayerTK.MidiPlayerGlobal.MPTK_ListPreset

static

List of presets (instrument) for the default or selected bank.
The default bank can be changed with MPTK_SelectBankInstrument or with the popup "SoundFont Setup Alt-F" in the Unity editor.

◆ MPTK_ListPresetDrum

List<MPTKListItem> MidiPlayerTK.MidiPlayerGlobal.MPTK_ListPresetDrum

static

List of drum set for the default or selected bank.
The default bank can be changed with MPTK_SelectBankDrum or with the menu "MPTK / SoundFont" or Alt-F in the Unity editor.

◆ MPTK_LiveSoundFont

string MidiPlayerTK.MidiPlayerGlobal.MPTK_LiveSoundFont

Warning: MPTK_LiveSoundFont has been deprecated; use <midiSynth>.MPTK_SoundFont.IsReady instead. Gets or sets the full path to a SoundFont file (.sf2) or a URL to load. Defined in the MidiPlayerGlobal editor inspector. Must start with file:// or http:// or https://.

Version: Maestro Pro

◆ MPTK_SoundFontLoaded

bool MidiPlayerTK.MidiPlayerGlobal.MPTK_SoundFontLoaded = false

static

Loading status for SoundFont from external file or URL. For status from local resources folder use MPTK_SoundFontIsReady.

False at start.
True when a SF downloaded or loaded from the cache is ready.

◆ MPTK_SoundFontName

string MidiPlayerTK.MidiPlayerGlobal.MPTK_SoundFontName

static

Current Soundfont name

Version: 2.15.0

◆ MPTK_StatusLastSoundFontLoaded

LoadingStatusSoundFontEnum MidiPlayerTK.MidiPlayerGlobal.MPTK_StatusLastSoundFontLoaded

static

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

Version: 2.11.2

Property Documentation

◆ MPTK_CountPresetLoaded

int MidiPlayerTK.MidiPlayerGlobal.MPTK_CountPresetLoaded

staticget

Count of preset loaded

◆ MPTK_ListSoundFont

List<string> MidiPlayerTK.MidiPlayerGlobal.MPTK_ListSoundFont

staticget

List of Soundfont(s) available. With the MPTK PRO, add or remove SoundFonts from the Unity editor menu "MPTK / SoundFont Setup" or Alt-F

◆ MPTK_LoadSoundFontAtStartup

bool MidiPlayerTK.MidiPlayerGlobal.MPTK_LoadSoundFontAtStartup

staticgetset

If true load soundfont at startup

◆ MPTK_PathSoundFontCache

string MidiPlayerTK.MidiPlayerGlobal.MPTK_PathSoundFontCache

staticget

Folder where Soundfont downloaded are saved (cache).

Version: 2.11.2 Pro

◆ MPTK_PathToResources

string MidiPlayerTK.MidiPlayerGlobal.MPTK_PathToResources

staticget

This path could change depending your project. Change the path before any actions in MPTK.

◆ MPTK_SoundFontIsReady

bool MidiPlayerTK.MidiPlayerGlobal.MPTK_SoundFontIsReady

staticget

Loading status for SoundFont from local resources folder. For runtime loading status use MPTK_SoundFontLoaded.

◆ MPTK_TimeToDownloadSoundFont

TimeSpan MidiPlayerTK.MidiPlayerGlobal.MPTK_TimeToDownloadSoundFont

staticget

Downloading or reading time for the current SoundFont

◆ MPTK_TimeToLoadSoundFont

TimeSpan MidiPlayerTK.MidiPlayerGlobal.MPTK_TimeToLoadSoundFont

staticget

Loading time for the current SoundFont

◆ MPTK_TimeToLoadWave

TimeSpan MidiPlayerTK.MidiPlayerGlobal.MPTK_TimeToLoadWave

staticget

Loading time for the samples

◆ OnEventPresetLoaded

UnityEvent MidiPlayerTK.MidiPlayerGlobal.OnEventPresetLoaded

staticgetset

Event triggered at the end of the loading of the soundfont.
Setting this callback function by script (AddListener) is not recommended. It's better to set callback function from the inspector. See here:https://mptkapi.paxstellar.com/d7/dc4/class_midi_player_t_k_1_1_midi_player_global.html::a64995b20027b35286c143f9f25a1cb6d

◆ VerboseGlobal

bool MidiPlayerTK.MidiPlayerGlobal.VerboseGlobal

staticgetset

If true load all waves when application is started else load when need when playing (default) Useless?

Static Public Member Functions

Public Attributes

Static Public Attributes

Properties

Detailed Description

Member Function Documentation

◆ MPTK_DistanceToListener()

◆ MPTK_FindMidi()

◆ MPTK_GetPatchName()

◆ MPTK_IsReady()

◆ MPTK_LoadLiveSF()

◆ MPTK_Quit()

◆ MPTK_SelectBankDrum()

◆ MPTK_SelectBankInstrument()

◆ MPTK_SelectSoundFont()

◆ MPTK_Stop()

Member Data Documentation

◆ MPTK_CountWaveLoaded

◆ MPTK_ListBank

◆ MPTK_ListMidi

◆ MPTK_ListPreset

◆ MPTK_ListPresetDrum

◆ MPTK_LiveSoundFont

◆ MPTK_SoundFontLoaded

◆ MPTK_SoundFontName

◆ MPTK_StatusLastSoundFontLoaded

Property Documentation

◆ MPTK_CountPresetLoaded

◆ MPTK_ListSoundFont

◆ MPTK_LoadSoundFontAtStartup

◆ MPTK_PathSoundFontCache

◆ MPTK_PathToResources

◆ MPTK_SoundFontIsReady

◆ MPTK_TimeToDownloadSoundFont

◆ MPTK_TimeToLoadSoundFont

◆ MPTK_TimeToLoadWave

◆ OnEventPresetLoaded

◆ VerboseGlobal