Documentation
Kitchen Sink documentation of style: 'Delos' of skin: 'ILIAS'
Audio
Description
- Purpose
- The Audio component is used to play and control an mp3 audio source.
- Composition
- The Audio component is composed by the default Player controls. Additionally it optionally provides a transcript Button that opens a Modal showing the transcription of the audio file.
- Context
- Listing Items in Panels
Rules
- Accessibility
- A transcript text SHOULD be provided, if the audio content contains speech. This mainly adresses the "Text Alternatives" accessibility guideline, for details visit: https://github.com/ILIAS-eLearning/ILIAS/blob/trunk/docs/development/accessibility.md#guideline-text-alternatives
Example 1: Base
<?php declare(strict_types=1); /** * This file is part of ILIAS, a powerful learning management system * published by ILIAS open source e-Learning e.V. * * ILIAS is licensed with the GPL-3.0, * see https://www.gnu.org/licenses/gpl-3.0.en.html * You should have received a copy of said license along with the * source code, too. * * If this is not the case or you just want to try ILIAS, you'll find * us at: * https://www.ilias.de * https://github.com/ILIAS-eLearning * *********************************************************************/ namespace ILIAS\UI\examples\Player\Audio; function base() { global $DIC; $renderer = $DIC->ui()->renderer(); $f = $DIC->ui()->factory(); $audio = $f->player()->audio("https://files.ilias.de/ks/ILIAS-Audio.mp3", "Erster Gesang: Pest im Lager. Zorn des Achilleus. Singe vom Ingrimm, Göttin, des Peleus-Sohnes Achilleus, vom Verfluchten, der zahllose Schmerzen schuf den Archaiern und viele kraftvolle Seelen der Helden vorwarf dem Hades..."); return $renderer->render($audio); }
Relations
- Parents
- UIComponent
- Player