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


Suggest a change


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.


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.



public uint ConsumeSampleFrames(NativeArray<float> sampleFrames);


sampleFramesBuffer where the consumed samples will be transferred.


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


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: