diff options
| author | Benjamin Armstrong <ben@avsoftlabs.com> | 2021-11-12 16:10:06 +1100 |
|---|---|---|
| committer | Benjamin Armstrong <ben@avsoftlabs.com> | 2021-11-12 16:14:42 +1100 |
| commit | 1e485a7da83a132598e8e76810305b3b094e41ad (patch) | |
| tree | b68345d1cb5754533cccc9250d9252f5dc8729a9 /doc | |
| parent | 1aa3c8419b2405d81d04f4fb3ac142fcd355de85 (diff) | |
Clarify how 'audio/driver/output_latency' project setting works
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 80ef73d824..abdd8138ad 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -289,7 +289,9 @@ Safer override for [member audio/driver/mix_rate] in the Web platform. Here [code]0[/code] means "let the browser choose" (since some browsers do not like forcing the mix rate). </member> <member name="audio/driver/output_latency" type="int" setter="" getter="" default="15"> - Output latency in milliseconds for audio. Lower values will result in lower audio latency at the cost of increased CPU usage. Low values may result in audible cracking on slower hardware. + Specifies the preferred output latency in milliseconds for audio. Lower values will result in lower audio latency at the cost of increased CPU usage. Low values may result in audible cracking on slower hardware. + Audio output latency may be constrained by the host operating system and audio hardware drivers. If the host can not provide the specified audio output latency then Godot will attempt to use the nearest latency allowed by the host. As such you should always use [method AudioServer.get_output_latency] to determine the actual audio output latency. + [b]Note:[/b] This setting is ignored on all versions of Windows prior to Windows 10. </member> <member name="audio/driver/output_latency.web" type="int" setter="" getter="" default="50"> Safer override for [member audio/driver/output_latency] in the Web platform, to avoid audio issues especially on mobile devices. |