989onan bot (talk | contribs) Automated: create new component page |
add info |
||
| Line 3: | Line 3: | ||
|Name=Audio Listener | |Name=Audio Listener | ||
}} | }} | ||
The '''Audio Listener''' component | The '''Audio Listener''' component can hear audio from the world around it and relay it back. It can also be used as a source for audio data for AudioOutput, working as a virtual microphone (This only works on listeners that aren't bound to specific user - ActiveUser must be null) | ||
== Fields == | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|ActiveUser|User| | |ActiveUser|User| Position the audio source to this user. | ||
|Effects|{{RootFieldType|AutoSyncRefList`1|[[Type:AudioDSP_Effect|AudioDSP_Effect]]}}|TypeAdv1=true| | |Effects|{{RootFieldType|AutoSyncRefList`1|[[Type:AudioDSP_Effect|AudioDSP_Effect]]}}|TypeAdv1=true| The list of affects to apply to the audio this recieves. | ||
}} | }} | ||
== Usage == | == Usage == | ||
Audio Reverb zones and other effects can be dynamically assigned to the list of <code>Effects</code> using spatial variables. The default variable for such is "Resonite.Audio.Filters" of type [[Type:AudioDSP_Effect|AudioDSP_Effect]]. Using [[Component:SphereConstantReferenceSpatialVariable|SphereConstantReferenceSpatialVariable]]s of the same type can be used to designate areas with reverbs using the [[Spatial variable]] system. The list of effects on this component can be driven using the [[Component:ReferenceSpatialVariableDriver|ReferenceSpatialVariableDriver]] and will change depending on what audio effects at it's location it can sample from surrounding [[Component:SphereConstantReferenceSpatialVariable|SphereConstantReferenceSpatialVariable]]s | |||
== Examples == | == Examples == | ||
| Line 20: | Line 20: | ||
[[Category:Components:Audio{{#translation:}}|Audio Listener]] | [[Category:Components:Audio{{#translation:}}|Audio Listener]] | ||
[[Category:Components{{#translation:}}|Audio Listener]] | [[Category:Components{{#translation:}}|Audio Listener]] | ||
Revision as of 04:48, 9 May 2025
The Audio Listener component can hear audio from the world around it and relay it back. It can also be used as a source for audio data for AudioOutput, working as a virtual microphone (This only works on listeners that aren't bound to specific user - ActiveUser must be null)
Fields
| Name | Type | Description |
|---|---|---|
persistent
|
Bool | Determines whether or not this item will be saved to the server. |
UpdateOrder
|
Int | Controls the order in which this component is updated. |
Enabled
|
Bool | Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't. |
ActiveUser
|
User | Position the audio source to this user. |
Effects
|
direct AutoSyncRefList`1<AudioDSP_Effect> | The list of affects to apply to the audio this recieves. |
Usage
Audio Reverb zones and other effects can be dynamically assigned to the list of Effects using spatial variables. The default variable for such is "Resonite.Audio.Filters" of type AudioDSP_Effect. Using SphereConstantReferenceSpatialVariables of the same type can be used to designate areas with reverbs using the Spatial variable system. The list of effects on this component can be driven using the ReferenceSpatialVariableDriver and will change depending on what audio effects at it's location it can sample from surrounding SphereConstantReferenceSpatialVariables