Class ApmEffect

Audio Processing Module (APM) effect for OdinNative.Wrapper.MediaPipeline

Declaration

public class ApmEffect : PipelineEffect, IPipelineEffect

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

Implements:
OdinNative.Wrapper.Media.IPipelineEffect

Properties

EchoCanceller

Indicates whether the ApmConfig setting is enabled

Declaration

public bool EchoCanceller { get; set; }

HighPassFilter

Indicates whether the ApmConfig setting is enabled

Declaration

public bool HighPassFilter { get; set; }

NoiseSuppressionLevel

Indicates the level of noise suppression ApmConfig setting by default

Declaration

public NativeBindings.OdinNoiseSuppressionLevel NoiseSuppressionLevel { get; set; }

TransientSuppressor

Indicates whether the ApmConfig setting is enabled

Declaration

public bool TransientSuppressor { get; set; }

GainControllerVersion

Indicates the gain controller version ApmConfig setting

Declaration

public NativeBindings.OdinGainControllerVersion GainControllerVersion { 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 NativeBindings.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	Description
OdinNative.Wrapper.MediaPipeline	pipeline	currently unused

SetApmConfig(OdinApmConfig)

Set managed audio processing configuration

Declaration

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

Returns

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

Parameters

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

SetVadConfig(OdinVadConfig)

Not supported

Declaration

public override NativeBindings.OdinError SetVadConfig(NativeBindings.OdinVadConfig config)

Returns

OdinNative.Core.Imports.NativeBindings.OdinError

Parameters

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

Exceptions

OdinNative.Wrapper.OdinWrapperException

GetVadConfig(out OdinVadConfig)

Not supported

Declaration

public override NativeBindings.OdinError GetVadConfig(out NativeBindings.OdinVadConfig config)

Returns

OdinNative.Core.Imports.NativeBindings.OdinError

Parameters

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

Exceptions

OdinNative.Wrapper.OdinWrapperException

Create(MediaPipeline, uint, bool, OdinApmConfig)

Insert an APM effect in the specified pipeline and sets the apm config

Declaration

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

Returns

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

Parameters

Type	Name	Description
OdinNative.Wrapper.MediaPipeline	pipeline	where to create an APM effect
System.UInt32	samplerate	samplerate of playback
System.Boolean	stereo	stereo of playback
OdinNative.Core.Imports.NativeBindings.OdinApmConfig	config	configuration settings for apm

Implements

• OdinNative.Wrapper.Media.IPipelineEffect