Component:AvatarAudioOutputManager: Difference between revisions

From Resonite Wiki
← Older edit
VisualWikitext
Automated: update Fields, Categories
add link to overriding component
 
(One intermediate revision by the same user not shown)
Line 7: Line 7:
|Name=AvatarAudioOutputManager
|Name=AvatarAudioOutputManager
}}
}}
 
Avatar Audio Output Manager is the component that handles changing the audio output values when a user changes their voice mode or mutes.
<!--T:2-->
== Intoduction ==


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|AudioOutput|'''[[Component:AudioOutput|AudioOutput]]'''|TypeAdv0=true|
|AudioOutput|'''[[Component:AudioOutput|AudioOutput]]'''|TypeAdv0=true| The audio output this component is controlling and targeting that has the <code>_activeUser</code>'s voice.
|IsViewVoice|Bool|
|IsViewVoice|Bool| Whether or not this component is the voice of the <code>_activeUser</code>'s head or the <code>_activeUser</code>'s free cam.
|WhisperConfig|{{RootFieldType|VoiceModeConfig}}|TypeAdv2=true|
|WhisperConfig|{{RootFieldType|VoiceModeConfig}}|TypeAdv2=true| What <code>AudioOutput</code> should be set to when <code>_activeUser</code> is in Whisper voice mode.
|NormalConfig|{{RootFieldType|VoiceModeConfig}}|TypeAdv3=true|
|NormalConfig|{{RootFieldType|VoiceModeConfig}}|TypeAdv3=true| What <code>AudioOutput</code> should be set to when <code>_activeUser</code> is in Normal voice mode.
|ShoutConfig|{{RootFieldType|VoiceModeConfig}}|TypeAdv4=true|
|ShoutConfig|{{RootFieldType|VoiceModeConfig}}|TypeAdv4=true| What <code>AudioOutput</code> should be set to when <code>_activeUser</code> is in Shout voice mode.
|BroadcastConfig|{{RootFieldType|VoiceModeConfig}}|TypeAdv5=true|
|BroadcastConfig|{{RootFieldType|VoiceModeConfig}}|TypeAdv5=true| What <code>AudioOutput</code> should be set to when the user is in Broadcast mode.
|__legacyWhisperVolume|Float|
|__legacyWhisperVolume|Float| Internal.
|__legacyNormalVolume|Float|
|__legacyNormalVolume|Float| Internal.
|__legacyShoutVolume|Float|
|__legacyShoutVolume|Float| Internal.
|__legacyBroadcastVolume|Float|
|__legacyBroadcastVolume|Float| Internal.
|__legacyNormalDopplerLevel|Float|
|__legacyNormalDopplerLevel|Float| Internal.
|__legacyShoutDopplerLevel|Float|
|__legacyShoutDopplerLevel|Float| Internal.
|__legacyWhisperRange|Float|
|__legacyWhisperRange|Float| Internal.
|_activeUser|User|
|_activeUser|User| The user that this component is supposed to be managing an [[Component:AudioOutput|Audio Output Component]] for.
|_enabled|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv14=true|
|_enabled|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv14=true| The enabled field of the [[Component:AudioOutput|Audio Output Component]] controlled by this component.
|_volume|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv15=true|
|_volume|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv15=true| The volume field of the [[Component:AudioOutput|Audio Output Component]] controlled by this component.
|_doppler|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv16=true|
|_doppler|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv16=true| The doppler field of the [[Component:AudioOutput|Audio Output Component]] controlled by this component.
|_spatialize|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv17=true|
|_spatialize|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv17=true| The spatialize field of the [[Component:AudioOutput|Audio Output Component]] controlled by this component.
|_spatialBlend|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv18=true|
|_spatialBlend|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv18=true| The spatialBlend field of the [[Component:AudioOutput|Audio Output Component]] controlled by this component.
|_minDistance|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv19=true|
|_minDistance|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv19=true| The minDistance field of the [[Component:AudioOutput|Audio Output Component]] controlled by this component.
|_maxDistance|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv20=true|
|_maxDistance|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv20=true| The maxDistance field of the [[Component:AudioOutput|Audio Output Component]] controlled by this component.
|_rollOffMode|{{RootFieldType|FieldDrive`1|[[Type:AudioRolloffMode|AudioRolloffMode]]}}|TypeAdv21=true|
|_rollOffMode|{{RootFieldType|FieldDrive`1|[[Type:AudioRolloffMode|AudioRolloffMode]]}}|TypeAdv21=true| The rollOffMode field of the [[Component:AudioOutput|Audio Output Component]] controlled by this component.
|_distanceSpace|{{RootFieldType|FieldDrive`1|[[Type:AudioDistanceSpace|AudioDistanceSpace]]}}|TypeAdv22=true|
|_distanceSpace|{{RootFieldType|FieldDrive`1|[[Type:AudioDistanceSpace|AudioDistanceSpace]]}}|TypeAdv22=true| The distance space field of the [[Component:AudioOutput|Audio Output Component]] controlled by this component.
|_minScale|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv23=true|
|_minScale|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv23=true| The minScale field of the [[Component:AudioOutput|Audio Output Component]] controlled by this component.
|_maxScale|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv24=true|
|_maxScale|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv24=true| The maxScale field of the [[Component:AudioOutput|Audio Output Component]] controlled by this component.
|_scaleCompensation|Float|
|_scaleCompensation|Float| How much to scale up the volume range of the user so a small <code>_activeUser</code> can still be heard by everyone else.
|_audioConfiguration|'''[[Component:AvatarAudioConfiguration|AvatarAudioConfiguration]]'''|TypeAdv26=true|
|_audioConfiguration|'''[[Component:AvatarAudioConfiguration|AvatarAudioConfiguration]]'''|TypeAdv26=true| A field automatically filled with an Avatar Audio Configuration when the user spawns with an injected Avatar Audio Configuration courtesy of the world they spawned in. When not null, the specified component overrides <code>WhisperConfig</code>, <code>NormalConfig</code>, <code>ShoutConfig</code>, and <code>BroadcastConfig</code> voice settings.
}}
}}


Line 51: Line 49:
<!--T:6-->
<!--T:6-->
== Related Components ==
== Related Components ==
* For how to override the user's voice settings in a world, see the [[Component:AvatarAudioConfiguration|Avatar Audio Configuration Component]].
</translate>
</translate>
[[Category:Components{{#translation:}}|Avatar Audio Output Manager]]
[[Category:Components{{#translation:}}|Avatar Audio Output Manager]]
[[Category:ComponentStubs]]
[[Category:Components:Users:Common Avatar System:Audio{{#translation:}}|Avatar Audio Output Manager]]
[[Category:Components:Users:Common Avatar System:Audio{{#translation:}}|Avatar Audio Output Manager]]

Latest revision as of 18:42, 29 October 2024


This article or section is a Stub. You can help the Resonite Wiki by expanding it.


Component image 
AvatarAudioOutputManager component as seen in the Scene Inspector

Avatar Audio Output Manager is the component that handles changing the audio output values when a user changes their voice mode or mutes.

Usage

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.
AudioOutput AudioOutput The audio output this component is controlling and targeting that has the _activeUser's voice.
IsViewVoice Bool Whether or not this component is the voice of the _activeUser's head or the _activeUser's free cam.
WhisperConfig direct VoiceModeConfig What AudioOutput should be set to when _activeUser is in Whisper voice mode.
NormalConfig direct VoiceModeConfig What AudioOutput should be set to when _activeUser is in Normal voice mode.
ShoutConfig direct VoiceModeConfig What AudioOutput should be set to when _activeUser is in Shout voice mode.
BroadcastConfig direct VoiceModeConfig What AudioOutput should be set to when the user is in Broadcast mode.
__legacyWhisperVolume Float Internal.
__legacyNormalVolume Float Internal.
__legacyShoutVolume Float Internal.
__legacyBroadcastVolume Float Internal.
__legacyNormalDopplerLevel Float Internal.
__legacyShoutDopplerLevel Float Internal.
__legacyWhisperRange Float Internal.
_activeUser User The user that this component is supposed to be managing an Audio Output Component for.
_enabled field drive of Bool The enabled field of the Audio Output Component controlled by this component.
_volume field drive of Float The volume field of the Audio Output Component controlled by this component.
_doppler field drive of Float The doppler field of the Audio Output Component controlled by this component.
_spatialize field drive of Bool The spatialize field of the Audio Output Component controlled by this component.
_spatialBlend field drive of Float The spatialBlend field of the Audio Output Component controlled by this component.
_minDistance field drive of Float The minDistance field of the Audio Output Component controlled by this component.
_maxDistance field drive of Float The maxDistance field of the Audio Output Component controlled by this component.
_rollOffMode field drive of AudioRolloffMode The rollOffMode field of the Audio Output Component controlled by this component.
_distanceSpace field drive of AudioDistanceSpace The distance space field of the Audio Output Component controlled by this component.
_minScale field drive of Float The minScale field of the Audio Output Component controlled by this component.
_maxScale field drive of Float The maxScale field of the Audio Output Component controlled by this component.
_scaleCompensation Float How much to scale up the volume range of the user so a small _activeUser can still be heard by everyone else.
_audioConfiguration AvatarAudioConfiguration A field automatically filled with an Avatar Audio Configuration when the user spawns with an injected Avatar Audio Configuration courtesy of the world they spawned in. When not null, the specified component overrides WhisperConfig, NormalConfig, ShoutConfig, and BroadcastConfig voice settings.

Behavior

Examples

Related Components

Retrieved from "https://wiki.resonite.com/index.php?title=Component:AvatarAudioOutputManager&oldid=91598"