Configurations

Initialization parameters for the Matchmaker class:

Parameter	Type	Default	Description
score_file	str		Path to the score file (.musicxml, .mid, etc.)
performance_file	str or None	None	Path to a recorded performance file for simulation mode. If None, live device input is used.
input_type	str	"audio"	Input modality. Options: "audio", "midi".
method	str or None	None	Alignment method. Defaults to "arzt" for audio, "pthmm" for MIDI. See Alignment Methods.
processor	str or None	None	Feature processor. Defaults to "chroma" for audio, "pitch_chord" for MIDI. See Features.
kwargs	dict or None	None	Method-specific parameters (e.g., window_size, sample_rate, frame_rate). If None, built-in defaults for the chosen method are used.
stream	Stream or None	None	Custom Stream instance for external input sources (e.g., WebSocket). If None, the stream is built automatically from input_type.
device_name_or_index	str or int or None	None	Audio/MIDI device name or index for live input. Requires pymatchmaker[devices].
tempo	float or None	None	Initial tempo in BPM for score rendering. If None, inferred from the score.
wait	bool	False	If True, block until the score follower finishes before returning from run().
unfold_score	bool	True	If True, unfold repeat signs in the score before alignment.

Contributing

If you want to add a new score follower, please refer to HOW_TO_CONTRIBUTE.md for the OnlineAlignment interface, boilerplate, and audio/MIDI tips. The same guide is also available in the online docs.