Version: 5.5 (switch to 5.6b)
LanguageEnglish
  • C#
  • JS

Script language

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

AudioImporter.SetOverrideSampleSettings

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 function SetOverrideSampleSettings(platform: string, settings: AudioImporterSampleSettings): bool;
public bool SetOverrideSampleSettings(string platform, AudioImporterSampleSettings settings);

Parameters

platform The platform which will have the sample settings overridden.
settings The override settings for the given platform.

Returns

bool Returns true if the settings were successfully overriden. Some setting overrides are not possible for the given platform, in which case false is returned and the settings are not registered.

Description

Sets the override sample settings for the given platform.

For some target platforms, it is desirable to override the audio importer settings to performance or other reasons. This function allows a given platform to have override settings registered.

The options for the platform string are "WebPlayer", "Standalone", "iOS", "Android", "WebGL", "PS4", "PSP2", "XBoxOne", "Samsung TV".

Copyright © 2016 Unity Technologies. Publication 5.5-001B
Tutorials Community Answers Knowledge Base Forums Asset Store