(One intermediate revision by one other user not shown)
Line 5:
Line 5:
|Name=AvatarAudioConfiguration
|Name=AvatarAudioConfiguration
}}
}}
Avatar Audio Configuration is a component that allows for overriding [[Component:AvatarAudioOutputManager|Avatar Audio Output Manager]] voice configs in worlds using user injection.
<!--T:2-->
== Fields ==
== Intoduction ==
{{stub}}<!--T:3-->
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|Volume|Float| {{stub}}
|Normal|{{RootFieldType|VoiceModeConfig}}|TypeAdv0=true| The settings to override <code>NormalConfig</code> on an [[Component:AvatarAudioOutputManager|Avatar Audio Output Manager]] with.
|MinDistance|Float| {{stub}}
|Shout|{{RootFieldType|VoiceModeConfig}}|TypeAdv1=true| The settings to override <code>ShoutConfig</code> on an [[Component:AvatarAudioOutputManager|Avatar Audio Output Manager]] with.
|MaxDistance|Float| {{stub}}
|Broadcast|{{RootFieldType|VoiceModeConfig}}|TypeAdv2=true| The settings to override <code>BroadcastConfig</code> on an [[Component:AvatarAudioOutputManager|Avatar Audio Output Manager]] with.
|RollOffMode|AudioRolloffMode| {{stub}}
|DistanceSpace|AudioDistanceSpace| {{stub}}
|MinScale|Float| {{stub}}
|MaxScale|Float| {{stub}}
|Spatialize|Bool| {{stub}}
|SpatialBlend|Float| {{stub}}
|Doppler|Float| {{stub}}
|Volume|Float| {{stub}}
|MinDistance|Float| {{stub}}
|MaxDistance|Float| {{stub}}
|RollOffMode|AudioRolloffMode| {{stub}}
|DistanceSpace|AudioDistanceSpace| {{stub}}
|MinScale|Float| {{stub}}
|MaxScale|Float| {{stub}}
|Spatialize|Bool| {{stub}}
|SpatialBlend|Float| {{stub}}
|Doppler|Float| {{stub}}
|Volume|Float| {{stub}}
|MinDistance|Float| {{stub}}
|MaxDistance|Float| {{stub}}
|RollOffMode|AudioRolloffMode| {{stub}}
|DistanceSpace|AudioDistanceSpace| {{stub}}
|MinScale|Float| {{stub}}
|MaxScale|Float| {{stub}}
|Spatialize|Bool| {{stub}}
|SpatialBlend|Float| {{stub}}
|Doppler|Float| {{stub}}
}}
}}
<!--T:4-->
<!--T:2-->
== Behavior ==
== Usage ==
{{stub}}
attach this component as part of the hierarchy of a slot that is put into <code>AutoInject</code> on a [[Component:CommonAvatarBuilder|Common Avatar Builder Component]] on the world root. When the component is injected, it will auto fill itself into the <code>_audioConfiguration</code> of the user's [[Component:AvatarAudioOutputManager|Avatar Audio Output Manager]] and allow for overriding the user's audio config.
<!--T:5-->
<!--T:3-->
== Examples ==
== Examples ==
{{stub}}
This can be used to make a world system where if a user is in a different room than you, their voice will automatically silence locally for you, so you cannot hear them. This can be useful for making sound proof rooms. The opposite can be done, where a user going up to a microphone on a stand in a world will make their voice global for everyone, or only for people in a room for the speaker that microphone controls.
This can also be used to make a world system where voices are culled depending on where you look as well. which can act like a world-sided Earmuffs mode like the one in settings.
== Related Components ==
* For how world injected modules work (which said injected slot can contain this component) see [[Component:CommonAvatarBuilder|Common Avatar Builder Component]]
* For the component this overrides for user voices, see [[Component:AvatarAudioOutputManager|Avatar Audio Output Manager]].
attach this component as part of the hierarchy of a slot that is put into AutoInject on a Common Avatar Builder Component on the world root. When the component is injected, it will auto fill itself into the _audioConfiguration of the user's Avatar Audio Output Manager and allow for overriding the user's audio config.
Examples
This can be used to make a world system where if a user is in a different room than you, their voice will automatically silence locally for you, so you cannot hear them. This can be useful for making sound proof rooms. The opposite can be done, where a user going up to a microphone on a stand in a world will make their voice global for everyone, or only for people in a room for the speaker that microphone controls.
This can also be used to make a world system where voices are culled depending on where you look as well. which can act like a world-sided Earmuffs mode like the one in settings.
Related Components
For how world injected modules work (which said injected slot can contain this component) see Common Avatar Builder Component
