Class VadEffect

VoiceActivity effect for OdinNative.Wrapper.MediaPipeline

Declaration

public class VadEffect : PipelineEffect, IPipelineEffect

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

Implements:
OdinNative.Wrapper.Media.IPipelineEffect

Properties

VoiceActivityEnabled

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

Declaration

public bool VoiceActivityEnabled { get; set; }

VoiceActivityAttackThreshold

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

Declaration

public float VoiceActivityAttackThreshold { get; set; }

VoiceActivityReleaseThreshold

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

Declaration

public float VoiceActivityReleaseThreshold { get; set; }

VolumeGateEnabled

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

Declaration

public bool VolumeGateEnabled { get; set; }

VolumeGateAttackThreshold

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

Declaration

public float VolumeGateAttackThreshold { get; set; }

VolumeGateReleaseThreshold

Indicates 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 NativeBindings.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 NativeBindings.OdinError SetVadConfig(NativeBindings.OdinVadConfig config)

Returns

OdinNative.Core.Imports.NativeBindings.OdinError: updated config

Parameters

Type	Name	Description
OdinNative.Core.Imports.NativeBindings.OdinVadConfig	config	new config

GetVadConfig()

Get native voice activity configuration

Declaration

public NativeBindings.OdinVadConfig GetVadConfig()

Returns

OdinNative.Core.Imports.NativeBindings.OdinVadConfig: updated config

SetApmConfig(OdinApmConfig)

Not supported

Declaration

public override NativeBindings.OdinError SetApmConfig(NativeBindings.OdinApmConfig config)

Returns

OdinNative.Core.Imports.NativeBindings.OdinError

Parameters

Type	Name
OdinNative.Core.Imports.NativeBindings.OdinApmConfig	config

Exceptions

OdinNative.Wrapper.OdinWrapperException

UpdateApmPlayback(float[], ulong)

Not supported

Declaration

public override NativeBindings.OdinError UpdateApmPlayback(float[] audio, ulong msDelay)

Returns

OdinNative.Core.Imports.NativeBindings.OdinError

Parameters

Type	Name
System.Single[]	audio
System.UInt64	msDelay

Exceptions

OdinNative.Wrapper.OdinWrapperException

Create(MediaPipeline, out VadEffect)

Insert a vad effect in the specified pipeline

Declaration

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

Returns

System.Boolean: true on success or false

Parameters

Type	Name	Description
OdinNative.Wrapper.MediaPipeline	pipeline	where to create a vad effect
OdinNative.Wrapper.Media.VadEffect	vad	created OdinNative.Wrapper.Media.VadEffect instance or null

Create(MediaPipeline, OdinVadConfig)

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

Declaration

public static VadEffect Create(MediaPipeline pipeline, NativeBindings.OdinVadConfig config)

Returns

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

Parameters

Type	Name	Description
OdinNative.Wrapper.MediaPipeline	pipeline	where to create a vad effect
OdinNative.Core.Imports.NativeBindings.OdinVadConfig	config	configuration settings for vad

Implements

• OdinNative.Wrapper.Media.IPipelineEffect