DirectivityEffect
ClassAn Audio Component effect that simulates sound attenuation based on the orientation of the transform relative to the AudioListenerComponent.
- Available on all platforms
Index
Properties
Methods
Example
// @input Component.AudioComponent audio
var spatialAudio = script.audio.spatialAudio;
var directivityEffect = spatialAudio.directivityEffect;
directivityEffect.enabled = true;
directivityEffect.shapeDecay = 10;
directivityEffect.shapeFactor = 0.5;
Extends
Properties
enabled
enabled:
boolean
Whether the audio directivity effect is applied or not.
Since
Lens Scripting Version 147
Default Value
false
shapeDecay
shapeDecay:
number
The width of main lobe.
Since
Lens Scripting Version 147
Default Value
1
shapeFactor
shapeFactor:
number
A ratio that specifies the shape of pattern directivity from omnidirectional(0) to cardioid (1.0).
Since
Lens Scripting Version 147
Default Value
1
Methods
getTypeName()
staticgetTypeName():TypeName<DirectivityEffect>
Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().
Returns
TypeName<DirectivityEffect>
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean