| Available in: | Interface Scripts | Client Entity Scripts |
|---|
The AudioScope API helps control the Audio Scope features in Interface
Methods
Signals
Properties:
| Name | Type | Description |
|---|---|---|
scopeInput |
number | Read-only. |
scopeOutputLeft |
number | Read-only. |
scopeOutputRight |
number | Read-only. |
triggerInput |
number | Read-only. |
triggerOutputLeft |
number | Read-only. |
triggerOutputRight |
number | Read-only. |
Methods
getAutoTrigger() → {boolean}
Returns:
- Type: boolean
getFramesPerScope() → {number}
Returns:
- Type: number
getFramesPerSecond() → {number}
Returns:
- Type: number
getPause() → {boolean}
Returns:
- Type: boolean
getScopeInput() → {Array.<number>}
Returns:
- Type: Array.<number>
getScopeOutputLeft() → {Array.<number>}
Returns:
- Type: Array.<number>
getScopeOutputRight() → {Array.<number>}
Returns:
- Type: Array.<number>
getTriggered() → {boolean}
Returns:
- Type: boolean
getTriggerInput() → {Array.<number>}
Returns:
- Type: Array.<number>
getTriggerOutputLeft() → {Array.<number>}
Returns:
- Type: Array.<number>
getTriggerOutputRight() → {Array.<number>}
Returns:
- Type: Array.<number>
getVisible() → {boolean}
Returns:
- Type: boolean
selectAudioScopeFiftyFrames()
selectAudioScopeFiveFrames()
selectAudioScopeTwentyFrames()
setAutoTrigger(autoTrigger)
Parameters:
| Name | Type | Description |
|---|---|---|
autoTrigger |
boolean |
setLocalEcho()
setPause(paused)
Parameters:
| Name | Type | Description |
|---|---|---|
paused |
boolean |
setServerEcho()
setTriggered(triggered)
Parameters:
| Name | Type | Description |
|---|---|---|
triggered |
boolean |
setTriggerValues(x, y)
Parameters:
| Name | Type | Description |
|---|---|---|
x |
number | |
y |
number |
setVisible(visible)
Parameters:
| Name | Type | Description |
|---|---|---|
visible |
boolean |
toggle()
togglePause()
toggleTrigger()
Signals
pauseChanged() → {Signal}
Returns:
- Type: Signal
triggered() → {Signal}
Returns:
- Type: Signal
