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

Difference between revisions of "Template:Audio"

From PCGamingWiki, the wiki about fixing PC games
(updated ratings support)
(removed Semantic MediaWiki tickcross property tagging (migrated to Cargo))
(23 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<includeonly><div class="container-pcgwikitable"><table class="pcgwikitable template-infotable" id="table-settings-audio">
+
<includeonly><span id="Audio settings"></span>{{#ifeq:{{#var:section}}|Input|{{#vardefine:section|Audio}}|[[Category:Invalid section order]]}}{{#vardefine:Audio|present}}<div class="container-pcgwikitable"><table class="pcgwikitable template-infotable" id="table-settings-audio">
<tr class="template-infotable-head">
+
<tr class="template-infotable-head table-settings-audio-head-row">
<th scope="col" style="width: 230px;">Audio options</th>
+
<th scope="col" style="width: 230px;" class="table-settings-audio-head-parameter">Audio feature</th>
<th scope="col" style="width: 50px;">Native</th>
+
<th scope="col" style="width: 50px;" class="table-settings-audio-head-rating">State</th>
<th scope="col" style="width: 540px;">Notes</th>
+
<th scope="col" style="width: 540px;" class="table-settings-audio-head-notes">Notes</th>
 
</tr>
 
</tr>
  
 
<!-- Separate volume - controls for music, effects, etc. -->
 
<!-- Separate volume - controls for music, effects, etc. -->
<tr class="template-infotable-body">
+
<tr class="template-infotable-body table-settings-audio-body-row">
<th scope="row">Separate volume controls</th>
+
<th scope="row" class="table-settings-audio-body-parameter">Separate volume controls</th>
<td>{{Tickcross|{{{separate volume}}}|Separate volume controls|section=Audio}}</td>
+
<td class="table-settings-audio-body-rating">{{Tickcross|{{{separate volume}}}||{{{separate volume notes|}}}}}</td>
<td>{{{separate volume notes|}}}</td>
+
<td class="table-settings-audio-body-notes">{{{separate volume notes|}}}</td>
 
</tr>
 
</tr>
  
 
<!-- Surround sound/speaker configuration -->
 
<!-- Surround sound/speaker configuration -->
<tr class="template-infotable-body">
+
<tr class="template-infotable-body table-settings-audio-body-row">
<th scope="row">Surround sound</th>
+
<th scope="row" class="table-settings-audio-body-parameter">[[Glossary:Surround sound|Surround sound]]</th>
<td>{{Tickcross-na|{{{surround sound}}}|Surround sound|section=Audio}}</td>
+
<td class="table-settings-audio-body-rating">{{Tickcross-a-na|{{{surround sound}}}||unnecessary}}</td>
<td>{{{surround sound notes|}}}</td>
+
<td class="table-settings-audio-body-notes">{{{surround sound notes|}}}</td>
 
</tr>
 
</tr>
  
 
<!-- Subtitles - dialogue, cutscenes, etc. -->
 
<!-- Subtitles - dialogue, cutscenes, etc. -->
<tr class="template-infotable-body">
+
<tr class="template-infotable-body table-settings-audio-body-row">
<th scope="row">Subtitles</th>
+
<th scope="row" class="table-settings-audio-body-parameter">Subtitles</th>
<td>{{Tickcross-na|{{{subtitles}}}|Subtitles|section=Audio}}</td>
+
<td class="table-settings-audio-body-rating">{{Tickcross-a-na|{{{subtitles}}}||unnecessary}}</td>
<td>{{{subtitles notes|}}}</td>
+
<td class="table-settings-audio-body-notes">{{{subtitles notes|}}}</td>
 
</tr>
 
</tr>
  
 
<!-- Closed captions -->
 
<!-- Closed captions -->
{{#if: {{{closed captions|}}} |
+
<tr class="template-infotable-body table-settings-audio-body-row">
<tr class="template-infotable-body">
+
<th scope="row" class="table-settings-audio-body-parameter">Closed captions</th>
<th scope="row">Closed captions</th>
+
<td class="table-settings-audio-body-rating">{{Tickcross-a-na|{{{closed captions|}}}||unnecessary}}</td>
<td>{{Tickcross-na|{{{closed captions|}}}|Closed captions|section=Audio}}</td>
+
<td class="table-settings-audio-body-notes">{{{closed captions notes|}}}</td>
<td>{{{closed captions notes|}}}</td>
 
 
</tr>
 
</tr>
}}
 
  
 
<!-- Silencing audio when the game looses focus -->
 
<!-- Silencing audio when the game looses focus -->
<tr class="template-infotable-body">
+
<tr class="template-infotable-body table-settings-audio-body-row">
<th scope="row">Mute on focus lost</th>
+
<th scope="row" class="table-settings-audio-body-parameter">Mute on focus lost</th>
<td>{{Tickcross|{{{mute on focus lost}}}|Mute on focus lost|section=Audio}}</td>
+
<td class="table-settings-audio-body-rating">{{Tickcross-a|{{{mute on focus lost}}}||unnecessary}}</td>
<td>{{{mute on focus lost notes|}}}</td>
+
<td class="table-settings-audio-body-notes">{{#if: {{{mute on focus lost notes|}}} | {{{mute on focus lost notes|}}} | {{#ifeq: {{{mute on focus lost|}}} | false | {{#if: {{#var:DOS}}{{#var:PC booter}} | ''For [[DOSBox]] change the {{code|priority}} background value in the [https://www.dosbox.com/wiki/Dosbox.conf#.5Bsdl.5D DOSBox configuration file].''}}}}}}</td>
 
</tr>
 
</tr>
  
 
<!-- 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">
+
<th scope="row" class="table-settings-audio-body-parameter">EAX support</th>
<th scope="row">EAX support</th>
+
<td class="table-settings-audio-body-rating">{{Tickcross|{{{eax support|}}}||{{{eax support notes|}}}}}</td>
<td>{{Tickcross|{{{eax support|}}}|EAX support}}</td>
+
<td class="table-settings-audio-body-notes">{{{eax support notes|}}}</td>
<td>{{{eax support notes|}}}</td>
+
</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 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>
 
</tr>
 
}}
 
}}
 +
}}
 +
}}
 +
 +
<!-- General MIDI support -->
 +
{{#if: {{{general midi audio|}}} |
 +
{{#ifeq: {{{general midi audio|}}}{{{general midi audio notes|}}} | false ||
 +
{{#ifeq: {{{general midi audio|}}} | unknown ||
 +
<tr class="template-infotable-body table-settings-audio-body-row">
 +
<th scope="row" class="table-settings-audio-body-parameter">{{abbr|General MIDI audio|General MIDI (also known as GM or GM 1) is a standardized specification for electronic musical instruments that respond to MIDI messages. Not to be confused with MIDI which is a general term for storing musical information as data}}</th>
 +
<td class="table-settings-audio-body-rating">{{Tickcross|{{{general midi audio|}}}||{{{general midi audio notes|}}}}}</td>
 +
<td class="table-settings-audio-body-notes">{{{general midi audio notes|}}}</td>
 +
</tr>
 
}}
 
}}
 
}}
 
}}
}}<!-- Hidden property
+
}}</table></div>{{#if:{{#var:screenshots}}|{{#vardefine:Audio settings screenshots|true}}{{#vardefine:screenshots|}}}}</includeonly><noinclude>{{#cargo_declare:
-->[[PCGWR Audio::{{#var_final:PCGWR Audio}}| ]]<!--
+
_table=Audio_settings
-->[[PCGWR Audio known::{{#var_final:PCGWR Audio known}}| ]]<!--
+
|Separate_volume_controls=String
-->[[PCGWR Audio unknown::{{#var_final:PCGWR Audio unknown}}| ]]<!--
+
|Surround_sound=String
--></table></div></includeonly><noinclude>{{Documentation}}</noinclude>
+
|Subtitles=String
 +
|Closed_captions=String
 +
|Mute_on_focus_lost=String
 +
|EAX_support=String
 +
|Red_Book_CD_audio=String
 +
|General_MIDI_audio=String
 +
}}</noinclude><includeonly>{{#if:{{#var:Game}}|{{#cargo_store:
 +
_table=Audio_settings
 +
|Separate_volume_controls={{{separate volume|}}}
 +
|Surround_sound={{{surround sound|}}}
 +
|Subtitles={{{subtitles|}}}
 +
|Closed_captions={{{closed captions|}}}
 +
|Mute_on_focus_lost={{{mute on focus lost|}}}
 +
|EAX_support={{{eax support|}}}
 +
|Red_Book_CD_audio={{{red book cd audio|}}}
 +
|General_MIDI_audio={{{general midi audio|}}}
 +
}}|}}</includeonly><noinclude>{{Documentation}}</noinclude>

Revision as of 07:49, 13 September 2021

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  = 
}}