AudioHelm.Keyzone Class Reference

A single keyzone in a Sampler. A keyzone has a single AudioClip that it should play if a key between minKey and maxKey and the velocity is played between minVelocity and maxVelocity. When played, the pitch of the AudioClip is shifted by (theKeyPlayed - rootKey) semitones. More...

Public Member Functions
bool	ValidForNote (int note)
	Checks if the keyzone will play for the current note. More...
bool	ValidForNote (int note, float velocity)
	Checks if the keyzone will play for the current note and velocity. More...

Public Attributes
AudioClip	audioClip
	The audio clip to play for this keyzone. More...
AudioMixerGroup	mixer
	The mixer to send the audio clip to when played. More...
int	rootKey = Utils.kMiddleC
	The MIDI key to pitch shift this note from. If a higher note is played, the sample is pitched up. If a lower note is played, the sample is pitched down. More...
int	minKey = 0
	The minimum MIDI key this Keyzone is valid for. More...
int	maxKey = Utils.kMidiSize - 1
	The maximum MIDI key this Keyzone is valid for. More...
float	minVelocity = 0.0f
	The minimum velocity this Keyzone is valid for. [0.0, 1.0f] More...
float	maxVelocity = 1.0f
	The maximum velocity this Keyzone is valid for. [0.0, 1.0f] More...

Detailed Description

A single keyzone in a Sampler. A keyzone has a single AudioClip that it should play if a key between minKey and maxKey and the velocity is played between minVelocity and maxVelocity. When played, the pitch of the AudioClip is shifted by (theKeyPlayed - rootKey) semitones.

Member Function Documentation

ValidForNote() [1/2]

bool AudioHelm.Keyzone.ValidForNote

(

int

note

)

Checks if the keyzone will play for the current note.

Returns

true, if for note is within the kezone, false otherwise.

Parameters

note	The note to check.

ValidForNote() [2/2]

bool AudioHelm.Keyzone.ValidForNote	(	int	note,
		float	velocity
	)

Checks if the keyzone will play for the current note and velocity.

Returns

true, if for note and velocity are within the kezone, false otherwise.

Parameters

note	The note to check.
velocity	The velocity to check.

Member Data Documentation

audioClip

AudioClip AudioHelm.Keyzone.audioClip

The audio clip to play for this keyzone.

maxKey

int AudioHelm.Keyzone.maxKey = Utils.kMidiSize - 1

The maximum MIDI key this Keyzone is valid for.

maxVelocity

float AudioHelm.Keyzone.maxVelocity = 1.0f

The maximum velocity this Keyzone is valid for. [0.0, 1.0f]

minKey

int AudioHelm.Keyzone.minKey = 0

The minimum MIDI key this Keyzone is valid for.

minVelocity

float AudioHelm.Keyzone.minVelocity = 0.0f

The minimum velocity this Keyzone is valid for. [0.0, 1.0f]

mixer

AudioMixerGroup AudioHelm.Keyzone.mixer

The mixer to send the audio clip to when played.

rootKey

int AudioHelm.Keyzone.rootKey = Utils.kMiddleC

The MIDI key to pitch shift this note from. If a higher note is played, the sample is pitched up. If a lower note is played, the sample is pitched down.

---

The documentation for this class was generated from the following file:

• AudioHelm/Scripts/Keyzone.cs