AvatarVoiceSourceAssigner (Component)

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

AvatarVoiceSourceAssigner component as seen in the Scene Inspector

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

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
TargetReference	SyncRef<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