Anonymous edits have been disabled on the wiki. If you want to contribute please login or create an account.


Warning for game developers: PCGamingWiki staff members will only ever reach out to you using the official press@pcgamingwiki.com mail address.
Be aware of scammers claiming to be representatives or affiliates of PCGamingWiki who promise a PCGW page for a game key.

Difference between revisions of "Template:Audio"

From PCGamingWiki, the wiki about fixing PC games
(added screenshot var support)
(added Red Book CD audio support)
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<includeonly>{{#vardefine:section|Audio_settings}}<div class="container-pcgwikitable"><table class="pcgwikitable template-infotable" id="table-settings-audio">
+
<includeonly><span id="Audio settings"></span>{{#vardefine:section|Audio}}<div class="container-pcgwikitable"><table class="pcgwikitable template-infotable" id="table-settings-audio">
 
<tr class="template-infotable-head table-settings-audio-head-row">
 
<tr class="template-infotable-head table-settings-audio-head-row">
<th scope="col" style="width: 230px;" class="table-settings-audio-head-parameter">Audio options</th>
+
<th scope="col" style="width: 230px;" class="table-settings-audio-head-parameter">Audio feature</th>
<th scope="col" style="width: 50px;" class="table-settings-audio-head-rating">Native</th>
+
<th scope="col" style="width: 50px;" class="table-settings-audio-head-rating">State</th>
 
<th scope="col" style="width: 540px;" class="table-settings-audio-head-notes">Notes</th>
 
<th scope="col" style="width: 540px;" class="table-settings-audio-head-notes">Notes</th>
 
</tr>
 
</tr>
Line 9: Line 9:
 
<tr class="template-infotable-body table-settings-audio-body-row">
 
<tr class="template-infotable-body table-settings-audio-body-row">
 
<th scope="row" class="table-settings-audio-body-parameter">Separate volume controls</th>
 
<th scope="row" class="table-settings-audio-body-parameter">Separate volume controls</th>
<td class="table-settings-audio-body-rating">{{Tickcross|{{{separate volume}}}|Separate volume controls}}</td>
+
<td class="table-settings-audio-body-rating">{{Tickcross|{{{separate volume}}}|Separate volume controls|{{{separate volume notes|}}}}}</td>
 
<td class="table-settings-audio-body-notes">{{{separate volume notes|}}}</td>
 
<td class="table-settings-audio-body-notes">{{{separate volume notes|}}}</td>
 
</tr>
 
</tr>
Line 16: Line 16:
 
<tr class="template-infotable-body table-settings-audio-body-row">
 
<tr class="template-infotable-body table-settings-audio-body-row">
 
<th scope="row" class="table-settings-audio-body-parameter">[[Glossary:Surround sound|Surround sound]]</th>
 
<th scope="row" class="table-settings-audio-body-parameter">[[Glossary:Surround sound|Surround sound]]</th>
<td class="table-settings-audio-body-rating">{{Tickcross-na|{{{surround sound}}}|Surround sound}}</td>
+
<td class="table-settings-audio-body-rating">{{Tickcross-a-na|{{{surround sound}}}|Surround sound|unnecessary}}</td>
 
<td class="table-settings-audio-body-notes">{{{surround sound notes|}}}</td>
 
<td class="table-settings-audio-body-notes">{{{surround sound notes|}}}</td>
 
</tr>
 
</tr>
Line 23: Line 23:
 
<tr class="template-infotable-body table-settings-audio-body-row">
 
<tr class="template-infotable-body table-settings-audio-body-row">
 
<th scope="row" class="table-settings-audio-body-parameter">Subtitles</th>
 
<th scope="row" class="table-settings-audio-body-parameter">Subtitles</th>
<td class="table-settings-audio-body-rating">{{Tickcross-na|{{{subtitles}}}|Subtitles}}</td>
+
<td class="table-settings-audio-body-rating">{{Tickcross-a-na|{{{subtitles}}}|Subtitles|unnecessary}}</td>
 
<td class="table-settings-audio-body-notes">{{{subtitles notes|}}}</td>
 
<td class="table-settings-audio-body-notes">{{{subtitles notes|}}}</td>
 
</tr>
 
</tr>
Line 30: Line 30:
 
<tr class="template-infotable-body table-settings-audio-body-row">
 
<tr class="template-infotable-body table-settings-audio-body-row">
 
<th scope="row" class="table-settings-audio-body-parameter">Closed captions</th>
 
<th scope="row" class="table-settings-audio-body-parameter">Closed captions</th>
<td class="table-settings-audio-body-rating">{{Tickcross-na|{{{closed captions|}}}|Closed captions}}</td>
+
<td class="table-settings-audio-body-rating">{{Tickcross-a-na|{{{closed captions|}}}|Closed captions|unnecessary}}</td>
 
<td class="table-settings-audio-body-notes">{{{closed captions notes|}}}</td>
 
<td class="table-settings-audio-body-notes">{{{closed captions notes|}}}</td>
 
</tr>
 
</tr>
Line 37: Line 37:
 
<tr class="template-infotable-body table-settings-audio-body-row">
 
<tr class="template-infotable-body table-settings-audio-body-row">
 
<th scope="row" class="table-settings-audio-body-parameter">Mute on focus lost</th>
 
<th scope="row" class="table-settings-audio-body-parameter">Mute on focus lost</th>
<td class="table-settings-audio-body-rating">{{Tickcross|{{{mute on focus lost}}}|Mute on focus lost}}</td>
+
<td class="table-settings-audio-body-rating">{{Tickcross-a|{{{mute on focus lost}}}|Mute on focus lost|unnecessary}}</td>
 
<td class="table-settings-audio-body-notes">{{{mute on focus lost notes|}}}</td>
 
<td class="table-settings-audio-body-notes">{{{mute on focus lost notes|}}}</td>
 
</tr>
 
</tr>
Line 43: Line 43:
 
<!-- EAX support - ignored if not present/false -->
 
<!-- EAX support - ignored if not present/false -->
 
{{#if: {{{eax support|}}} |
 
{{#if: {{{eax support|}}} |
{{#ifeq: {{lc:{{{eax support|}}}}} | false ||
+
{{#ifeq: {{{eax support|}}} | false ||
{{#ifeq: {{lc:{{{eax support|}}}}} | no ||
+
{{#ifeq: {{{eax support|}}} | unknown ||
{{#ifeq: {{lc:{{{eax support|}}}}} | unknown ||
 
 
<tr class="template-infotable-body table-settings-audio-body-row">
 
<tr class="template-infotable-body table-settings-audio-body-row">
 
<th scope="row" class="table-settings-audio-body-parameter">EAX support</th>
 
<th scope="row" class="table-settings-audio-body-parameter">EAX support</th>
<td class="table-settings-audio-body-rating">{{Tickcross|{{{eax support|}}}|EAX support}}</td>
+
<td class="table-settings-audio-body-rating">{{Tickcross|{{{eax support|}}}|EAX support|{{{eax support notes|}}}}}</td>
 
<td class="table-settings-audio-body-notes">{{{eax support notes|}}}</td>
 
<td class="table-settings-audio-body-notes">{{{eax support notes|}}}</td>
 
</tr>
 
</tr>
 
}}
 
}}
 +
}}
 +
}}
 +
 +
<!-- CD audio support - only shown in supported situations -->
 +
{{#if: {{{red book cd audio|}}} |
 +
{{#ifeq: {{{red book cd audio|}}}{{{red book cd audio notes|}}} | false ||
 +
{{#ifeq: {{{red book cd audio|}}} | unknown ||
 +
<tr class="template-infotable-body table-settings-audio-body-row">
 +
<th scope="row" class="table-settings-audio-body-parameter">{{abbr|Red Book CD audio|Compact Disc Digital Audio (CD-DA) streamed from the game CD while playing}}</th>
 +
<td class="table-settings-audio-body-rating">{{Tickcross|{{{red book cd audio|}}}|Red Book CD audio|{{{red book cd audio notes|}}}}}</td>
 +
<td class="table-settings-audio-body-notes">{{#if: {{{red book cd audio notes|}}} | {{{red book cd audio notes|}}} | {{#ifeq: {{{red book cd audio|}}} | true | {{#if: {{#var:Windows native}}{{#var:Windows 3.x native}} | ''On Windows, CD music might not play correctly; see the [[Troubleshooting_guide/Audio_problems#CD_music_not_playing|troubleshooting guide]] for solutions.'' }}}}}}</td>
 +
</tr>
 
}}
 
}}
 
}}
 
}}

Revision as of 03:01, 16 May 2020

This template defines the table "Audio_settings". This table has not been created yet.

Documentation for the above template (sometimes hidden from view).
Description

This table is meant to contain all information relating to audio settings and features. If a setting is hackable or requires additional notes, add the information below the table in a header like so:

=== Separate volume controls ===
Fixbox here
...

and make note of it in the table in the following fashion See [[#Separate volume controls|Separate volume controls]]. Any smaller notes can and should be included directly in the table.

A good reference for almost all of the mentioned features are all Valve made games. They include in the audio part of the settings the ability to change the volume separately, change sound quality as well as choose the correct speaker configuration.

Below is a more thorough explanation of each of the possible arguments. Each can be appended with  notes to fill in the information in the Notes column.

Arguments
  • separate volume - whether it is possible to change the volume of each part of the game (e.g. music and speech).
  • surround sound - whether the game surrounds other speaker configurations than 2.0/2.1 and allows the user to pick the correct one.
  • subtitles - whether the game provides subtitles. Set it to n/a if the game has no spoken word.
  • closed captions - whether the game provides closed captions. This is valid for all games that have any sound.
  • mute on focus lost - whether the game silences the sound when the game window looses focus. Mention if it can't be disabled or if it is limited in some way.
  • eax support - whether the game has got EAX support. Ignored if set to false.
  • royalty free audio - whether the game uses royalty free audio.
  • red book cd audio - whether the game uses Red Book CD audio. Ignored if set to false (with no note) or unknown.
  • general midi audio - whether the game uses General MIDI audio. Ignored if set to false (with no note) or unknown.
Syntax
{{Audio
|separate volume           = 
|separate volume notes     = 
|surround sound            = 
|surround sound notes      = 
|subtitles                 = 
|subtitles notes           = 
|closed captions           = 
|closed captions notes     = 
|mute on focus lost        = 
|mute on focus lost notes  = 
|eax support               = 
|eax support notes         = 
|royalty free audio        = 
|royalty free audio notes  = 
|red book cd audio         = 
|red book cd audio notes   = 
|general midi audio        = 
|general midi audio notes  = 
}}