Skip to main content
Version: 2.x

Class OdinViComponent

VoiceIsolation component for OdinNative.Wrapper.Media.ViEffect

This class provides configuration for the native implemented deep-learning voice isolation which separates speech from background sound in the capture signal.

Declaration
[HelpURL("https://docs.4players.io/voice/unity/next/api/OdinNative.Unity.Audio/OdinViComponent/")]
[AddComponentMenu("Odin/Audio/Effect/Voice isolation")]
public class OdinViComponent : MonoBehaviour, IOdinEffect

Inheritance: System.Object -> UnityEngine.Object -> UnityEngine.Component -> UnityEngine.Behaviour -> UnityEngine.MonoBehaviour

Implements:
OdinNative.Unity.Audio.IOdinEffect

Properties​

Media​

Declaration
public IMedia Media { get; set; }

Effect​

Declaration
public ViEffect Effect { get; }

IsCreated​

Declaration
public bool IsCreated { get; }

Fields​

Enabled​

Indicates whether the effect will attenuate non-speech portions of the input audio signal

Declaration
public bool Enabled

AttenuationLimitDb​

Maximum attenuation applied to non-speech in dB; values of 100 and above remove background sound entirely, while values close to 0 disable noise reduction.

Declaration
public float AttenuationLimitDb

Methods​

UpdateConfig()​

Declaration
public void UpdateConfig()

UpdateConfig(MediaPipeline)​

Declaration
public void UpdateConfig(MediaPipeline pipeline)
Parameters​
TypeName
OdinNative.Wrapper.MediaPipelinepipeline

ResetEffect()​

Declaration
public void ResetEffect()

ResetEffect(MediaPipeline)​

Declaration
public void ResetEffect(MediaPipeline pipeline)
Parameters​
TypeName
OdinNative.Wrapper.MediaPipelinepipeline

GetMedia<T>()​

Declaration
public T GetMedia<T>() where T : IMedia
Returns​

<T>

Type Parameters​
  • T

GetEffect()​

Declaration
public PipelineEffect GetEffect()
Returns​

OdinNative.Wrapper.Media.PipelineEffect

Implements​