Class ApmEffect

VoiceActivity effect for OdinNative.Wrapper.MediaPipeline

Assembly: cs.temp.dll.dll

Declaration

public class ApmEffect : PiplineEffect, IPiplineEffect

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

Implements:
OdinNative.Wrapper.Media.IPiplineEffect

Properties

EchoCanceller

Idicates whether the ApmConfig setting is enabled

Declaration

public bool EchoCanceller { get; set; }

HighPassFilter

Idicates whether the ApmConfig setting is enabled

Declaration

public bool HighPassFilter { get; set; }

PreAmplifier

Idicates whether the ApmConfig setting is enabled

Declaration

public bool PreAmplifier { get; set; }

NoiseSuppressionLevel

Idicates the level of noise suppression ApmConfig setting by default

Declaration

public OdinNoiseSuppression NoiseSuppressionLevel { get; set; }

TransientSuppressor

Idicates whether the ApmConfig setting is enabled

Declaration

public bool TransientSuppressor { get; set; }

GainController

Idicates whether the ApmConfig setting is enabled

Declaration

public bool GainController { get; set; }

Samplerate

Output decoder samplerate

Declaration

public uint Samplerate { get; }

IsStereo

Output decoder channel flag

Declaration

public bool IsStereo { get; }

Fields

Config

Audio processing configuration

Declaration

public OdinApmConfig Config

Methods

UpdateEffectConfig(MediaPipeline)

Set audio processing configuration

Declaration

public bool UpdateEffectConfig(MediaPipeline pipeline)

Returns

System.Boolean: true on success or false

Parameters

Type	Name
OdinNative.Wrapper.MediaPipeline	pipeline

SetApmConfig(OdinApmConfig)

Set managed audio processing configuration

Declaration

public override OdinError SetApmConfig(OdinApmConfig config)

Returns

Odin.OdinError: updated config

Parameters

Type	Name	Description
Odin.OdinApmConfig	config	new config

SetVadConfig(OdinVadConfig)

Not supported

Declaration

public override OdinError SetVadConfig(OdinVadConfig config)

Returns

Odin.OdinError

Parameters

Type	Name
Odin.OdinVadConfig	config

Exceptions

OdinNative.Wrapper.OdinWrapperException

GetVadConfig(out OdinVadConfig)

Not supported

Declaration

public override OdinError GetVadConfig(out OdinVadConfig config)

Returns

Odin.OdinError

Parameters

Type	Name
Odin.OdinVadConfig	config

Exceptions

OdinNative.Wrapper.OdinWrapperException

Create(MediaPipeline, uint, bool, OdinApmConfig)

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

Declaration

public static ApmEffect Create(MediaPipeline pipeline, uint samplerate, bool stereo, OdinApmConfig config)

Returns

OdinNative.Wrapper.Media.ApmEffect: Instance of OdinNative.Wrapper.Media.ApmEffect

Parameters

Type	Name	Description
OdinNative.Wrapper.MediaPipeline	pipeline	where to create a apm effect
System.UInt32	samplerate	samplerate of playback
System.Boolean	stereo	stereo of playback
Odin.OdinApmConfig	config	configuration settings for apm

Implements

• OdinNative.Wrapper.Media.IPiplineEffect