Extends
Methods
getGainDecibel() → {number}
Get the gain in decibels.
Returns:
The gain value in decibels
- 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
getPan() → {number}
Get the pan position.
Returns:
The pan position (-1.0 for left, 0.0 for center, 1.0 for right)
- 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
isMuted() → {boolean}
Check if the track is muted.
Returns:
True if the track is muted, false otherwise
- Type
- boolean
isSolo() → {boolean}
Check if the track is soloed.
Returns:
True if the track is soloed, false otherwise
- Type
- boolean
setGainDecibel(gainDecibel)
Set the gain in decibels.
Parameters:
| Name | Type | Description |
|---|---|---|
gainDecibel |
number |
The gain value in decibels (between -24.0 and 24.0) |
setMuted(muted)
Set the mute state of the track.
Parameters:
| Name | Type | Description |
|---|---|---|
muted |
boolean |
True to mute the track, false to unmute |
setPan(pan)
Set the pan position.
Parameters:
| Name | Type | Description |
|---|---|---|
pan |
number |
The pan position (-1.0 for left, 0.0 for center, 1.0 for right) |
setSolo(solo)
Set the solo state of the track.
Parameters:
| Name | Type | Description |
|---|---|---|
solo |
boolean |
True to solo the track, false to unsolo |