s&box docs
API ReferenceSandbox.Audio

AudioProcessorclass

Takes a bunch of samples and processes them. It's common for these to be chained together. It's also common for the processor to store state between calls.

object→AudioProcessor
Namespace
Sandbox.Audio
Assembly
Sandbox.Engine
Declaration
public abstract class Sandbox.Audio.AudioProcessor

Constructors1

Showing 1 constructors

Methods4

Showing 4 methods

public void Deserialize(System.Text.Json.Nodes.JsonObject node)PUBLIC

ParameterTypeDescription
nodeJsonObject—
Returns:void—

protected virtual void OnDestroy()PROTECTEDVIRTUALLIFECYCLE

Returns:void—

protected virtual void ProcessSingleChannel(Sandbox.Audio.AudioChannel channel, System.Span`1<float> input)PROTECTEDVIRTUAL

ParameterTypeDescription
channelAudioChannel—
inputSpan<float>—
Returns:void—

public System.Text.Json.Nodes.JsonObject Serialize()PUBLIC

Returns:JsonObject—

Properties3

Showing 3 properties

public bool Sandbox.Audio.AudioProcessor.Enabled { get; set; }PUBLICGETSET

Is this processor active?

Returns:bool—

public float Sandbox.Audio.AudioProcessor.Mix { get; set; }PUBLICGETSET

Should we fade the influence of this processor in?

Returns:float—

Current

Previous Page

Enabled

Next Page

On this page

Constructorsprotected AudioProcessor()Methodspublic System.Void Deserialize(System.Text.Json.Nodes.JsonObject node)protected virtual System.Void OnDestroy()protected virtual System.Void ProcessSingleChannel(Sandbox.Audio.AudioChannel channel, System.Span`1<System.Single> input)public System.Text.Json.Nodes.JsonObject Serialize()Propertiespublic System.Boolean Sandbox.Audio.AudioProcessor.Enabled { get; set; }protected Transform Sandbox.Audio.AudioProcessor.Listener { get; set; }public System.Single Sandbox.Audio.AudioProcessor.Mix { get; set; }Metadata