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
m
m (Corrected cargo_store call)
 
(54 intermediate revisions by 6 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>{{#ifeq:{{#var:section}}|Input|{{#vardefine:section|Audio}}|{{#ifeq:{{NAMESPACE}}||[[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 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 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>
}}
+
 
 +
<!-- Surround sound/speaker configuration -->
 +
<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>
 +
<td class="table-settings-audio-body-rating">{{Tickcross-a-na|{{{surround sound}}}||unnecessary}}</td>
 +
<td class="table-settings-audio-body-notes">{{{surround sound notes|}}}</td>
 +
</tr>
 +
 
 +
<!-- Subtitles - dialogue, cutscenes, etc. -->
 +
<tr class="template-infotable-body table-settings-audio-body-row">
 +
<th scope="row" class="table-settings-audio-body-parameter">Subtitles</th>
 +
<td class="table-settings-audio-body-rating">{{Tickcross-a-na|{{{subtitles}}}||unnecessary}}</td>
 +
<td class="table-settings-audio-body-notes">{{{subtitles notes|}}}</td>
 +
</tr>
  
<!-- Separate sliders for bg/fg, etc. -->
+
<!-- Closed captions -->
{{#if: {{{separate volume|}}} |
+
<tr class="template-infotable-body table-settings-audio-body-row">
! scope="row" {{!}} Separate volume controls
+
<th scope="row" class="table-settings-audio-body-parameter">Closed captions</th>
{{!}} {{Tickcross|{{{separate volume|}}}}}
+
<td class="table-settings-audio-body-rating">{{Tickcross-a-na|{{{closed captions|}}}||unnecessary}}</td>
{{!}} style="text-align: center; padding: 0px 3px;" {{!}}{{{separate volume notes|}}}[[Separate volume controls::{{{separate volume|}}}| ]]
+
<td class="table-settings-audio-body-notes">{{{closed captions notes|}}}</td>
{{!-}}
+
</tr>
}}
 
  
<!-- Speaker configuration (typically surround sound) -->
+
<!-- Silencing audio when the game looses focus -->
{{#if: {{{surround sound|}}} |
+
<tr class="template-infotable-body table-settings-audio-body-row">
! scope="row" {{!}} Surround sound
+
<th scope="row" class="table-settings-audio-body-parameter">Mute on focus lost</th>
{{!}} {{Tickcross|{{{surround sound|}}}}}
+
<td class="table-settings-audio-body-rating">{{Tickcross-a|{{{mute on focus lost}}}||unnecessary}}</td>
{{!}} style="text-align: center; padding: 0px 3px;" {{!}}{{{surround sound notes|}}}[[Surround sound::{{{surround sound|}}}| ]]
+
<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>
}}
 
  
<!-- General subtitles (dialogue) -->
+
<!-- EAX support - ignored if not present/false -->
{{#if: {{{subtitles|}}} |
+
{{#if: {{{eax support|}}} |
! scope="row" {{!}} Subtitles
+
{{#ifeq: {{{eax support|}}} | false ||
{{!}} {{Tickcross|{{{subtitles|}}}}}
+
{{#ifeq: {{{eax support|}}} | unknown ||
{{!}} style="text-align: center; padding: 0px 3px;" {{!}}{{{subtitles notes|}}}[[Subtitles::{{{subtitles|}}}| ]]
+
<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 notes|}}}}}</td>
 +
<td class="table-settings-audio-body-notes">{{{eax support notes|}}}</td>
 +
</tr>
 +
}}
 +
}}
 
}}
 
}}
  
<!-- Closed captions - all noises and so on -->
+
<!-- Royalty free audio - ignored if not present/false -->
{{#if: {{{closed captions|}}} |
+
{{#if: {{{royalty free audio|}}} |
! scope="row" {{!}} Closed captions
+
<tr class="template-infotable-body table-settings-audio-body-row">
{{!}} {{Tickcross|{{{closed captions|}}}}}
+
<th scope="row" class="table-settings-audio-body-parameter">{{Abbr|Royalty free audio|Also known as 'streamer-friendly audio' as it pertains to the use of audio or music that streamers and content creators are unlikely to receive DMCA strikes for using.}}</th>
{{!}} style="text-align: center; padding: 0px 3px;" {{!}}{{{closed captions notes|}}}[[Closed captions::{{{closed captions|}}}| ]]
+
<td class="table-settings-audio-body-rating">{{Tickcross-a-na-nohack-nolimited|{{{royalty free audio|}}}||unnecessary}}</td>
{{!-}}
+
<td class="table-settings-audio-body-notes">{{{royalty free audio notes|}}}</td>
 +
</tr>
 
}}
 
}}
  
<!-- Silencing audio when the game looses focus - mention if there's any settings -->
+
<!-- CD audio support - only shown in supported situations -->
{{#if: {{{mute on focus lost|}}} |
+
{{#if: {{{red book cd audio|}}} |
! scope="row" {{!}} Mute on focus lost
+
{{#ifeq: {{{red book cd audio|}}}{{{red book cd audio notes|}}} | false ||
{{!}} {{Tickcross|{{{mute on focus lost|}}}}}
+
{{#ifeq: {{{red book cd audio|}}} | unknown ||
{{!}} style="text-align: center; padding: 0px 3px;" {{!}}{{{mute on focus lost notes|}}}[[Mute on focus lost::{{{mute on focus lost|}}}| ]]
+
<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>
 +
}}
 +
}}
 
}}
 
}}
  
<!-- EAX support - ignored if not present/false -->
+
<!-- General MIDI support -->
{{#ifeq: {{{eax support|}}} | false | |
+
{{#if: {{{general midi audio|}}} |
{{#if: {{{eax support|}}} |
+
{{#ifeq: {{{general midi audio|}}}{{{general midi audio notes|}}} | false ||
! scope="row" {{!}} EAX support
+
{{#ifeq: {{{general midi audio|}}} | unknown ||
{{!}} {{Tickcross|{{{eax support|}}}}}
+
<tr class="template-infotable-body table-settings-audio-body-row">
{{!}} style="text-align: center; padding: 0px 3px;" {{!}}{{{eax support notes|}}}[[EAX support::{{{eax support|}}}| ]]
+
<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>
|}<noinclude>{{Documentation}}</noinclude>
+
</tr>
 +
}}
 +
}}
 +
}}</table></div>{{#if:{{#var:screenshots}}|{{#vardefine:Audio settings screenshots|true}}{{#vardefine:screenshots|}}}}</includeonly><noinclude>{{#cargo_declare:
 +
_table=Audio
 +
|Separate_volume_controls=String
 +
|Surround_sound=String
 +
|Subtitles=String
 +
|Closed_captions=String
 +
|Mute_on_focus_lost=String
 +
|EAX_support=String
 +
|Royalty_free_audio=String
 +
|Red_Book_CD_audio=String
 +
|General_MIDI_audio=String
 +
}}</noinclude><includeonly>{{#if:{{#var:Game}}|{{#cargo_store:
 +
_table=Audio
 +
|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|}}}
 +
|Royalty_free_audio={{{royalty free audio|}}}
 +
|Red_Book_CD_audio={{{red book cd audio|}}}
 +
|General_MIDI_audio={{{general midi audio|}}}
 +
}}|}}</includeonly><noinclude>{{Documentation}}</noinclude>

Latest revision as of 23:00, 21 April 2023

This template defines the table "Audio". View table.

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