Class OdinColliderFilterComponent

Custom filter by collider component for OdinNative.Wrapper.Media.CustomEffect

This class is an effect in the odin audio pipeline to mute audio based on GameObject collisions in Unity space. The effect can help to trigger specific audio packets quickly without the adjustment of Server-side positions.

Declaration

[HelpURL("https://docs.4players.io/voice/unity/next/api/OdinNative.Unity.Audio/OdinColliderFilterComponent/")]
[AddComponentMenu("Odin/Audio/Effect/Collider Filter")]
public class OdinColliderFilterComponent : OdinCustomEffectUnityComponentBase<nint>, IOdinEffect

Inheritance: System.Object -> UnityEngine.Object -> UnityEngine.Component -> UnityEngine.Behaviour -> UnityEngine.MonoBehaviour -> OdinNative.Unity.Audio.OdinCustomEffectUnityComponentBase<U>

Implements:
OdinNative.Unity.Audio.IOdinEffect

Properties

_Colliding

Declaration

protected virtual bool _Colliding { get; }

Fields

ColliderTag

Declaration

[Tooltip("Set the tag to compare match for collider object")]
public string ColliderTag

Comparison

Declaration

public StringComparison Comparison

Callback

Declaration

public UnityAction<NativeBindings.OdinTArray<float>> Callback

Methods

SetTriggerCount(Collider, bool)

Declaration

public virtual void SetTriggerCount(Collider obj, bool isEnter)

Parameters

Type	Name
UnityEngine.Collider	obj
System.Boolean	isEnter

CustomEffectCallback(OdinTArray<float>, ref bool, nint)

Callback delegate for the effect

Declaration

public override void CustomEffectCallback(NativeBindings.OdinTArray<float> audio, ref bool isSilent, nint _)

Parameters

Type	Name	Description
OdinNative.Core.Imports.NativeBindings.OdinTArray<T>	audio	audio data wrapper for copy buffer to native
System.Boolean	isSilent	flag whether the buffer contains silence, can be set to mute the frame
System.IntPtr	_	effect userdata, see OdinNative.Unity.Audio.OdinCustomEffectUnityComponentBase

Implements

• OdinNative.Unity.Audio.IOdinEffect