Class PipelineEffect

Declaration

public abstract class PipelineEffect : IPipelineEffect

Derived:
OdinNative.Wrapper.Media.ApmEffect, OdinNative.Wrapper.Media.CustomActivityEffect, OdinNative.Wrapper.Media.CustomEffect<T>, OdinNative.Wrapper.Media.VadEffect, OdinNative.Wrapper.Media.ViEffect

Implements:
OdinNative.Wrapper.Media.IPipelineEffect

Properties

Id

Effect id

Declaration

public uint Id { get; }

Index

Effect index

Declaration

public uint Index { get; set; }

Parent

Pipeline handle

Declaration

public OdinPipelineHandle Parent { get; }

Methods

GetEffectIndex(out uint)

Get native effect index

Declaration

public virtual NativeBindings.OdinError GetEffectIndex(out uint indexId)

Returns

OdinNative.Core.Imports.NativeBindings.OdinError: OdinNative.Core.Imports.NativeBindings.OdinError.ODIN_ERROR_SUCCESS or error

Parameters

Type	Name	Description
System.UInt32	indexId	native index

GetEffectType(out OdinEffectType)

Get native effect OdinNative.Core.Imports.NativeBindings.OdinEffectType

Declaration

public virtual NativeBindings.OdinError GetEffectType(out NativeBindings.OdinEffectType effectType)

Returns

OdinNative.Core.Imports.NativeBindings.OdinError: OdinNative.Core.Imports.NativeBindings.OdinError.ODIN_ERROR_SUCCESS or error

Parameters

Type	Name	Description
OdinNative.Core.Imports.NativeBindings.OdinEffectType	effectType	native type

GetVadConfig(out OdinVadConfig)

Get native voice activity config

Declaration

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

Returns

OdinNative.Core.Imports.NativeBindings.OdinError: OdinNative.Core.Imports.NativeBindings.OdinError.ODIN_ERROR_SUCCESS or error

Parameters

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

GetApmConfig(out OdinApmConfig)

Get native apm config

Declaration

public virtual NativeBindings.OdinError GetApmConfig(out NativeBindings.OdinApmConfig config)

Returns

OdinNative.Core.Imports.NativeBindings.OdinError: OdinNative.Core.Imports.NativeBindings.OdinError.ODIN_ERROR_SUCCESS or error

Parameters

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

GetViConfig(out OdinViConfig)

Get native voice isolation config

Declaration

public virtual NativeBindings.OdinError GetViConfig(out NativeBindings.OdinViConfig config)

Returns

OdinNative.Core.Imports.NativeBindings.OdinError: OdinNative.Core.Imports.NativeBindings.OdinError.ODIN_ERROR_SUCCESS or error

Parameters

Type	Name	Description
OdinNative.Core.Imports.NativeBindings.OdinViConfig	config	native config

SetViConfig(OdinViConfig)

Updates the configuration settings of the VI effect identified by effect_id in the specified audio pipeline.

Declaration

public virtual NativeBindings.OdinError SetViConfig(NativeBindings.OdinViConfig config)

Returns

OdinNative.Core.Imports.NativeBindings.OdinError: OdinNative.Core.Imports.NativeBindings.OdinError.ODIN_ERROR_SUCCESS or error

Parameters

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

SetApmConfig(OdinApmConfig)

Set native audio processing config

Declaration

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

Returns

OdinNative.Core.Imports.NativeBindings.OdinError: OdinNative.Core.Imports.NativeBindings.OdinError.ODIN_ERROR_SUCCESS or error

Parameters

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

SetVadConfig(OdinVadConfig)

Updates the configuration settings of the VAD effect identified by effect_id in the specified audio pipeline.

Declaration

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

Returns

OdinNative.Core.Imports.NativeBindings.OdinError: OdinNative.Core.Imports.NativeBindings.OdinError.ODIN_ERROR_SUCCESS or error

Parameters

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

UpdateApmPlayback(float[], ulong)

Updates the specified APM effect's sample buffer for processing the reverse (playback) audio stream. The provided samples must be interleaved float values in the range [-1, 1]. The delay parameter is used to align the reverse stream processing with the forward (capture) stream. The delay can be expressed as: delay = (t_render - t_analyze) + (t_process - t_capture)

Declaration

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

Returns

OdinNative.Core.Imports.NativeBindings.OdinError: OdinNative.Core.Imports.NativeBindings.OdinError.ODIN_ERROR_SUCCESS or error

Parameters

Type	Name	Description
System.Single[]	audio	samples
System.UInt64	msDelay	delay in ms

Implements

• OdinNative.Wrapper.Media.IPipelineEffect