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.
CloseFor 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.
Closedata | Linear buffer of samples to write to the audio clip buffer. |
offsetSamples | Offset from the start of the audio clip at which to begin writing sample data. |
bool
Returns whether all samples were successfully written to the audio clip. This can return false
if offsetSamples
isn't a valid offset within the existing AudioClip, or if the data is empty.
Fills an audio clip with sample data from an array or Span. Overwrites existing data if necessary.
This is useful if you want to use procedural audio and change audio data during runtime. Only use samples with float values ranging from -1.0f to 1.0f. Don't exceed these limits because it can cause artifacts and undefined behavior.
The length of the ReadOnlySpan or float array determines the sample count.
Use the offsetSamples
parameter to write into a certain position in the clip. If the length from the offset is longer than the clip length, the write will wrap around and write the remaining samples from the start of the clip.
For compressed audio files, you can only set the sample data if you set Load Type to Decompress on Load in the Audio Clip importer.
For the best performance, use the Span version because you don't need to allocate managed memory.
Note: The buffer provided contains a float value per sample and per channel. If your audio clip is stereo, the buffer contains interleaved float values for left channel, right channel, etc.
using UnityEngine; using Unity.Collections;
public class Example : MonoBehaviour { // Read all the samples from the clip and halve the gain void Start() { AudioSource audioSource = GetComponent<AudioSource>(); var numSamples = audioSource.clip.samples * audioSource.clip.channels; var samples = new NativeArray<float>(numSamples, Allocator.Temp); audioSource.clip.GetData(samples, 0);
for (int i = 0; i < samples.Length; ++i) { samples[i] = samples[i] * 0.5f; }
audioSource.clip.SetData(samples, 0); } }
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.