PlayerAudioOverrideList

PlayerAudioOverrideList

Packages/tlp.udonvoiceutils/Runtime/Core/PlayerAudio/PlayerAudioOverrideList.cs

The sorted list of PlayerAudioOverrides a single player is currently affected by.

Overview

The UdonSharpBehaviour PlayerAudioOverrideList is the component which

• is used by the PlayerAudioController to determine which override to apply to a player
• contains all overrides a single player is currently affected by
• is always sorted by PlayerAudioOverride.Priority
  • highest priority override (or last added with same priority) is at the first position in the list
• automatically removes invalid entries when accessed
• contains no duplicates

Public API

Method	Returns	Description
AddOverride(PlayerAudioOverride)	bool	Add an override, maintaining priority sort order
RemoveOverride(PlayerAudioOverride)	int	Remove an override, returns remaining count
GetMaxPriority(VRCPlayerApi, out PlayerAudioOverride)	bool	Get the highest-priority override not blacklisting the player
Get(int index)	PlayerAudioOverride	Get override at index (consolidates invalid entries first)
Contains(PlayerAudioOverride)	bool	Check if the list contains a specific override
Overrides	int	Number of valid overrides in the list

Behavior

• When AddOverride is called, the override is inserted at the correct position based on priority
• When Get or GetMaxPriority is called, invalid (destroyed) entries are automatically consolidated
• RemoveOverride compacts the array and returns the new count

Related

• PlayerAudioController — the controller that reads this list
• PlayerAudioOverride — the override entries in this list