Interface IAudioKernelUpdate<TParameters, TProviders, TKernel>

The interface for declaring an update kernel, that is capable of reading/writing to a live, running DSP node in the DSP graph. This can either be used for reading back data asynchronously from the DSP graph, or as a method of changing a DSP node in a way that is not possible using parameters. See UpdateAudioKernel<TAudioKernelUpdate, TParameters, TProviders, TAudioKernel>(TAudioKernelUpdate, DSPNode) or CreateUpdateRequest<TAudioKernelUpdate, TParameters, TProviders, TAudioKernel>(TAudioKernelUpdate, DSPNode, Action<DSPNodeUpdateRequest<TAudioKernelUpdate, TParameters, TProviders, TAudioKernel>>). See also IAudioKernel<TParameters, TProviders> for an in depth description of the the type parameters.

Namespace: Unity.Audio

Syntax

[JobProducerType(typeof(AudioKernelUpdateExtensions.AudioKernelUpdateJobStructProduce<,,, >))]
public interface IAudioKernelUpdate<TParameters, TProviders, TKernel>
    where TParameters : struct, Enum where TProviders : struct, Enum where TKernel : struct, IAudioKernel<TParameters, TProviders>

Type Parameters

Name	Description
TParameters	See IAudioKernel<TParameters, TProviders>
TProviders	See IAudioKernel<TParameters, TProviders>
TKernel	An implementation of IAudioKernel<TParameters, TProviders>

Methods

Update(ref TKernel)

This method is called when you should perform your task of updating the audio kernel. The changes done to the audio kernel or yourself persists. This method is called potentially in a multi threaded context.

Declaration

void Update(ref TKernel audioKernel)

Parameters

Type	Name	Description
TKernel	audioKernel	The audio kernel that you're updating.