Version: 5.6 (switch to 2017.1b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

AudioSource.GetOutputData

Other Versions
Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public function GetOutputData(samples: float[], channel: int): void;
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.

Description

Provides a block of the currently playing source's output data.

The array given in the samples parameter will be filled with the requested data.

See Also: AudioSource.GetSpectrumData, AudioListener.GetSpectrumData, AudioListener.GetOutputData.

Obsolete public function GetOutputData(numSamples: int, channel: int): float[];
Obsolete public float[] GetOutputData(int numSamples, int channel);

Description

Deprecated Version. Returns a block of the currently playing source's output data.

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

Leave Feedback

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.

Copyright © 2017 Unity Technologies. Publication: 5.6-001M. Built: 2017-06-19.
Tutorials Community Answers Knowledge Base Forums Asset Store