Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


GetOutputData

Deprecated Version. Returns a block of the currently playing source's output data.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.AudioModule

GetOutputData(int, int)

Deprecated Version. Returns a block of the currently playing source's output data.
Warning
Deprecated. GetOutputData returning a float[] is deprecated, use GetOutputData and pass a pre allocated array instead.
public float[] GetOutputData(int numSamples, int channel)

Parameters

numSamples


channel

Returns

Type

Description

float[]

Remarks

This variation of the function allocates a new array each time it is called. Use the Non-alloc version instead for better performance.

GetOutputData(float[], int)

Provides a block of the currently playing source's output data.
public void GetOutputData(float[] samples, int channel)

Parameters

samples

The array to populate with audio samples. Its length must be a power of 2.

channel

The channel to sample from.

Remarks

The array given in the samples parameter will be filled with the requested data.
AudioSource.GetOutputData
provides access to audio data from a short history window (for example, the last few milliseconds) for analysis purposes. Unity doesn't automatically allocate the buffers required to store this history because doing so would be expensive and memory-intensive. Instead, Unity only allocates buffers and starts to record when you first call this function, on a per-object basis. As a result, the output data will initially be empty until the engine processes sufficient audio to populate the buffer. Please note this function isn't suited for critical or chronological, real-time data analysis or processing, or scenarios where you require low latency.