Skip to main content

Audio Player Override List

The Audio Player Override List is a component responsible for doing stuff like Microphones with a pickup trigger

Audio Player Overide List

Here when microphone is held, it broadcasts voice to default zone and to the Front Of House zone.

Configuration​

Pickup Trigger​

The pickup object to check for to enable this override list.

Zones​

Audio Player Overide List Editor - Local Zone

A list of zones, order does matter!

Profiles​

Audio Player Overide List Editor - Local Zone

A list of profiles for each zone, order does matter!

Zone Enabled​

Audio Player Overide List Editor - Local Zone

A list of toggles for each zone, order does matter!

Debug Options​

Audio Player Overide List Editor - Debug Options

Debug Log​

The debug log object that any logging should be directed to.

VRC Logging​

Writes a copy of any logged messages to the VRChat log.

Public API​

Network Sync​

This object is not network synced.

Inherited API​

  • UdonSharpBehaviour Public API

Properties​

PickupTrigger pickupTrigger

Gets or sets the PickupTrigger component that automatically registers hooks into pickup trigger events to bind to a player.

const int EVENT_BOUND_PLAYER_CHANGED​

Gets the constant value representing the event for when the bound player changes.

AudioOverrideZone[] zones​

Gets or sets the array of AudioOverrideZone objects that define different audio zones.

AudioOverrideSettings[] profiles​

Gets or sets the array of AudioOverrideSettings profiles corresponding to each zone.

bool[] zoneEnabled​

Gets or sets the array indicating whether each zone is enabled.

DebugLog debugLog​

Gets or sets the debug logging interface used by this class.

bool vrcLogging​

Gets or sets whether VRChat-specific logging is enabled.

Methods​

void _EnsureInit()​

Ensures that the override list is initialized. Called during startup to set up necessary components.

void _Init()​

Initializes the override list, including registering pickup trigger hooks if applicable.

void _OnTriggerOn()​

Called when the pickup trigger is activated. Sets the owner to the local player and binds the override list to that player.

void _OnTriggerOff()​

Called when the pickup trigger is deactivated. Releases ownership and unbinds the override list from the player.

bool _GetZoneActive( AudioOverrideZone zone )​

Checks if a specific zone is active/enabled.

void _SetZoneActive( bool state )​

Sets all zones to the specified active/inactive state.

void _SetZoneActive( AudioOverrideZone zone, bool state )​

Sets the specified zone's active state.

AudioOverrideSettings _GetZoneSettings( AudioOverrideZone zone )​

Retrieves the override settings for a specific zone.

void _SetZoneSettings( AudioOverrideZone AudioOverrideSettings )​

Sets the override settings for a specific zone.

int BoundPlayerID()​

Gets or sets the ID of the player bound to this override list, with change callback.

void _AddPlayer( VRCPlayerApi player )​

Applies overrides for a specific player in a specific zone.

void _RemovePlayer( VRCPlayerApi player )​

Removes a player from all zone overrides in this list.