AudioScope

Description

The AudioScope API helps control the Audio Scope features in Interface

Supported Script Types: Interface Scripts • Client Entity Scripts • Avatar Scripts

Properties

Name Type Summary
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

Name Return Value Summary
getAutoTrigger boolean
getFramesPerScope number
getFramesPerSecond number
getPause boolean
getScopeInput Array.<number>
getScopeOutputLeft Array.<number>
getScopeOutputRight Array.<number>
getTriggered boolean
getTriggerInput Array.<number>
getTriggerOutputLeft Array.<number>
getTriggerOutputRight Array.<number>
getVisible boolean
selectAudioScopeFiftyFrames None
selectAudioScopeFiveFrames None
selectAudioScopeTwentyFrames None
setAutoTrigger None
setLocalEcho None
setPause None
setServerEcho None
setTriggered None
setTriggerValues None
setVisible None
toggle None
togglePause None
toggleTrigger None

Signals

Name Summary
pauseChanged
triggered

Method Details

(static) getAutoTrigger( ) → {boolean}
Returns: boolean

(static) getFramesPerScope( ) → {number}
Returns: number

(static) getFramesPerSecond( ) → {number}
Returns: number

(static) getPause( ) → {boolean}
Returns: boolean

(static) getScopeInput( ) → {Array.<number>}
Returns: Array.<number>

(static) getScopeOutputLeft( ) → {Array.<number>}
Returns: Array.<number>

(static) getScopeOutputRight( ) → {Array.<number>}
Returns: Array.<number>

(static) getTriggered( ) → {boolean}
Returns: boolean

(static) getTriggerInput( ) → {Array.<number>}
Returns: Array.<number>

(static) getTriggerOutputLeft( ) → {Array.<number>}
Returns: Array.<number>

(static) getTriggerOutputRight( ) → {Array.<number>}
Returns: Array.<number>

(static) getVisible( ) → {boolean}
Returns: boolean

(static) selectAudioScopeFiftyFrames( )

(static) selectAudioScopeFiveFrames( )

(static) selectAudioScopeTwentyFrames( )

(static) setAutoTrigger( autoTrigger )

Parameters

Name Type Description
autoTrigger boolean
(static) setLocalEcho( )

(static) setPause( paused )

Parameters

Name Type Description
paused boolean
(static) setServerEcho( )

(static) setTriggered( triggered )

Parameters

Name Type Description
triggered boolean
(static) setTriggerValues( x, y )

Parameters

Name Type Description
x number
y number
(static) setVisible( visible )

Parameters

Name Type Description
visible boolean
(static) toggle( )

(static) togglePause( )

(static) toggleTrigger( )

Signal Details

pauseChanged( )
Returns: Signal

triggered( )
Returns: Signal