PitchControlPoint

PitchControlPoint

A discrete anchor point that guides the pitch generation at a specific time and pitch position within a NoteGroup.

(supported since 2.1.0)

Extends

Methods

clone() → {PitchControlPoint}

A deep copy of the current object.

Returns:
Type
PitchControlPoint

getIndexInParent() → {number}

Inherited From:

Get index of the current object in its parent. In Lua, this index starts from 1. In JavaScript, this index starts from 0.

Returns:
Type
number

getParent() → {NestedObject|undefined}

Inherited From:

Get the parent NestedObject. Return undefined if the current object is not attached to a parent.

Returns:
Type
NestedObject | undefined

getPitch() → {number}

Get the pitch value of this pitch control point in semitones relative to the pitch offset of the note group.

Returns:

pitch in semitones

Type
number

getPosition() → {number}

Get the position of this pitch control point relative to the time offset of the note group (in blicks).

Returns:

position in blicks

Type
number

isMemoryManaged() → {boolean}

Inherited From:

Check whether or not the current object is memory managed (i.e. garbage collected by the script environment).

Returns:
Type
boolean

setPitch(pitch)

Set the pitch value of this pitch control point.

Parameters:
Name Type Description
pitch number

pitch in semitones

setPosition(position)

Set the time position of this pitch control point.

Parameters:
Name Type Description
position number

position in blicks