Template:Audio/doc: Difference between revisions

Revision as of 22:09, 1 June 2024

This template enhances the regular audio embed with automatic fallback to an MP3, no preloading for faster load times, and no download option. Uses HTML5AudioPlayer.

To use, replace any regular audio embed with this template. For example, [[File:Elevator Jam.ogg]] can be replaced with {{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

{{Audio|1|2|no-fallback=|allow-preload=}}

Parameters

No description.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Primary audio file	`1`	Name of the primary audio file, without "File:".	String	required
Fallback audio file	`2`	Name of the audio file to be played when the primary one fails. Must be a MP3. By default, this is the primary file with ".mp3" appended. Default <primary audio file>.mp3	String	optional
Disable fallback?	`no-fallback`	Disables the fallback functionality. Use if the primary audio file is not an OGG file.	Boolean	optional
Allow preloading?	`allow-preload`	Allows the audio to be embedded when custom JavaScript is not available, such as the mobile skin, at the expense of slower load times. Use if the page has a few audio files or if the audio files are small.	Boolean	optional

Examples

Template code	Generates
Typical usage `{{Audio\|Elevator Jam.ogg}}`	Play (MP3) }}{{#var: audio-no-js-text}}
MP3 file `{{Audio\|Trailer Theme Remix.mp3\|no-fallback=1}}`	Play }}{{#var: audio-no-js-text}}
Preloading allowed `{{Audio\|Item Shimmer.ogg\|allow-preload=1}}`	Play (MP3) }}{{#var: audio-no-js-text}}

@@ Line 1: / Line 1: @@
-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]].
+This template enhances the regular audio embed with automatic fallback to an MP3, 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.
@@ Line 17: / Line 17: @@
 		"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.",
+			"description": "Name of the audio file to be played when the primary one fails. Must be a MP3. By default, this is the primary file with \".mp3\" appended.",
 			"default": "<primary audio file>.mp3",
 			"type": "string"
@@ Line 28: / Line 28: @@
 		"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.",
+			"description": "Allows the audio to be embedded when custom JavaScript is not available, such as the mobile skin, 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"
 		}