Component:AvatarVoiceSourceAssigner: Difference between revisions

Latest revision as of 20:05, 10 November 2024

Component image

**AvatarVoiceSourceAssigner** component as seen in the Scene Inspector

The AvatarVoiceSourceAssigner sets the IAudioSource field referenced by TargetReference to the voice stream of the active user when the avatar this component is attached to is equipped.

This component is useful when adding voice-driven effects to an avatar, such as a Component:VisemeAnalyzer or Component:VolumeMeter

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. Some components stop their functionality when this field is disabled, but some don't.
`TargetReference`	SyncRef`1<IAudioSource>	Target `IAudioSource` that will be assigned the user's audio stream

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=AvatarVoiceSourceAssignerComponent.png
 |Name=AvatarVoiceSourceAssigner
 }}
+The '''AvatarVoiceSourceAssigner''' sets the <code>IAudioSource</code> field referenced by <code>TargetReference</code> to the voice stream of the active user when the avatar this component is attached to is equipped.
-<!--T:2-->
+This component is useful when adding voice-driven effects to an avatar, such as a [[Component:VisemeAnalyzer]] or [[Component:VolumeMeter]]
-== Introduction ==
-The '''AvatarVoiceSourceAssigner''' sets the <code>IAudioSource</code> field referenced by <code>TargetReference</code> to the voice stream of the active user when the avatar this component is attached to is equipped.
 <!--T:3-->
 == Usage ==
 {{Table ComponentFields
-|TargetReference|SyncRef`1|TypeString0=SyncRef<IAudioSource>| Target <code>IAudioSource</code> that will be assigned the user's audio stream
+|TargetReference|'''[[Type:SyncRef`1|SyncRef`1]]&lt;[[Type:IAudioSource|IAudioSource]]&gt;'''|TypeAdv0=true| Target <code>IAudioSource</code> that will be assigned the user's audio stream
 }}
 <!--T:4-->
-== Behavior ==
+== Usage ==
-This component only functions when it is attached to a slot in an active avatar.
-When an avatar is equipped, all instances of this component will assign the <code>TargetReference</code> to the active user's voice stream.
 <!--T:5-->
 == Examples ==
-This component is useful when adding voice-driven effects to an avatar, such as a [[VisemeAnalyzer (Component) | VisemeAnalyzer]] or [[VolumeMeter (Component) | VolumeMeter]]
 <!--T:6-->
-== Related Components ==
+== See Also ==
 </translate>
-[[Category:Components{{#translation:}}|AvatarVoiceSourceAssigner (Component){{#translation:}}]]
+[[Category:Components{{#translation:}}|Avatar Voice Source Assigner]]
-[[Category:ComponentStubs]]
+[[Category:Components:Users:Common Avatar System:Audio{{#translation:}}|Avatar Voice Source Assigner]]
-[[Category:Components:Users:Common Avatar System:Audio{{#translation:}}|AvatarVoiceSourceAssigner (Component){{#translation:}}]]