Namespace Unity.Audio

Classes

ParameterDefaultAttribute

Apply to parameter enumerations to initialize a parameter to a default value. IAudioKernel<TParameters, TProviders>

ParameterRangeAttribute

Apply to parameter enumerations to restrict the valid values a parameter can have. IAudioKernel<TParameters, TProviders>

SampleProviderArrayAttribute

Annotate a sample provider enum value as being an array

Structs

AudioOutputHandle

A handle type representing an IAudioOutput

ChannelEnumConverter

Utility class for converting between AudioSpeakerMode, SoundFormat, and channel count

DefaultDSPGraphDriver

A simple IAudioOutput implementation that writes the output from a single graph into the provided output buffer

DSPCommandBlock

DSPCommandBlock provides us with a set of Asynchronous APIs which allows us to schedule batches of DSPGraph commands

DSPConnection

A handle representing a connection between two DSPNodes

DSPGraph

DSPGraph is the low level mixing engine container which provides methods to create DSPNodes and DSPConnections. The DSPNodes and DSPConnections created in a DSPGraph is local to that graph.

DSPNodeUpdateRequest<TAudioKernelUpdate, TParameters, TProviders, TAudioKernel>

Handle for managing an update request registered via CreateUpdateRequest<TAudioKernelUpdate, TParameters, TProviders, TAudioKernel>(TAudioKernelUpdate, DSPNode, Action<DSPNodeUpdateRequest<TAudioKernelUpdate, TParameters, TProviders, TAudioKernel>>)

ExecuteContext<TParameters, TProviders>

A context for execution of DSP nodes, providing I/O operations and information. It is used inside Execute(ref ExecuteContext<TParameters, TProviders>)

ParameterData<TParameter>

Provides methods for retrieving parameter values at a specific time inside a mix. ExecuteContext<TParameters, TProviders> IAudioKernel<TParameters, TProviders>

SampleBuffer

Represents a block of sample frames in a specific data format.

SampleBufferArray

A simple structure representing an array of sample buffers

SampleProvider

A helper for reading samples from a native Unity resource, such as an AudioClip or a VideoPlayer

SampleProviderContainer<TProviders>

A simple container for a DSPNode's sample providers

Interfaces

IAudioKernel<TParameters, TProviders>

The interface for creating an audio kernel ("DSP node") for use in the DSPGraph. An audio kernel has access to audio inputs and outputs (DSPCommandBlock for configuration), and can alter the audio stream. The kernel must be a struct whose memory will be persistent and managed by the DSPGraph.

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.

IAudioOutput

Output job for a DSPGraph