Editing Template:Audio/doc

This template enhances the regular audio embed with automatic fallback using multiple <code><<nowiki/>source></code> elements, no preloading for faster load times, and no download option. Uses [[w:c:dev:HTML5AudioPlayer|HTML5AudioPlayer]].

To use, replace any regular audio embed with this template. For example, <code>[<nowiki/>[File:Elevator Jam.ogg]]</code> can be replaced with {{T|Audio|Elevator Jam.ogg}}. When played, it tries to play [[:File:Elevator Jam.ogg]], falling back to [[:File:Elevator Jam.ogg.mp3]] if OGG files cannot be played in the current browser.
== Usage ==
{{T|Audio|1|2|no-fallback{{=}}|allow-preload{{=}}}}

=== Parameters ===
<templatedata>
{
	"params": {
		"1": {
			"label": "Primary audio file",
			"description": "Name of the primary audio file, without \"File:\".",
			"type": "string",
			"required": true
		},
		"2": {
			"label": "Fallback audio file",
			"description": "Name of the audio file to be played when the primary one fails. By default, this is the primary file with .mp3 appended.",
			"default": "<primary audio file>.mp3",
			"type": "string"
		},
		"no-fallback": {
			"label": "Disable fallback?",
			"description": "Disables the fallback functionality. Use if the primary audio file is not an OGG file.",
			"type": "boolean"
		},
		"allow-preload": {
			"label": "Allow preloading?",
			"description": "Allows the audio to be embedded when custom JavaScript is not available, like on mobile devices, at the expense of slower load times. Use if the page has a few audio files or if the audio files are small.",
			"type": "boolean"
		}
	},
	"format": "inline"
}
</templatedata>

== Examples ==
{| class="wikitable"
! Template code !! Generates
|-
| '''Typical usage'''<br>{{T|Audio|Elevator Jam.ogg}} || {{Audio|Elevator Jam.ogg}}
|-
| '''MP3 file'''<br>{{T|Audio|Trailer Theme Remix.mp3|no-fallback{{=}}1}} || {{Audio|Trailer Theme Remix.mp3|no-fallback=1}}
|-
| '''Preloading allowed'''<br>{{T|Audio|Item Shimmer.ogg|allow-preload{{=}}1}} || {{Audio|Item Shimmer.ogg|allow-preload=1}}
|}