AvatarInputs

Description

API to help manage your Avatar's input

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

Properties

Name Type Summary
cameraEnabled boolean Read-only.
cameraMuted boolean Read-only.
isHMD boolean Read-only.
showAudioTools boolean

Methods

Name Return Value Summary
loudnessToAudioLevel number
resetSensors None
setShowAudioTools None
toggleCameraMute None

Signals

Name Summary
avatarEnteredIgnoreRadius
avatarLeftIgnoreRadius
cameraEnabledChanged
cameraMutedChanged
enteredIgnoreRadiusChanged
ignoreRadiusEnabledChanged
isHMDChanged
showAudioToolsChanged

Method Details

(static) loudnessToAudioLevel( loudness ) → {number}
Returns: number

Parameters

Name Type Description
loudness number
(static) resetSensors( )

(static) setShowAudioTools( showAudioTools )

Parameters

Name Type Description
showAudioTools boolean
(static) toggleCameraMute( )

Signal Details

avatarEnteredIgnoreRadius( avatarID )
Returns: Signal

 

Parameters

Name Type Description
avatarID QUuid
avatarLeftIgnoreRadius( avatarID )
Returns: Signal

 

Parameters

Name Type Description
avatarID QUuid
cameraEnabledChanged( )
Returns: Signal

 

cameraMutedChanged( )
Returns: Signal

 

enteredIgnoreRadiusChanged( enabled )
Returns: Signal

 

Parameters

Name Type Description
enabled boolean
ignoreRadiusEnabledChanged( enabled )
Returns: Signal

 

Parameters

Name Type Description
enabled boolean
isHMDChanged( )
Returns: Signal

 

showAudioToolsChanged( show )
Returns: Signal

 

Parameters

Name Type Description
show boolean