Zone Parameters
Zone Parameters
These set the parameters for the user zones via KSP in the same manner and ranges as available on the mapping editor. They can be set with the set_zone_par(<zone-id>,<parameter>,<value>)
function and retrieved with the get_zone_par(<zone-id>,<parameter>)
function. When the zones are declared, all these parameters are set to 0 by default.
|
---|
Sets the high key for the zone. Range: 0 to 127 |
|
---|
Sets the low key of the zone. Range: 0 to 127 |
|
---|
Sets the maximum velocity response of the zone. Range: 1 to 127 |
|
---|
Sets the minimum velocity response of the zone. Range: 1 to 127 |
|
---|
Sets the root key of the zone. Range: 0 to 127 |
|
---|
Optionally use this parameter to create zone crossfades. The value is set in the form of a distance to the Range: |
|
---|
Optionally use this parameter to create zone crossfades. The value is set in the form of a distance to the Range: |
|
---|
Optionally use this parameter to create zone crossfades. The value is set in the form of a distance to the $ Range: |
|
---|
Optionally use this parameter to create zone crossfades. The value is set in the form of a distance to the Range: |
|
---|
Sets the volume of the zone. Range: -3600 to 3600 |
|
---|
Sets the panning of the zone. Range: -1000 to 1000 |
|
---|
Sets the tuning of the zone. Range: -3600 to 3600 |
|
---|
Sets the group of the user zone. By default a user zone is placed in group 0. |
Examples
set_num_user_zones(4) set_zone_par(%NI_USER_ZONE_IDS[0], $ZONE_PAR_GROUP, 30) set_zone_par(%NI_USER_ZONE_IDS[1], $ZONE_PAR_GROUP, 31) set_zone_par(%NI_USER_ZONE_IDS[2], $ZONE_PAR_GROUP, 72) set_zone_par(%NI_USER_ZONE_IDS[3], $ZONE_PAR_GROUP, 73)
|
---|
Sets the sample start value of the sample attached to the zone. |
|
---|
Sets the sample end value of the sample attached to the zone. |
|
---|
User zone loop parameters work in the same manner as manually setting loops via the wave editor. |
Loop Parameters
|
---|
The Loop Mode of the selected loop within the zone. Range: 0 to 4 0: Loop off 1: Loop until end, alternate off 2: Loop until end, alternate on 3: Loop until release, alternate off 4: Loop until release, alternate on |
Examples
on ui_control($SampleLoopOn) wait_async(set_loop_par(%NI_USER_ZONE_IDS[2], 0, ... $LOOP_PAR_MODE, $SampleLoopOn)) end on
|
---|
The starting point in samples of the selected loop within the zone. If this parameter is not the loop will start at the beginning of the sample. |
|
---|
The loop length in samples of the selected loop within the zone. If this parameter is not set the loop length will correspond to the entire sample. |
|
---|
The crossfade value in microseconds for the selected loop within the zone. |
|
---|
The number of times the selected loop within the zone will repeat. If this parameter is not set (or is set to 0), the loop will continue indefinitely. |
|
---|
Sets the tuning offset inside the loop area for the selected loop within the zone, applied on the first repeat of the loop, and for all successive repeats (as defined by |
Sample Parameters
|
---|
The file name of a zone’s sample (corresponds to the zone name) |
|
---|
The full path of a zone’s sample (same result as without the parameter) |
|
---|
The full OS path of a zone’s sample (uses backslashes on Windows) |
|
---|
The file extension of a zone’s sample (without the dot) |