Oscillator Class Reference

The Synthesis primitive. More...

Inheritance diagram for Oscillator:

Public Member Functions
Value	getParameter (string parameter)
	Gets an Element parameter. More...
table	getParameterConnections (string parameter)
	Get all SignalConnection for this parameter. More...
table	getSliceInfo (int sliceId)
	get slice information for the given sliceId. More...
bool	hasParameter (string parameter)
void	setParameter (string parameter, Value value)
	Sets an Element parameter. More...

Public Attributes
table	children
	element children using the element name as key
string	displayName
	name to display on the User Interface, name is used if displayName is not specified.
Keygroup	keygroup
	parent keygroup for this oscillator
table	looplabInfo
	looplab information. More...
string	name
	internal element name
int	numParams
	number of parameters
int	numSlices
	number of slices (only valid for Slice oscillator)
table	parameterDefinitions
	table of parameter definitions. More...
Element &	parent
	element parent
bool	purged
	purged status for this oscillator (when true sample is not loaded in memory)
table	sampleInfo
	sample information. More...
string	type
	internal element type

Detailed Description

The Synthesis primitive.

Member Function Documentation

table Oscillator::getSliceInfo

(

int

sliceId)

get slice information for the given sliceId.

Returns

returns the following table:

property	type	unit
start	number	ms
duration	number	ms
beatPos	number	beats
beatDuration	number	beats

void Element::setParameter ( string  parameter, Value  value  )

inherited

Sets an Element parameter.

Parameters

parameter	parameterName or parameterId
value	parameterValue (number|bool|string) according to definition

See Also

Elements & parameters

Value Element::getParameter ( string  parameter)

inherited

Gets an Element parameter.

Parameters

parameter

parameterName or parameterId

Returns

parameterValue (number|bool|string) according to definition

See Also

Elements & parameters

bool Element::hasParameter ( string  parameter)

inherited

Parameters

parameter

parameterName or parameterId

Returns

true or false

See Also

Elements & parameters

table Element::getParameterConnections ( string  parameter)

inherited

Get all SignalConnection for this parameter.

Parameters

parameter

parameterName or parameterId

Returns

table of parameter connections

See Also

Elements & parameters

Member Data Documentation

table Oscillator::looplabInfo

looplab information.

Only valid for Slice oscillator, returns the following table:

property	type
numerator	number
denominator	number
bars	number
beats	number
synced	boolean
numSlices	number

table Oscillator::sampleInfo

sample information.

Only valid for sample based oscillators, returns the following table:

property	type	unit	optional
name	string		no
channels	number		no
duration	number	ms	no
samplerate	number	Hz	no
bits	number		no
tempo	number	bpm	no
start	number	ms	no
end	number	ms	no
looped	boolean		no
loopStart	number	ms	yes
loopEnd	number	ms	yes

table Element::parameterDefinitions

inherited

table of parameter definitions.

returns the following table:

property	type	optional
id	number	no
type	"int","float","bool","string"	no
default	type	no
displayName	string	no
description	string	no
readOnly	number	no
serialize	boolean	no
min	type	yes
max	type	yes