(One intermediate revision by one other user not shown)
Line 2:
Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=AvatarVoiceSourceAssignerComponent.png
|Image=AvatarVoiceSourceAssignerComponent.png
|Name=AvatarVoiceSourceAssigner
|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-->
<!--T:3-->
== Usage ==
== Usage ==
{{Table ComponentFields
{{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]]<[[Type:IAudioSource|IAudioSource]]>'''|TypeAdv0=true| Target <code>IAudioSource</code> that will be assigned the user's audio stream
}}
}}
<!--T:4-->
<!--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-->
<!--T:5-->
== Examples ==
== Examples ==
This component is useful when adding voice-driven effects to an avatar, such as a [[VisemeAnalyzer (Component) | VisemeAnalyzer]] or [[VolumeMeter (Component) | VolumeMeter]]
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.
