Skip to main content
Version: 2.x

Interface IPipelineEffect

Declaration
public interface IPipelineEffect

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

Properties

Id

Effect id

Declaration
uint Id { get; }

Index

Effect index

Declaration
uint Index { get; set; }

Parent

Pipeline handle

Declaration
OdinPipelineHandle Parent { get; }

Methods

GetEffectIndex(out uint)

Get native effect index

Declaration
NativeBindings.OdinError GetEffectIndex(out uint indexId)
Returns

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

Parameters
TypeNameDescription
System.UInt32indexIdnative index

GetEffectType(out OdinEffectType)

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

Declaration
NativeBindings.OdinError GetEffectType(out NativeBindings.OdinEffectType effectType)
Returns

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

Parameters
TypeNameDescription
OdinNative.Core.Imports.NativeBindings.OdinEffectTypeeffectTypenative type

GetVadConfig(out OdinVadConfig)

Get native voice activity config

Declaration
NativeBindings.OdinError GetVadConfig(out NativeBindings.OdinVadConfig config)
Returns

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

Parameters
TypeNameDescription
OdinNative.Core.Imports.NativeBindings.OdinVadConfigconfignative config

GetApmConfig(out OdinApmConfig)

Get native apm config

Declaration
NativeBindings.OdinError GetApmConfig(out NativeBindings.OdinApmConfig config)
Returns

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

Parameters
TypeNameDescription
OdinNative.Core.Imports.NativeBindings.OdinApmConfigconfignative config

GetViConfig(out OdinViConfig)

Get native voice isolation config

Declaration
NativeBindings.OdinError GetViConfig(out NativeBindings.OdinViConfig config)
Returns

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

Parameters
TypeNameDescription
OdinNative.Core.Imports.NativeBindings.OdinViConfigconfignative config

SetViConfig(OdinViConfig)

Set native voice isolation config

Declaration
NativeBindings.OdinError SetViConfig(NativeBindings.OdinViConfig config)
Returns

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

Parameters
TypeNameDescription
OdinNative.Core.Imports.NativeBindings.OdinViConfigconfignew config

SetApmConfig(OdinApmConfig)

Set native audio processing config

Declaration
NativeBindings.OdinError SetApmConfig(NativeBindings.OdinApmConfig config)
Returns

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

Parameters
TypeNameDescription
OdinNative.Core.Imports.NativeBindings.OdinApmConfigconfignative config

SetVadConfig(OdinVadConfig)

Set native voice activity config

Declaration
NativeBindings.OdinError SetVadConfig(NativeBindings.OdinVadConfig config)
Returns

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

Parameters
TypeNameDescription
OdinNative.Core.Imports.NativeBindings.OdinVadConfigconfignew config

UpdateApmPlayback(float[], ulong)

Send samples for native audio stream reverse processing

Declaration
NativeBindings.OdinError UpdateApmPlayback(float[] audio, ulong msDelay)
Returns

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

Parameters
TypeNameDescription
System.Single[]audiosamples
System.UInt64msDelaydelay in ms