Class MediaPipeline

Odin audio pipeline

Declaration

public class MediaPipeline

Methods

GetEffects()

Get Pipeline effects collection

Declaration

public ILookup<uint, IPipelineEffect> GetEffects()

Returns

System.Linq.ILookup<System.UInt32,OdinNative.Wrapper.Media.IPipelineEffect>: Get effects mapped by id

InsertEffect(IPipelineEffect)

Declaration

public void InsertEffect(IPipelineEffect effect)

Parameters

Type	Name
OdinNative.Wrapper.Media.IPipelineEffect	effect

GetNextIndex()

Calculate the next available index based on OdinNative.Wrapper.MediaPipeline._Effects entries

Declaration

public uint GetNextIndex()

Returns

System.UInt32: next available index

GetEffectCount()

Get the current effect count of the native pipeline

Declaration

public uint GetEffectCount()

Returns

System.UInt32: count of native registered effects

GetEffectId(uint)

Get the effect id of the native pipeline by index id

Declaration

public uint GetEffectId(uint indexId)

Returns

System.UInt32: effect id

Parameters

Type	Name	Description
System.UInt32	indexId	index id

AddApmEffect(uint, bool, OdinApmConfig)

Insert an APM effect and sets the apm config

Declaration

public ApmEffect AddApmEffect(uint samplerate, bool stereo, NativeBindings.OdinApmConfig config)

Returns

OdinNative.Wrapper.Media.ApmEffect: OdinNative.Wrapper.Media.ApmEffect instance of base OdinNative.Wrapper.Media.PipelineEffect : OdinNative.Wrapper.Media.IPipelineEffect

Parameters

Type	Name	Description
System.UInt32	samplerate	effect playback samplerate
System.Boolean	stereo	effect playback stereo
OdinNative.Core.Imports.NativeBindings.OdinApmConfig	config	configuration settings for apm

InsertApmEffect(uint, uint, bool)

Insert an APM effect to native pipeline

Declaration

public ApmEffect InsertApmEffect(uint indexId, uint samplerate, bool stereo)

Returns

OdinNative.Wrapper.Media.ApmEffect: OdinNative.Wrapper.Media.ApmEffect

Parameters

Type	Name	Description
System.UInt32	indexId	effect index
System.UInt32	samplerate	effect playback samplerate
System.Boolean	stereo	effect playback stereo

AddCustomEffect<T>(PipelineCallback<T>, T)

Insert a custom effect and sets the OdinNative.Wrapper.Media.CustomEffect where T marks Serialize/Deserialize structures

Declaration

public CustomEffect<T> AddCustomEffect<T>(NativeBindings.PipelineCallback<T> callback, T userData) where T : unmanaged

Returns

OdinNative.Wrapper.Media.CustomEffect<T>: OdinNative.Wrapper.Media.CustomEffect instance of base OdinNative.Wrapper.Media.PipelineEffect : OdinNative.Wrapper.Media.IPipelineEffect

Parameters

Type	Name	Description
OdinNative.Core.Imports.NativeBindings.PipelineCallback<T>	callback	effect callback
<T>	userData	effect callback userdata of type T

Type Parameters

Name	Description
T	userdata structure

InsertCustomEffect<T>(uint, OdinCustomEffectCallbackDelegate, nint)

Insert a custom effect to native pipeline

Declaration

public CustomEffect<T> InsertCustomEffect<T>(uint indexId, NativeLibraryMethods.OdinCustomEffectCallbackDelegate callback, nint user_data) where T : unmanaged

Returns

OdinNative.Wrapper.Media.CustomEffect<T>: OdinNative.Wrapper.Media.CustomEffect

Parameters

Type	Name	Description
System.UInt32	indexId	effect index
OdinNative.Core.Imports.NativeLibraryMethods.OdinCustomEffectCallbackDelegate	callback	effect callback
System.IntPtr	user_data	effect callback userdata

Type Parameters

Name	Description
T	userdata structure

AddVadEffect(out VadEffect)

Insert a vad effect

Declaration

public bool AddVadEffect(out VadEffect effect)

Returns

System.Boolean: true on success or false

Parameters

Type	Name	Description
OdinNative.Wrapper.Media.VadEffect	effect	created OdinNative.Wrapper.Media.VadEffect instance or null

InsertVadEffect(uint)

Insert a vad effect to native pipeline

Declaration

public VadEffect InsertVadEffect(uint indexId)

Returns

OdinNative.Wrapper.Media.VadEffect: OdinNative.Wrapper.Media.VadEffect

Parameters

Type	Name	Description
System.UInt32	indexId	effect index

AddViEffect(out ViEffect)

Insert a vi effect

Declaration

public bool AddViEffect(out ViEffect effect)

Returns

System.Boolean: true on success or false

Parameters

Type	Name	Description
OdinNative.Wrapper.Media.ViEffect	effect	created OdinNative.Wrapper.Media.ViEffect instance or null

InsertViEffect(uint)

Insert a vi effect to native pipeline

Declaration

public ViEffect InsertViEffect(uint indexId)

Returns

OdinNative.Wrapper.Media.ViEffect: OdinNative.Wrapper.Media.ViEffect

Parameters

Type	Name	Description
System.UInt32	indexId	effect index

MoveEffect(uint, uint, ref uint)

Moves an effect in the native pipeline to a new index

Declaration

public bool MoveEffect(uint effectId, uint oldIndexId, ref uint newIndexId)

Returns

System.Boolean: true on success or false

Parameters

Type	Name	Description
System.UInt32	effectId	native effect id
System.UInt32	oldIndexId	currently unused
System.UInt32	newIndexId	native index id

RemoveEffect(uint)

Removes an effect from the native pipeline

Declaration

public bool RemoveEffect(uint effectId)

Returns

System.Boolean: true on removed or false

Parameters

Type	Name	Description
System.UInt32	effectId	effect id