Skip to main content

Group

The Group class represents a group in a Kontakt instrument and provides access to its zones.

class Group
info

This class cannot be instantiated directly. Instances are returned by Instrument.groups, Instrument.group, and Zone.group.

Properties​

name​

name: String { get }

The name of the group.

zones​

zones: ZoneList { get }

All zones in the group as a ZoneList.

info

Zones created after the script was loaded (e.g. in the Kontakt editor or by KSP) are not included. Reload the instrument to make them available. Zones created by the script via add_zone are included immediately.

Methods​

add_zone​

add_zone(_ sample: Sample) -> (Zone)

Creates a new zone in this group from the given kontakt.Sample and returns it. Zones created this way are destroyable via Zone.destroy.

to_string​

to_string() -> (String)

Returns a string representation of the group.