Skip to main content
Version: 2.x

Class VadEffect

VoiceActivity effect for OdinNative.Wrapper.MediaPipeline

Assembly: cs.temp.dll.dll
Declaration
public class VadEffect : PiplineEffect, IPiplineEffect

Inheritance: System.Object -> OdinNative.Wrapper.Media.PiplineEffect

Implements:
OdinNative.Wrapper.Media.IPiplineEffect

Properties

VoiceActivityEnabled

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

Declaration
public bool VoiceActivityEnabled { get; set; }

VoiceActivityAttackThreshold

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

Declaration
public float VoiceActivityAttackThreshold { get; set; }

VoiceActivityReleaseThreshold

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

Declaration
public float VoiceActivityReleaseThreshold { get; set; }

VolumeGateEnabled

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

Declaration
public bool VolumeGateEnabled { get; set; }

VolumeGateAttackThreshold

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

Declaration
public float VolumeGateAttackThreshold { get; set; }

VolumeGateReleaseThreshold

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

Declaration
public float VolumeGateReleaseThreshold { get; set; }

Fields

Config

Intern voice activity configuration

Declaration
public OdinVadConfig Config

Methods

UpdateEffectConfig()

Set voice activity configuration

Declaration
public bool UpdateEffectConfig()
Returns

System.Boolean: true on success or false### SetVadConfig(OdinVadConfig) Set managed voice activity configuration

Declaration
public override OdinError SetVadConfig(OdinVadConfig config)
Returns

Odin.OdinError: updated config

Parameters
TypeNameDescription
Odin.OdinVadConfigconfignew config

GetVadConfig()

Get native voice activity configuration

Declaration
public OdinVadConfig GetVadConfig()
Returns

Odin.OdinVadConfig: updated config### SetApmConfig(OdinApmConfig) Not supported

Declaration
public override OdinError SetApmConfig(OdinApmConfig config)
Returns

Odin.OdinError

Parameters
TypeName
Odin.OdinApmConfigconfig
Exceptions

OdinNative.Wrapper.OdinWrapperException

SetApmStreamDelay(ulong)

Not supported

Declaration
public override OdinError SetApmStreamDelay(ulong ms)
Returns

Odin.OdinError

Parameters
TypeName
System.UInt64ms
Exceptions

OdinNative.Wrapper.OdinWrapperException

UpdateApmPlayback(float[])

Not supported

Declaration
public override OdinError UpdateApmPlayback(float[] audio)
Returns

Odin.OdinError

Parameters
TypeName
System.Single[]audio
Exceptions

OdinNative.Wrapper.OdinWrapperException

Create(MediaPipeline, out VadEffect)

Insert a vad effect in the specified pipline

Declaration
public static bool Create(MediaPipeline pipeline, out VadEffect vad)
Returns

System.Boolean: Instance of OdinNative.Wrapper.Media.VadEffect

Parameters
TypeNameDescription
OdinNative.Wrapper.MediaPipelinepipelinewhere to create a vad effect
OdinNative.Wrapper.Media.VadEffectvad

Create(MediaPipeline, OdinVadConfig)

Insert a vad effect in the specified pipline and sets the vad config

Declaration
public static VadEffect Create(MediaPipeline pipeline, OdinVadConfig config)
Returns

OdinNative.Wrapper.Media.VadEffect: Instance of OdinNative.Wrapper.Media.VadEffect

Parameters
TypeNameDescription
OdinNative.Wrapper.MediaPipelinepipelinewhere to create a vad effect
Odin.OdinVadConfigconfigconfiguration settings for vad

Implements