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
m
(added Red Book CD audio support)
(43 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{| id="input-settings-tableclass="slottable wikitable" style="text-align: center; width: 720px;"  
+
<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">
! scope="col" width="230" | Audio options
+
<th scope="col" style="width: 230px;" class="table-settings-audio-head-parameter">Audio feature</th>
! scope="col" width="46" | Native
+
<th scope="col" style="width: 50px;" class="table-settings-audio-head-rating">State</th>
! scope="col" width="444" | Notes
+
<th scope="col" style="width: 540px;" class="table-settings-audio-head-notes">Notes</th>
|-
+
</tr>
  
<!-- General volume control -->
+
<!-- Separate volume - controls for music, effects, etc. -->
{{#if: {{{volume control|}}} |
+
<tr class="template-infotable-body table-settings-audio-body-row">
! scope="row" {{!}} Volume control
+
<th scope="row" class="table-settings-audio-body-parameter">Separate volume controls</th>
{{!}} {{Tickcross|{{{volume control|}}}}}
+
<td class="table-settings-audio-body-rating">{{Tickcross|{{{separate volume}}}|Separate volume controls|{{{separate volume notes|}}}}}</td>
{{!}} style="text-align: center; padding: 0px 3px;" {{!}}{{{volume control notes|}}}[[Volume control::{{{volume control|}}}| ]]
+
<td class="table-settings-audio-body-notes">{{{separate volume notes|}}}</td>
{{!-}}
+
</tr>
}}
 
 
 
<!-- Separate sliders for bg/fg -->
 
{{#if: {{{separate volume|}}} |
 
! scope="row" {{!}} Separate volume settings
 
{{!}} {{Tickcross|{{{separate volume|}}}}}
 
{{!}} style="text-align: center; padding: 0px 3px;" {{!}}{{{separate volume notes|}}}[[Separate volume settings::{{{separate volume|}}}| ]]
 
{{!-}}
 
}}
 
 
 
<!-- Sound quality settings -->
 
{{#if: {{{sound quality|}}} |
 
! scope="row" {{!}} Sound quality settings
 
{{!}} {{Tickcross|{{{sound quality|}}}}}
 
{{!}} style="text-align: center; padding: 0px 3px;" {{!}}{{{sound quality notes|}}}[[Sound quality settings::{{{sound quality|}}}| ]]
 
{{!-}}
 
}}
 
  
<!-- Speaker configuration (typically surround sound) -->
+
<!-- Surround sound/speaker configuration -->
{{#if: {{{speaker configuration|}}} |
+
<tr class="template-infotable-body table-settings-audio-body-row">
! scope="row" {{!}} Speaker configuration
+
<th scope="row" class="table-settings-audio-body-parameter">[[Glossary:Surround sound|Surround sound]]</th>
{{!}} {{Tickcross|{{{speaker configuration|}}}}}
+
<td class="table-settings-audio-body-rating">{{Tickcross-a-na|{{{surround sound}}}|Surround sound|unnecessary}}</td>
{{!}} style="text-align: center; padding: 0px 3px;" {{!}}{{{speaker configuration notes|}}}[[Speaker configuration::{{{speaker configuration|}}}| ]]
+
<td class="table-settings-audio-body-notes">{{{surround sound notes|}}}</td>
{{!-}}
+
</tr>
}}
 
  
<!-- General subtitles (dialogue) -->
+
<!-- Subtitles - dialogue, cutscenes, etc. -->
{{#if: {{{subtitles|}}} |
+
<tr class="template-infotable-body table-settings-audio-body-row">
! scope="row" {{!}} Subtitles
+
<th scope="row" class="table-settings-audio-body-parameter">Subtitles</th>
{{!}} {{Tickcross|{{{subtitles|}}}}}
+
<td class="table-settings-audio-body-rating">{{Tickcross-a-na|{{{subtitles}}}|Subtitles|unnecessary}}</td>
{{!}} style="text-align: center; padding: 0px 3px;" {{!}}{{{subtitles notes|}}}[[Subtitles::{{{subtitles|}}}| ]]
+
<td class="table-settings-audio-body-notes">{{{subtitles notes|}}}</td>
{{!-}}
+
</tr>
}}
 
  
<!-- Closed captions - all noises and so on -->
+
<!-- Closed captions -->
{{#if: {{{closed captions|}}} |
+
<tr class="template-infotable-body table-settings-audio-body-row">
! scope="row" {{!}} Closed captions
+
<th scope="row" class="table-settings-audio-body-parameter">Closed captions</th>
{{!}} {{Tickcross|{{{closed captions|}}}}}
+
<td class="table-settings-audio-body-rating">{{Tickcross-a-na|{{{closed captions|}}}|Closed captions|unnecessary}}</td>
{{!}} style="text-align: center; padding: 0px 3px;" {{!}}{{{closed captions notes|}}}[[Closed captions::{{{closed captions|}}}| ]]
+
<td class="table-settings-audio-body-notes">{{{closed captions notes|}}}</td>
{{!-}}
+
</tr>
}}
 
  
<!-- Silencing audio when the game looses focus - mention if there's any settings -->
+
<!-- Silencing audio when the game looses focus -->
{{#if: {{{silencing on loss|}}} |
+
<tr class="template-infotable-body table-settings-audio-body-row">
! scope="row" {{!}} Sound silencing on loss of focus
+
<th scope="row" class="table-settings-audio-body-parameter">Mute on focus lost</th>
{{!}} {{Tickcross|{{{silencing on loss|}}}}}
+
<td class="table-settings-audio-body-rating">{{Tickcross-a|{{{mute on focus lost}}}|Mute on focus lost|unnecessary}}</td>
{{!}} style="text-align: center; padding: 0px 3px;" {{!}}{{{silencing on loss notes|}}}[[Silencing on loss::{{{silencing on loss|}}}| ]]
+
<td class="table-settings-audio-body-notes">{{{mute on focus lost notes|}}}</td>
{{!-}}
+
</tr>
}}
 
  
<!-- EAX support - ignore if not present -->
+
<!-- EAX support - ignored if not present/false -->
 
{{#if: {{{eax support|}}} |
 
{{#if: {{{eax support|}}} |
! scope="row" {{!}} EAX support
+
{{#ifeq: {{{eax support|}}} | false ||
{{!}} {{Tickcross|{{{eax support|}}}}}
+
{{#ifeq: {{{eax support|}}} | unknown ||
{{!}} style="text-align: center; padding: 0px 3px;" {{!}}{{{eax support notes|}}}[[EAX support::{{{eax support|}}}| ]]
+
<tr class="template-infotable-body table-settings-audio-body-row">
 +
<th scope="row" class="table-settings-audio-body-parameter">EAX support</th>
 +
<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>
 +
</tr>
 +
}}
 +
}}
 
}}
 
}}
|}<noinclude>{{Documentation}}</noinclude>
+
 
 +
<!-- 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>
 +
}}
 +
}}
 +
}}</table></div>{{#if:{{#var:screenshots}}|{{#vardefine:Audio settings screenshots|true}}{{#vardefine:screenshots|}}}}</includeonly><noinclude>{{#cargo_declare:
 +
_table=Audio_settings
 +
|Separate_volume_controls=String
 +
|Surround_sound=String
 +
|Subtitles=String
 +
|Closed_captions=String
 +
|Mute_on_focus_lost=String
 +
|EAX_support=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|}}}
 +
}}|}}</includeonly><noinclude>{{Documentation}}</noinclude>

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