Extends
Methods
deleteTake(takeId)
Delete a retake by its ID.
Note: The default retake (ID 0) cannot be deleted.
Parameters:
| Name | Type | Description |
|---|---|---|
takeId |
number |
the ID of the retake to delete |
generateTake(newDuration, newPitch, newTimbre) → {number}
Generate a new retake with the specified variation parameters.
Returns the ID of the newly generated retake.
Parameters:
| Name | Type | Description |
|---|---|---|
newDuration |
boolean |
whether to generate new duration variation |
newPitch |
boolean |
whether to generate new pitch variation |
newTimbre |
boolean |
whether to generate new timbre variation |
Returns:
the ID of the newly generated retake
- Type
- number
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
getNumTakes() → {number}
Get the number of retakes in this list.
Returns:
number of retakes
- 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
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
setActiveTake(takeId)
Set the active retake by its ID.
The active retake determines which variation is used for rendering.
Parameters:
| Name | Type | Description |
|---|---|---|
takeId |
number |
the ID of the retake to set as active |