Version: 2023.1
LanguageEnglish
  • C#

AudioImporterSampleSettings

struct in UnityEditor

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

Description

This structure contains a collection of settings used to define how an AudioClip should be imported.

This structure is used with the AudioImporter to define how the AudioClip should be imported and treated during loading within the Scene.

Properties

compressionFormatCompressionFormat defines the compression type that the audio file is encoded to. Different compression types have different performance and audio artifact characteristics.
loadTypeLoadType defines how the imported AudioClip data should be loaded.
preloadAudioDataPreloads audio data of the clip when the clip asset is loaded. When this flag is off, scripts have to call AudioClip.LoadAudioData() to load the data before the clip can be played. Properties like length, channels and format are available before the audio data has been loaded.
qualityAudio compression quality (0-1)Amount of compression. The value roughly corresponds to the ratio between the resulting and the source file sizes.
sampleRateOverrideTarget sample rate to convert to when samplerateSetting is set to OverrideSampleRate.
sampleRateSettingDefines how the sample rate is modified (if at all) of the importer audio file.