The key range (or note range if you will) of instruments is assigned to one or more keyboard regions. So each "region" is responsible for mapping audio samples and synthesis parameters for a certain key range. This function takes two keys on the keyboard (as MIDI note number) as arguments and checks the region relationship of the two keys, that is if the two keys have a region mapped each, and if yes how the relationship of those two regions exactly is. So the result value of this function depends on the precise regions layout of the currently loaded instrument.
|Argument Name||Data Type||Description|
||Integer Number||Note number of 1st key to be checked.
||Integer Number||Note number of 2nd key to be checked.
|Integer Number||Relationship of the two keys:
2is reserved for such a potential future feature.
Note that it is also indeed valid and useful sometimes to pass the same note number to both arguments of this function, which allows you to check whether one certain key is mapped to a region.
- on init
- declare const $NO_REGION := 5
- end on
- on note
- if (same_region($EVENT_NOTE, $EVENT_NOTE) = $NO_REGION)
- message("Key " & $EVENT_NOTE & " does not have any sample mapped. So you won't hear anything!")
- message("Key " & $EVENT_NOTE & " is mapped to a region, and thus you should hear its sample now.")
- end if
- end on
Since LinuxSampler 2.0.0.svn53.
Furthermore this function exists only with NKSP, it is not available with KSP.