ControlContext

struct in UnityEngine.Audio

Leave feedback

Implements interfaces:IContext

Suggest a change

Description

Control data communication, scripting-, creation-, destruction- and data query of ProcessorInstances in an audio system.

A ControlContext effectively represents an instance of an audio system, and is responsible for synchronizing efficient and deterministic data communication between a controlling thread and a realtime audio rendering thread. Use ControlContext.builtIn for scripting the shared audio system Unity uses, or use ControlContext.CreateManualControlContext for exercising your own auxillary system.

Static Properties

Property	Description
builtIn	The default provided ControlContext which is used and updated in tandem with Unity's built-in audio system.

Properties

Property	Description
IsSystemWideReconfiguring	Returns true if the audio system is currently performing a system-wide reconfiguration.

Public Methods

Method	Description
AllocateEffect	Allocate a EffectInstance with the specified processor and control state.
AllocateGenerator	Allocate a GeneratorInstance with the specified realtime and control state.
AllocateRootOutput	Allocate a RootOutputInstance with the specified processor and control state.
Configure	Manually reconfigure this GeneratorInstance with the given format.
Destroy	Destroy a GeneratorInstance previously allocated with ControlContext.AllocateGenerator.
Exists	Test whether processorInstance is valid and belongs to this ControlContext.
GetConfiguration	Get the declared configuration generatorInstance runs in.
IsEffect	Test whether processorInstance is an EffectInstance built from a TRealtime and TControl.
IsGenerator	Test whether processorInstance is a GeneratorInstance built from a TRealtime and TControl.
IsRootOutput	Test whether processorInstance is a RootOutputInstance built from a TRealtime and TControl.
SendMessage	Send a message with a piece of data to be immediately evaluated by the ProcessorInstance.IControl<T0>.OnMessage.
Update	Manually update this GeneratorInstance.

Static Methods

Method	Description
CreateManualControlContext	Create a new ControlContext with additional functionality you can drive manually.
WaitForBuiltInQueueFlush	Forcefully wait for any commands created on ControlContext.builtIn or on any derivative objects to have taken effect.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Scripting API