Skip to main content
Version: 2.x

Class OdinECLoopbackComponent

Custom echo canceller loopback component for OdinNative.Wrapper.Media.CustomEffect

This class is an effect in the odin audio pipeline to loopback pushed audio to apm.

Declaration
[HelpURL("https://docs.4players.io/voice/unity/next/api/OdinNative.Unity.Audio/OdinECLoopbackComponent/")]
[AddComponentMenu("Odin/Audio/Effect/EC Loopback")]
[RequireComponent(typeof(OdinApmComponent))]
public class OdinECLoopbackComponent : OdinCustomEffectUnityComponentBase<nint>, IOdinEffect

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

Implements:
OdinNative.Unity.Audio.IOdinEffect

Fields

ApmEffect

Declaration
public OdinApmComponent ApmEffect

Methods

Start()

Declaration
protected override void Start()

GetEffectUserData()

Get userdata used for the OdinNative.Unity.Audio.OdinCustomEffectUnityComponentBase

Declaration
public override nint GetEffectUserData()
Returns

System.IntPtr: effect userdata

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
TypeNameDescription
OdinNative.Core.Imports.NativeBindings.OdinTArray<T>audioaudio data wrapper for copy buffer to native
System.BooleanisSilentflag whether the buffer contains silence, can be set to mute the frame
System.IntPtr_effect userdata, see OdinNative.Unity.Audio.OdinCustomEffectUnityComponentBase

Implements