Skip to main content
Version: 2.x

Class OdinVadComponent

VoiceActivity component for OdinNative.Wrapper.Media.VadEffect

This class provides configuration for the native implemented voice detection. Supports speech recognition and/or a volume threshold.

Declaration
[HelpURL("https://docs.4players.io/voice/unity/next/api/OdinNative.Unity.Audio/OdinVadComponent/")]
[AddComponentMenu("Odin/Audio/Effect/Voice activity detection")]
public class OdinVadComponent : 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 VadEffect Effect { get; }

IsCreated​

Declaration
public bool IsCreated { get; }

Fields​

VoiceActivityEnabled​

Indicates whether the vad setting in OdinNative.Core.Imports.NativeBindings.OdinSensitivityConfig is enabled

Declaration
[Header("Odin Voice Activity Detection")]
public bool VoiceActivityEnabled

VoiceActivityAttackThreshold​

Indicates the vad attack probability setting in OdinNative.Core.Imports.NativeBindings.OdinSensitivityConfig

Declaration
public float VoiceActivityAttackThreshold

VoiceActivityReleaseThreshold​

Indicates the vad release probability setting in OdinNative.Core.Imports.NativeBindings.OdinSensitivityConfig

Declaration
public float VoiceActivityReleaseThreshold

VolumeGateEnabled​

Indicates whether the gate setting in OdinNative.Core.Imports.NativeBindings.OdinSensitivityConfig is enabled

Declaration
[Header("Odin Volume Gate")]
public bool VolumeGateEnabled

VolumeGateAttackThreshold​

Indicates the gate attack loudness setting in OdinNative.Core.Imports.NativeBindings.OdinSensitivityConfig

Declaration
public float VolumeGateAttackThreshold

VolumeGateReleaseThreshold​

Indicates the gate release loudness setting in OdinNative.Core.Imports.NativeBindings.OdinSensitivityConfig

Declaration
public float VolumeGateReleaseThreshold

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​