Struct 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>>)

Inherited Members

ValueType.ToString()

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Namespace: Unity.Audio

Syntax

public readonly struct DSPNodeUpdateRequest<TAudioKernelUpdate, TParameters, TProviders, TAudioKernel> : IDisposable, IHandle<DSPNodeUpdateRequest<TAudioKernelUpdate, TParameters, TProviders, TAudioKernel>> where TAudioKernelUpdate : struct, IAudioKernelUpdate<TParameters, TProviders, TAudioKernel> where TParameters : struct, Enum where TProviders : struct, Enum where TAudioKernel : struct, IAudioKernel<TParameters, TProviders>

Type Parameters

Name	Description
TAudioKernelUpdate	The type of the IAudioKernelUpdate<TParameters, TProviders, TKernel>
TParameters	The parameters for TAudioKernel
TProviders	The providers for TAudioKernel
TAudioKernel	The audio kernel type for TAudioKernelUpdate

Properties

Done

Whether the request has been completed

Declaration

public readonly bool Done { get; }

Property Value

Type	Description
Boolean

Fence

The JobHandle associated with the request

Declaration

public readonly JobHandle Fence { get; }

Property Value

Type	Description
JobHandle

HasError

Whether the request has encountered an error

Declaration

public readonly bool HasError { get; }

Property Value

Type	Description
Boolean

Node

The DSPNode for the request

Declaration

public readonly DSPNode Node { get; }

Property Value

Type	Description
DSPNode

UpdateJob

The IAudioKernelUpdate<TParameters, TProviders, TKernel> for this request

Declaration

public readonly TAudioKernelUpdate UpdateJob { get; }

Property Value

Type	Description
TAudioKernelUpdate

Valid

Whether this is a valid request for a valid graph

Declaration

public readonly bool Valid { get; }

Property Value

Type	Description
Boolean

Methods

Dispose()

Dispose resources associated with the request

Declaration

public readonly void Dispose()

Implements

IDisposable.Dispose()

Equals(Object)

Whether this request is the same as another instance

Declaration

public override readonly bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj	The other instance to compare

Returns

Type	Description
Boolean

Overrides

ValueType.Equals(Object)

Equals(DSPNodeUpdateRequest<TAudioKernelUpdate, TParameters, TProviders, TAudioKernel>)

Whether this request is the same as another instance

Declaration

public readonly bool Equals(DSPNodeUpdateRequest<TAudioKernelUpdate, TParameters, TProviders, TAudioKernel> other)

Parameters

Type	Name	Description
DSPNodeUpdateRequest<TAudioKernelUpdate, TParameters, TProviders, TAudioKernel>	other	The other instance to compare

Returns

Type	Description
Boolean

GetHashCode()

Returns a unique hash for this request

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
Int32

Overrides

ValueType.GetHashCode()