Skip to main content
Version: 2.x

Class PiplineEffect

Assembly: cs.temp.dll.dll
Declaration
public abstract class PiplineEffect : IPiplineEffect

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

Implements:
OdinNative.Wrapper.Media.IPiplineEffect

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 OdinError GetEffectIndex(out uint indexId)
Returns

Odin.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
public virtual OdinError GetEffectType(out NativeBindings.OdinEffectType effectType)
Returns

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

Parameters
TypeNameDescription
Odin.NativeBindings.OdinEffectTypeeffectTypenative type

GetVadConfig(out OdinVadConfig)

Get native voice activity config

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

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

Parameters
TypeNameDescription
Odin.NativeBindings.OdinVadConfigconfignative config

SetApmConfig(OdinApmConfig)

Set native audio processing config

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

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

Parameters
TypeNameDescription
Odin.NativeBindings.OdinApmConfigconfignative config

SetApmStreamDelay(ulong)

Set native audio processing delay

Declaration
public virtual OdinError SetApmStreamDelay(ulong ms)
Returns

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

Parameters
TypeNameDescription
System.UInt64msdelay

SetVadConfig(OdinVadConfig)

Set native voice activity config

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

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

Parameters
TypeNameDescription
Odin.NativeBindings.OdinVadConfigconfignew config

UpdateApmPlayback(float[])

Send samples for native audio processing

Declaration
public virtual OdinError UpdateApmPlayback(float[] audio)
Returns

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

Parameters
TypeNameDescription
System.Single[]audiosamples

Implements