Skip to content

Api > AudioClip > SetData()


AudioClip.SetData(number[] data, number offsetSamples)⚓︎

Set sample data in a clip.

Parameters:⚓︎

Name Type Description
data number[] sample data in a clip to be set.
offsetSamples number Use offsetSamples to write into a random position in the clip

Returns:⚓︎

type Description
boolean boolean stating if the operation was succesful.

Usage⚓︎

---@type AudioClip
local audioclip;

---@type number
local data;

---@type number
local offsetSamples;


local val0 = audioclip.SetData(data, offsetSamples)

Extra Detail⚓︎

The samples should be floats ranging from -1.0f to 1.0f (exceeding these limits will lead to artifacts and undefined behaviour). The sample count is determined by the length of the float array. Use offsetSamples to write into a random 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.

Note that for compressed audio, the sample data can only be set when the Load Type is set to Decompress on Load in the audio importer.