Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

Experimental: this API is experimental and might be changed or removed in the future.

AudioSampleProvider.ConsumeSampleFrames

Other Versions
Leave feedback
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

public method ConsumeSampleFrames(sampleFrames: NativeArray<float>): uint;
public uint ConsumeSampleFrames(NativeArray<float> sampleFrames);

Parameters

sampleFramesBuffer where the consumed samples will be transferred.

Returns

uint How many sample frames were written into the buffer passed in.

Description

Consume sample frames from the internal buffer.

If Experimental.Audio.AudioSampleProvider.enableSilenacePadding is true, then the buffer passed in will be completely filled and padded with silence if there are less sample frames available than what the buffer can accommodate. Otherwise, the extra sample frames in the buffer will be left intact.

Did you find this page useful? Please give it a rating:

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 © 2018 Unity Technologies. Publication: 2018.1-002N. Built: 2018-12-04.
TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information