m ProbablePrime moved page AvatarVoiceSourceAssigner (Component) to Component:AvatarVoiceSourceAssigner: Creating component Namespace |
Automated: update Fields, Categories |
||
Line 15: | Line 15: | ||
== Usage == | == Usage == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|TargetReference|SyncRef`1| | |TargetReference|'''[[Type:SyncRef`1|SyncRef`1]]<[[Type:IAudioSource|IAudioSource]]>'''|TypeAdv0=true| Target <code>IAudioSource</code> that will be assigned the user's audio stream | ||
}} | }} | ||
Line 30: | Line 30: | ||
== Related Components == | == Related Components == | ||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}| | [[Category:Components{{#translation:}}|Avatar Voice Source Assigner]] | ||
[[Category:ComponentStubs]] | [[Category:ComponentStubs]] | ||
[[Category:Components:Users:Common Avatar System:Audio{{#translation:}}| | [[Category:Components:Users:Common Avatar System:Audio{{#translation:}}|Avatar Voice Source Assigner]] |
Latest revision as of 23:04, 3 March 2024
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
Component image
Introduction
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.
Usage
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. |
TargetReference
|
SyncRef`1<IAudioSource> | Target IAudioSource that will be assigned the user's audio stream
|
Behavior
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 TargetReference
to the active user's voice stream.
Examples
This component is useful when adding voice-driven effects to an avatar, such as a VisemeAnalyzer or VolumeMeter