ProcessorInstance
ProcessorInstance is a handle to the common functionality of a scriptable processor.
Read time 1 minuteLast updated 6 days ago
Definition
- Type: Struct
- Namespace: UnityEngine.Audio
- Assembly: UnityEngine.AudioModule
- Implements: IEquatable<ProcessorInstance>
public readonly struct ProcessorInstance : IEquatable<ProcessorInstance>
Remarks
This could be a GeneratorInstance etc., but with limited structural API available. Use this together with ControlContext to query and send commands to the processor.
Methods
Method | Description |
|---|---|
| Equals | Checks if this instance equals a given object. |
| GetHashCode | Retrieves a hash code based on this instance. |
Operators
Operator | Description |
|---|---|
| operator == | Checks if two instances are equal. |
| operator != | Checks if two instances are not equal. |
Structs
Struct | Description |
|---|---|
| ProcessorInstance.AvailableData | A temporary collection of data available for enumeration. |
| ProcessorInstance.CreationParameters | Additional data and parameters specifying how a ProcessorInstance should be created. |
| ProcessorInstance.Message | A by-reference wrapper around something sent from ControlContext.SendMessage. |
| ProcessorInstance.Pipe | A bi-directional communication system typically between two logical threads. |
| ProcessorInstance.UpdatedDataContext | A context giving access to data that is currently available for the ProcessorInstance this was passed to. |
Enums
Enum | Description |
|---|---|
| ProcessorInstance.Response | A return value from ProcessorInstance.IControl<TRealtime>.OnMessage that lets the message sender know if the message was handled or not. |
| ProcessorInstance.UpdateSetting | Settings controlling how a ProcessorInstance is updated over the course of its lifetime. |
Interfaces
Interface | Description |
|---|---|
| ProcessorInstance.IControl<TRealtime> | Base interface for common functionality of controlling a ProcessorInstance. |
| ProcessorInstance.IRealtime | Base interface for the common processing logic of a ProcessorInstance. |