m (→Examples) |
m (Nevermind, that just adds more confusion) |
||
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 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}}. 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. |
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 == |
== Usage == |
||
{{T|Audio|1|2|no-fallback{{=}}|allow-preload{{=}}}} |
{{T|Audio|1|2|no-fallback{{=}}|allow-preload{{=}}}} |
||
Line 11: | Line 11: | ||
"1": { |
"1": { |
||
"label": "Primary audio file", |
"label": "Primary audio file", |
||
"description": "Name of the primary audio file |
"description": "Name of the primary audio file, without \"File:\".", |
||
"type": "string", |
"type": "string", |
||
"required": true |
"required": true |
||
Line 40: | Line 40: | ||
! Template code !! Generates |
! Template code !! Generates |
||
|- |
|- |
||
| '''Typical usage'''<br>{{T|Audio|Elevator Jam}} || {{Audio|Elevator Jam}} |
| '''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}} |
| '''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|allow-preload{{=}}1}} || {{Audio|Item Shimmer|allow-preload{{=}}1}} |
| '''Preloading allowed'''<br>{{T|Audio|Item Shimmer.ogg|allow-preload{{=}}1}} || {{Audio|Item Shimmer.ogg|allow-preload{{=}}1}} |
||
|} |
|} |
Revision as of 22:02, 1 June 2024
This template enhances the regular audio embed with automatic fallback using multiple <source>
elements, 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|
. 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.
Elevator Jam.ogg
}}
Usage
{{Audio|
1
|2
|no-fallback=
|allow-preload=
}}
Parameters
No description.
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. By default, this is the primary file with .mp3 appended.
| 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, 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. | Boolean | optional |
Examples
Template code | Generates |
---|---|
Typical usage{{Audio| |
Play (MP3) }}{{#var: audio-no-js-text}} |
MP3 file{{Audio| |
Play }}{{#var: audio-no-js-text}} |
Preloading allowed{{Audio| |
Play (MP3) }}{{#var: audio-no-js-text}} |