ScriptingApi::Sampler Class Reference

All scripting functions for sampler specific functionality. More...

Inherits ConstScriptingObject.

Public Member Functions
void	enableRoundRobin (bool shouldUseRoundRobin)
	Enables / Disables the automatic round robin group start logic (works only on samplers). More...
var	getAttribute (int index) const
	Gets the attribute with the given index (use the constants for clearer code). More...
String	getCurrentSampleMapId () const
	Returns the currently loaded sample map. More...
String	getMicPositionName (int channelIndex)
	Returns the name of the channel with the given index (Multimic samples only. More...
int	getNumMicPositions () const
	Returns the number of mic positions. More...
int	getNumSelectedSounds ()
	Returns the amount of selected samples. More...
int	getRRGroupsForMessage (int noteNumber, int velocity)
	Returns the amount of actual RR groups for the notenumber and velocity.
var	getSampleMapList () const
	Returns an array with all available sample maps. More...
var	getSoundProperty (int propertyIndex, int soundIndex)
	Returns the property of the sound with the specified index. More...
bool	isMicPositionPurged (int micIndex)
	Checks if the mic position is purged. More...
bool	isNoteNumberMapped (int noteNumber)
	Checks whether the note number is mapped to any samples. More...
void	loadSampleMap (const String &fileName)
	Loads a new samplemap into this sampler. More...
void	purgeMicPosition (String micName, bool shouldBePurged)
	Purges all samples of the given mic (Multimic samples only). More...
void	refreshInterface ()
	Refreshes the interface. More...
void	refreshRRMap ()
	Recalculates the RR Map. More...
void	selectSounds (String regex)
	Selects samples using the regex string as wildcard and the selectMode ("SELECT", "ADD", "SUBTRACT")
void	setActiveGroup (int activeGroupIndex)
	Enables the group with the given index (one-based). More...
void	setAttribute (int index, var newValue)
	Sets a attribute to the given value. More...
void	setSoundProperty (int soundIndex, int propertyIndex, var newValue)
	Sets the property for the index within the selection. More...
void	setSoundPropertyForAllSamples (int propertyIndex, var newValue)
	Sets the property for all samples of the sampler. More...
void	setSoundPropertyForSelection (int propertyIndex, var newValue)
	Sets the property of the sampler sound for the selection. More...
void	setUseStaticMatrix (bool shouldUseStaticMatrix)
	Disables dynamic resizing when a sample map is loaded. More...

Detailed Description

All scripting functions for sampler specific functionality.

Member Function Documentation

void enableRoundRobin

(

bool

shouldUseRoundRobin

)

Enables / Disables the automatic round robin group start logic (works only on samplers).

var getAttribute

(

int

index

)

const

Gets the attribute with the given index (use the constants for clearer code).

String getCurrentSampleMapId

(

)

const

Returns the currently loaded sample map.

String getMicPositionName

(

int

channelIndex

)

Returns the name of the channel with the given index (Multimic samples only.

int getNumMicPositions

(

)

const

Returns the number of mic positions.

int getNumSelectedSounds

(

)

Returns the amount of selected samples.

var getSampleMapList

(

)

const

Returns an array with all available sample maps.

var getSoundProperty	(	int	propertyIndex,
		int	soundIndex
	)

Returns the property of the sound with the specified index.

bool isMicPositionPurged

(

int

micIndex

)

Checks if the mic position is purged.

bool isNoteNumberMapped

(

int

noteNumber

)

Checks whether the note number is mapped to any samples.

void loadSampleMap

(

const String &

fileName

)

Loads a new samplemap into this sampler.

void purgeMicPosition	(	String	micName,
		bool	shouldBePurged
	)

Purges all samples of the given mic (Multimic samples only).

void refreshInterface

(

)

Refreshes the interface.

Call this after you changed the properties.

void refreshRRMap

(

)

Recalculates the RR Map.

Call this at compile time if you want to use 'getRRGroupForMessage()'.

void setActiveGroup

(

int

activeGroupIndex

)

Enables the group with the given index (one-based).

Works only with samplers and enableRoundRobin(false).

void setAttribute	(	int	index,
		var	newValue
	)

Sets a attribute to the given value.

void setSoundProperty	(	int	soundIndex,
		int	propertyIndex,
		var	newValue
	)

Sets the property for the index within the selection.

void setSoundPropertyForAllSamples	(	int	propertyIndex,
		var	newValue
	)

Sets the property for all samples of the sampler.

void setSoundPropertyForSelection	(	int	propertyIndex,
		var	newValue
	)

Sets the property of the sampler sound for the selection.

void setUseStaticMatrix

(

bool

shouldUseStaticMatrix

)

Disables dynamic resizing when a sample map is loaded.