MoodleDocs - User contributions [en]

Moodle Workplace releases

2023-12-28T09:42:14Z

Kabalin: Release timestamps

{{Workplace}}
This page lists all official releases of Moodle Workplace, grouped by branch in reverse chronological order.
==Release cycle==
Moodle Workplace is based on top of Moodle LMS. Moodle Workplace releases always follow the Moodle LMS releases. The minors are normally released the next day and the majors are normally released after three-four weeks.

These are the target dates for releases. These dates may vary slightly due to unforeseen circumstances. When the Moodle LMS release is delayed, the Moodle Workplace release is delayed respectively. See also [https://moodledev.io/general/releases Moodle LMS Releases].
{| class="wikitable"
|-
! colspan="2" |<big>Release</big>
! colspan="2" style="background-color:#b7d5e7;" |<big>Moodle Workplace</big>
! colspan="2" |<big>Moodle LMS</big>
|-
! Release type
! Frequency
! style="background-color:#b7d5e7;" | Release
! ! style="background-color:#b7d5e7;" | Includes
! Release
! Includes
|-
| [[Process#Major_release_cycles|Major]] (eg. 3.x)
| 6 monthly
|3-4 weeks after Moodle LMS major
|New features, improvements and bug fixes (Moodle LMS and Workplace)
| April and October
|New features, Improvements and fixes
|-
|[[Process#Stable_maintenance_cycles|Minor]] (Point) (eg. 3.x.y)
| 2 monthly
|1 day after Moodle LMS minor
|Workplace new features, improvements and bug fixes and Moodle LMS fixes
| February, April, June, August, October and December
|Fixes based on the latest major release and never any significant new features or database changes
|}
Starting from 4.1 release, we package two Workplace versions in every release:
* '''Standard version''': no new features in minor releases, this version is supported for bug fixes and security fixes while the corresponding version of LMS is supported
* '''Rolling version''': features are added continuously up until the new major release of LMS, after that it has bug fixes for four more months and then support stops completely (which is approximately 3 months after the next Workplace major release).

[[File:workplace releases timeline.png|frameless|1100x1100px]]
=== End-of-life dates for currently supported releases ===
{| class="wikitable"
|+
!Version
!Latest Release
!Improvements and new features
!Bug fixes
!Security fixes
|-
|4.3 Rolling
|28 December 2023
|22 April 2024
|22 August 2024
|22 August 2024
|-
|4.3
|28 December 2023
|14 October 2024
|14 April 2025
|14 April 2025
|-
|4.2 Rolling
|28 December 2023
|
|13 February 2024
|13 February 2024
|-
|4.2
|28 December 2023
|
|23 April 2024
|8 October 2024
|-
|4.1 LTS
|28 December 2023
|
|12 December 2023
|9 December 2025
|-
|4.0
|13 June 2023
|
|12 December 2023 (only critical)
|12 December 2023
|-
|3.11
|13 June 2023
|
|12 December 2023 (only critical)
|12 December 2023
|}
==Moodle Workplace 4.3 Rolling==
{| class="wikitable"
|-
|-
|
! Date
! Version number
! Moodle LMS release notes
! Moodle Workplace release notes
|-
! Moodle Workplace 4.3
| 9 Nov 2023
| 2023110900
| [https://moodledev.io/general/releases/4.3 Moodle LMS 4.3]
| [https://docs.moodle.org/403/en/Moodle_Workplace_rolling_release_notes Moodle Workplace 4.3 rolling]
|-
! Moodle Workplace 4.3.1
| 12 December 2023
| 2023121200
|[https://moodledev.io/general/releases/4.3/4.3.1 Moodle LMS 4.3.1]
|[https://docs.moodle.org/403/en/Moodle_Workplace_rolling_release_notes#4.3.1_rolling Moodle Workplace 4.3.1 rolling]
|-
!Moodle Workplace 4.3.2
|28 December 2023
|2023122800
|[https://moodledev.io/general/releases/4.3/4.3.2 Moodle LMS 4.3.2]
|[https://docs.moodle.org/403/en/Moodle_Workplace_rolling_release_notes#4.3.2_rolling Moodle Workplace 4.3.2 rolling]
|-
|}
Improvements and new features will end 22 April 2024
Bug fixes and security fixes will end 22 August 2024
==Moodle Workplace 4.3==
{| class="wikitable"
|-
|-
|
! Date
! Version number
! Moodle LMS release notes
! Moodle Workplace release notes
|-
! Moodle Workplace 4.3
| 9 Nov 2023
| 2023110900
| [https://moodledev.io/general/releases/4.3 Moodle LMS 4.3]
| [https://docs.moodle.org/403/en/Moodle_Workplace_release_notes Moodle Workplace 4.3]
|-
! Moodle Workplace 4.3.1
| 12 December 2023
| 2023110910
|[https://moodledev.io/general/releases/4.3/4.3.1 Moodle LMS 4.3.1]
|[https://docs.moodle.org/403/en/Moodle_Workplace_release_notes#4.3.1 Moodle Workplace 4.3.1]
|-
!Moodle Workplace 4.3.2
|28 December 2023
|2023110920
|[https://moodledev.io/general/releases/4.3/4.3.2 Moodle LMS 4.3.2]
|[https://docs.moodle.org/403/en/Moodle_Workplace_release_notes#4.3.2 Moodle Workplace 4.3.2]
|-
|}
Bug fixes will end 8 October 2024
Bug fixes for security issues will end 22 April 2025
==Moodle Workplace 4.2 Rolling==
{| class="wikitable"
|-
|-
|
! Date
! Version number
! Moodle LMS release notes
! Moodle Workplace release notes
|-
! Moodle Workplace 4.2
| 30 May 2023
| 2023053000
| [https://moodledev.io/general/releases/4.2 Moodle LMS 4.2]
| [https://docs.moodle.org/402/en/Moodle_Workplace_rolling_release_notes Moodle Workplace 4.2 rolling]
|-
!Moodle Workplace 4.2.1
|13 June 2023
|2023061300
|[https://moodledev.io/general/releases/4.2/4.2.1 Moodle LMS 4.2.1]
|[https://docs.moodle.org/402/en/Moodle_Workplace_rolling_release_notes#4.2.1 Moodle Workplace 4.2.1 rolling]
|-
!Moodle Workplace 4.2.2
|22 August 2023
|2023082200
|[https://moodledev.io/general/releases/4.2/4.2.2 Moodle LMS 4.2.2]
|[https://docs.moodle.org/402/en/Moodle_Workplace_rolling_release_notes#4.2.2_rolling Moodle Workplace 4.2.2 rolling]
|-
!Moodle Workplace 4.2.3
|10 October 2023
|2023101000
|[https://moodledev.io/general/releases/4.2/4.2.3 Moodle LMS 4.2.3]
|[https://docs.moodle.org/402/en/Moodle_Workplace_rolling_release_notes#4.2.3_rolling Moodle Workplace 4.2.3 rolling]
|-
!Moodle Workplace 4.2.4
|12 December 2023
|2023101010
|[https://moodledev.io/general/releases/4.2/4.2.4 Moodle LMS 4.2.4]
|[https://docs.moodle.org/402/en/Moodle_Workplace_rolling_release_notes#4.2.4_rolling Moodle Workplace 4.2.4 rolling]
|-
!Moodle Workplace 4.2.5
|28 December 2023
|2023101020
|[https://moodledev.io/general/releases/4.2/4.2.5 Moodle LMS 4.2.5]
|[https://docs.moodle.org/402/en/Moodle_Workplace_rolling_release_notes#4.2.5_rolling Moodle Workplace 4.2.5 rolling]
|-
|}
Improvements and new features ended 10 October 2023
Bug fixes and security fixes will end 13 February 2024
==Moodle Workplace 4.2==
{| class="wikitable"
|-
|-
|
! Date
! Version number
! Moodle LMS release notes
! Moodle Workplace release notes
|-
! Moodle Workplace 4.2
| 30 May 2023
| 2023053000
| [https://moodledev.io/general/releases/4.2 Moodle LMS 4.2]
| [https://docs.moodle.org/402/en/Moodle_Workplace_release_notes Moodle Workplace 4.2]
|-
!Moodle Workplace 4.2.1
|13 June 2023
|2023053010
|[https://moodledev.io/general/releases/4.2/4.2.1 Moodle LMS 4.2.1]
|[https://docs.moodle.org/402/en/Moodle_Workplace_release_notes#4.2.1 Moodle Workplace 4.2.1]
|-
!Moodle Workplace 4.2.2
|22 August 2023
|2023053020
|[https://moodledev.io/general/releases/4.2/4.2.2 Moodle LMS 4.2.2]
|[https://docs.moodle.org/402/en/Moodle_Workplace_release_notes#4.2.2 Moodle Workplace 4.2.2]
|-
!Moodle Workplace 4.2.3
|10 October 2023
|2023053030
|[https://moodledev.io/general/releases/4.2/4.2.3 Moodle LMS 4.2.3]
|[https://docs.moodle.org/402/en/Moodle_Workplace_release_notes#4.2.3 Moodle Workplace 4.2.3]
|-
!Moodle Workplace 4.2.4
|12 December 2023
|2023053040
|[https://moodledev.io/general/releases/4.2/4.2.4 Moodle LMS 4.2.4]
|[https://docs.moodle.org/402/en/Moodle_Workplace_release_notes#4.2.4 Moodle Workplace 4.2.4]
|-
!Moodle Workplace 4.2.5
|28 December 2023
|2023053050
|[https://moodledev.io/general/releases/4.2/4.2.5 Moodle LMS 4.2.5]
|[https://docs.moodle.org/402/en/Moodle_Workplace_release_notes#4.2.5 Moodle Workplace 4.2.5]
|-
|}
Bug fixes will end 23 April 2024
Bug fixes for security issues will end 8 October 2024
==Moodle Workplace 4.1 Rolling==
{| class="wikitable"
|-
|-
|
! Date
! Version number
! Moodle LMS release notes
! Moodle Workplace release notes
|-
! Moodle Workplace 4.1
| 11 January 2023
| 2023110100
| [https://moodledev.io/general/releases/4.1 Moodle LMS 4.1]
| [[Moodle Workplace 4.1 release notes|Moodle Workplace 4.1 rolling]]
|-
! Moodle Workplace 4.1.1
| 17 January 2023
| 2023011700
| [https://moodledev.io/general/releases/4.1/4.1.1 Moodle LMS 4.1.1]
| [[Moodle Workplace 4.1 release notes#4.1.1|Moodle Workplace 4.1.1 rolling]]
|-
!Moodle Workplace 4.1.2
|14 March 2023
|2023031400
|[https://moodledev.io/general/releases/4.1/4.1.2 Moodle LMS 4.1.2]
|[[Moodle Workplace 4.1 release notes#4.1.2|Moodle Workplace 4.1.2 rolling]]
|-
!Moodle Workplace 4.1.3
|25 April 2023
|2023042500
|[https://moodledev.io/general/releases/4.1/4.1.3 Moodle LMS 4.1.3]
|[[Moodle Workplace 4.1 release notes#4.1.3|Moodle Workplace 4.1.3 rolling]]
|-
!Moodle Workplace 4.1.4
|13 June 2023
|2023042510
|[https://moodledev.io/general/releases/4.1/4.1.4 Moodle LMS 4.1.4]
|[[Moodle Workplace 4.1 release notes#4.1.4|Moodle Workplace 4.1.4 rolling]]
|-
!Moodle Workplace 4.1.5
|22 August 2023
|2023042520
|[https://moodledev.io/general/releases/4.1/4.1.5 Moodle LMS 4.1.5]
|[[Moodle Workplace 4.1 release notes#4.1.5|Moodle Workplace 4.1.5 rolling]]
|-
|}
Support has ended
==Moodle Workplace 4.1==
{| class="wikitable"
|-
|-
|
! Date
! Version number
! Moodle LMS release notes
! Moodle Workplace release notes
|-
! Moodle Workplace 4.1 (LTS)
| 11 January 2023
| 2023110100
| [https://moodledev.io/general/releases/4.1 Moodle LMS 4.1]
| [[Moodle Workplace 4.1 release notes|Moodle Workplace 4.1]]
|-
! Moodle Workplace 4.1.1
| 17 January 2023
| 2023011110
| [https://moodledev.io/general/releases/4.1/4.1.1 Moodle LMS 4.1.1]
| [[Moodle Workplace 4.1 release notes#4.1.1|Moodle Workplace 4.1.1]]
|-
!Moodle Workplace 4.1.2
|14 March 2023
|2023011120
|[https://moodledev.io/general/releases/4.1/4.1.2 Moodle LMS 4.1.2]
|[[Moodle Workplace 4.1 release notes#4.1.2|Moodle Workplace 4.1.2]]
|-
!Moodle Workplace 4.1.3
|25 April 2023
|2023011130
|[https://moodledev.io/general/releases/4.1/4.1.3 Moodle LMS 4.1.3]
|[[Moodle Workplace 4.1 release notes#4.1.3|Moodle Workplace 4.1.3]]
|-
!Moodle Workplace 4.1.4
|13 June 2023
|2023011140
|[https://moodledev.io/general/releases/4.1/4.1.4 Moodle LMS 4.1.4]
|[[Moodle Workplace 4.1 release notes#4.1.4|Moodle Workplace 4.1.4]]
|-
!Moodle Workplace 4.1.5
|22 August 2023
|2023011150
|[https://moodledev.io/general/releases/4.1/4.1.5 Moodle LMS 4.1.5]
|[[Moodle Workplace 4.1 release notes#4.1.5|Moodle Workplace 4.1.5]]
|-
!Moodle Workplace 4.1.6
|10 October 2023
|2023011160
|[https://moodledev.io/general/releases/4.1/4.1.6 Moodle LMS 4.1.6]
|[[Moodle Workplace 4.1 release notes#4.1.6|Moodle Workplace 4.1.6]]
|-
!Moodle Workplace 4.1.7
|12 December 2023
|2023011170
|[https://moodledev.io/general/releases/4.1/4.1.7 Moodle LMS 4.1.7]
|[[Moodle Workplace 4.1 release notes#4.1.7|Moodle Workplace 4.1.7]]
|-
!Moodle Workplace 4.1.8
|28 December 2023
|2023011180
|[https://moodledev.io/general/releases/4.1/4.1.8 Moodle LMS 4.1.8]
|[[Moodle Workplace 4.1 release notes#4.1.8|Moodle Workplace 4.1.8]]
|-
|}
Bug fixes in 4.1.x ended 12 December 2023.
Bug fixes for security issues in 4.1.x will end 9 December 2025.
==Moodle Workplace 4.0==
{| class="wikitable"
|-
|-
|
! Date
! Version number
! Moodle LMS release notes
! Moodle Workplace release notes
|-
! Moodle Workplace 4.0
| 14 October 2022
| 2022101400
| [https://moodledev.io/general/releases/4.0 Moodle LMS 4.0], [https://moodledev.io/general/releases/4.0/4.0.1 4.0.1], [https://moodledev.io/general/releases/4.0/4.0.2 4.0.2], [https://moodledev.io/general/releases/4.0/4.0.3 4.0.3], [https://moodledev.io/general/releases/4.0/4.0.4 4.0.4]
| [[Moodle Workplace 4.0 release notes|Moodle Workplace 4.0]]
|-
! Moodle Workplace 4.0.5
| 15 November 2022
| 2022111500
| [https://moodledev.io/general/releases/4.0/4.0.5 Moodle LMS 4.0.5]
| [[Moodle Workplace 4.0 release notes#4.0.5|Moodle Workplace 4.0.5]]
|-
! Moodle Workplace 4.0.6
| 17 January 2023
| 2022112810
| [https://moodledev.io/general/releases/4.0/4.0.6 Moodle LMS 4.0.6]
| [[Moodle Workplace 4.0 release notes#4.0.6|Moodle Workplace 4.0.6]]
|-
!Moodle Workplace 4.0.7
|14 March 2023
|2022112811
|[https://moodledev.io/general/releases/4.0/4.0.7 Moodle LMS 4.0.7]
|[[Moodle Workplace 4.0 release notes#4.0.7|Moodle Workplace 4.0.7]]
|-
!Moodle Workplace 4.0.8
|25 April 2023
|2022112812
|[https://moodledev.io/general/releases/4.0/4.0.8 Moodle LMS 4.0.8]
|[[Moodle Workplace 4.0 release notes#4.0.8|Moodle Workplace 4.0.8]]
|-
!Moodle Workplace 4.0.9
|13 June 2023
|2022112840
|[https://moodledev.io/general/releases/4.0/4.0.9 Moodle LMS 4.0.9]
|[[Moodle Workplace 4.0 release notes#4.0.9|Moodle Workplace 4.0.9]]
|-
!Moodle Workplace 4.0.10
|22 August 2023
|2022112850
|[https://moodledev.io/general/releases/4.0/4.0.10 Moodle LMS 4.0.10]
|[[Moodle Workplace 4.0 release notes#4.0.10|Moodle Workplace 4.0.10]]
|-
!Moodle Workplace 4.0.11
|10 October 2023
|2022112860
|[https://moodledev.io/general/releases/4.0/4.0.11 Moodle LMS 4.0.11]
|[[Moodle Workplace 4.0 release notes#4.0.11|Moodle Workplace 4.0.11]]
|-
!Moodle Workplace 4.0.12
|12 December 2023
|2022112870
|[https://moodledev.io/general/releases/4.0/4.0.12 Moodle LMS 4.0.12]
|
|-
|}
Support has ended
==Moodle Workplace 3.11==
{| class="wikitable"
|-
|-
|
! Date
! Version number
! Moodle LMS release notes
! Moodle Workplace release notes
|-
! Moodle Workplace 3.11
| 8 June 2021
| 2021060800
| [[Moodle 3.11 release notes|Moodle LMS 3.11]]
| [[Moodle Workplace 3.11 release notes|Moodle Workplace 3.11]]
|-
! Moodle Workplace 3.11.1
| 20 July 2021
| 2021072000
| [[Moodle 3.11.1 release notes|Moodle LMS 3.11.1]]
| [[Moodle Workplace 3.11 release notes#3.11.1|Moodle Workplace 3.11.1]]
|-
! Moodle Workplace 3.11.2
| 30 July 2021
| 2021073000
| [[Moodle 3.11.2 release notes|Moodle LMS 3.11.2]]
|
|-
! Moodle Workplace 3.11.3
| 20 September 2021
| 2021092000
| [[Moodle 3.11.3 release notes|Moodle LMS 3.11.3]]
| [[Moodle Workplace 3.11 release notes#3.11.3|Moodle Workplace 3.11.3]]
|-
! Moodle Workplace 3.11.4
| 25 November 2021
| 2021112500
| [[Moodle 3.11.4 release notes|Moodle LMS 3.11.4]]
| [[Moodle Workplace 3.11 release notes#3.11.4|Moodle Workplace 3.11.4]]
|-
! Moodle Workplace 3.11.5
| 18 January 2022
| 2022011800
| [[Moodle 3.11.5 release notes|Moodle LMS 3.11.5]]
| [[Moodle Workplace 3.11 release notes#3.11.5|Moodle Workplace 3.11.5]]
|-
!Moodle Workplace 3.11.6
|15 March 2022
|2022031500
|[[Moodle 3.11.6 release notes|Moodle LMS 3.11.6]]
|[[Moodle Workplace 3.11 release notes#3.11.6|Moodle Workplace 3.11.6]]
|-
! Moodle Workplace 3.11.7
| 10 May 2022
| 2022031610
| [[Moodle 3.11.7 release notes|Moodle LMS 3.11.7]]
| [[Moodle Workplace 3.11 release notes#3.11.7|Moodle Workplace 3.11.7]]
|-
! Moodle Workplace 3.11.8
| 12 July 2022
| 2022031620
| [[Moodle 3.11.8 release notes|Moodle LMS 3.11.8]]
| [[Moodle Workplace 3.11 release notes#3.11.8|Moodle Workplace 3.11.8]]
|-
! Moodle Workplace 3.11.9
| 23 August 2022
| 2022031630
| [https://moodledev.io/general/releases/3.11/3.11.9 Moodle LMS 3.11.9]
| [[Moodle Workplace 3.11 release notes#3.11.9|Moodle Workplace 3.11.9]]
|-
! Moodle Workplace 3.11.10
| 13 September 2022
| 2022031640
| [https://moodledev.io/general/releases/3.11/3.11.10 Moodle LMS 3.11.10]
| [[Moodle Workplace 3.11 release notes#3.11.10|Moodle Workplace 3.11.10]]
|-
!Moodle Workplace 3.11.11
|15 November 2022
|2022031650
|[https://moodledev.io/general/releases/3.11/3.11.11 Moodle LMS 3.11.11]
|[[Moodle Workplace 3.11 release notes#3.11.11|Moodle Workplace 3.11.11]]
|-
!Moodle Workplace 3.11.12
|17 January 2023
|2022031660
|[https://moodledev.io/general/releases/3.11/3.11.12 Moodle LMS 3.11.12]
|[[Moodle Workplace 3.11 release notes#3.11.12|Moodle Workplace 3.11.12]]
|-
!Moodle Workplace 3.11.13
|14 March 2023
|2022031670
|[https://moodledev.io/general/releases/3.11/3.11.13 Moodle LMS 3.11.13]
|[[Moodle Workplace 3.11 release notes#3.11.13|Moodle Workplace 3.11.13]]
|-
!Moodle Workplace 3.11.14
|25 April 2023
|2022031680
|[https://moodledev.io/general/releases/3.11/3.11.14 Moodle LMS 3.11.14]
|[[Moodle Workplace 3.11 release notes#3.11.14|Moodle Workplace 3.11.14]]
|-
!Moodle Workplace 3.11.15
|13 June 2023
|2022031690
|[https://moodledev.io/general/releases/3.11/3.11.15 Moodle LMS 3.11.15]
|
|-
!Moodle Workplace 3.11.16
|22 August 2023
|2022031700
|[https://moodledev.io/general/releases/3.11/3.11.16 Moodle LMS 3.11.16]
|
|-
!Moodle Workplace 3.11.17
|10 October 2023
|2022031710
|[https://moodledev.io/general/releases/3.11/3.11.17 Moodle LMS 3.11.17]
|
|-
!Moodle Workplace 3.11.18
|12 December 2023
|2022031720
|[https://moodledev.io/general/releases/3.11/3.11.18 Moodle LMS 3.11.18]
|
|}
Support has ended
==Moodle Workplace 3.10==
{| class="wikitable"
|-
|-
|
! Date
! Version number
! Moodle LMS release notes
! Moodle Workplace release notes
|-
! Moodle Workplace 3.10
| 1 December 2020
| 2020120100
| [[Moodle 3.10 release notes|Moodle LMS 3.10]]
| [[Moodle Workplace 3.10 release notes#3.10|Moodle Workplace 3.10]]
|-
! Moodle Workplace 3.10.1
| 19 January 2021
| 2021011900
| [[Moodle 3.10.1 release notes|Moodle LMS 3.10.1]]
| [[Moodle Workplace 3.10 release notes#3.10.1|Moodle Workplace 3.10.1]]
|-
! Moodle Workplace 3.10.2
| 9 March 2021
| 2021030800
| [[Moodle 3.10.2 release notes|Moodle LMS 3.10.2]]
| [[Moodle Workplace 3.10 release notes#3.10.2|Moodle Workplace 3.10.2]]
|-
! Moodle Workplace 3.10.3
| 25 March 2021
| 2021032500
| [[Moodle 3.10.3 release notes|Moodle LMS 3.10.3]]
| [[Moodle Workplace 3.10 release notes#3.10.3|Moodle Workplace 3.10.3]]
|-
! Moodle Workplace 3.10.4
| 10 May 2021
| 2021051000
| [[Moodle 3.10.4 release notes|Moodle LMS 3.10.4]]
|
|-
!Moodle Workplace 3.10.5
|13 July 2021
|2021051200
|[[Moodle 3.10.5 release notes|Moodle LMS 3.10.5]]
|
|-
!Moodle Workplace 3.10.6
|30 July 2021
|2021051210
|[[Moodle 3.10.6 release notes|Moodle LMS 3.10.6]]
|
|-
!Moodle Workplace 3.10.7
|16 September 2021
|2021051220
|[[Moodle 3.10.7 release notes|Moodle LMS 3.10.7]]
|
|-
!Moodle Workplace 3.10.8
|17 November 2021
|2021051230
|[[Moodle 3.10.8 release notes|Moodle LMS 3.10.8]]
|
|-
!Moodle Workplace 3.10.9
|18 January 2021
|2021051240
|[[Moodle 3.10.9 release notes|Moodle LMS 3.10.9]]
|
|-
!Moodle Workplace 3.10.10
|15 March 2022
|2021051250
|[[Moodle 3.10.10 release notes|Moodle LMS 3.10.10]]
|
|-
!Moodle Workplace 3.10.11
|10 May 2022
|2021051260
|[[Moodle 3.10.11 release notes|Moodle LMS 3.10.11]]
|
|}
Support has ended
==Moodle Workplace 3.9==
{| class="wikitable"
|-
|-
|
! Date
! Version number
! Moodle LMS release notes
! Moodle Workplace release notes
|-
! Moodle Workplace 3.9
| 30 June 2020
| 2020063000
| [[Moodle 3.9 release notes|Moodle LMS 3.9]]
| [[Moodle Workplace 3.9 release notes#3.9|Moodle Workplace 3.9]]
|-
! Moodle Workplace 3.9.1
| 15 July 2020
| 2020071500
| [[Moodle 3.9.1 release notes|Moodle LMS 3.9.1]]
| [[Moodle Workplace 3.9 release notes#3.9.1|Moodle Workplace 3.9.1]]
|-
! Moodle Workplace 3.9.2
| 24 September 2020
| 2020092400
| [[Moodle 3.9.2 release notes|Moodle LMS 3.9.2]]
| [[Moodle Workplace 3.9 release notes#3.9.2|Moodle Workplace 3.9.2]]
|-
! Moodle Workplace 3.9.3
| 10 November 2020
| 2020111000
| [[Moodle 3.9.3 release notes|Moodle LMS 3.9.3]]
|
|}
Support has ended
==Moodle Workplace 3.8==
{| class="wikitable"
|-
|-
|
! Date
! Version number
! Moodle LMS release notes
! Moodle Workplace release notes
|-
! Moodle Workplace 3.8
| 26 November 2019
| 2019112600
| [[Moodle 3.8 release notes|Moodle LMS 3.8]]
| [[Moodle Workplace 3.8 release notes#3.8|Moodle Workplace 3.8]]
|-
! Moodle Workplace 3.8.1
| 20 January 2020
| 2020012000
| [[Moodle 3.8.1 release notes|Moodle LMS 3.8.1]]
| [[Moodle Workplace 3.8 release notes#3.8.1|Moodle Workplace 3.8.1]]
|-
! Moodle Workplace 3.8.2
| 10 March 2020
| 2020031000
| [[Moodle 3.8.2 release notes|Moodle LMS 3.8.2]]
| [[Moodle Workplace 3.8 release notes#3.8.2|Moodle Workplace 3.8.2]]
|-
! Moodle Workplace 3.8.3
| 12 May 2020
| 2020051200
| [[Moodle 3.8.3 release notes|Moodle LMS 3.8.3]]
|
|-
! Moodle Workplace 3.8.4
| 9 June 2020
| 2020060900
| [[Moodle 3.8.4 release notes|Moodle LMS 3.8.4]]
|
|}
Support has ended
==Moodle Workplace 3.7==
{| class="wikitable"
|-
|-
|
! Date
! Version number
! Moodle LMS release notes
! Moodle Workplace release notes
|-
! Moodle Workplace 3.7 (PR)
| 25 June 2019
| 2019062500
| [[Moodle 3.7 release notes|Moodle LMS 3.7]]
|
|-
! Moodle Workplace 3.7.2
| 10 September 2019
| 2019091000
| [[Moodle 3.7.2 release notes|Moodle LMS 3.7.2]]
|
|-
! Moodle Workplace 3.7.3
| 12 November 2019
| 2019111200
| [[Moodle 3.7.3 release notes|Moodle LMS 3.7.3]]
|
|}
Support has ended

[[Category: Workplace]]
[[Category:Release notes]]

Web services files handling

2021-01-31T15:15:50Z

Kabalin: /* CURL example */

== Summary ==

Since Moodle 2.0, we provide web service functions to upload and download files. They are:

# moodle_file_get_files (Deprecated, use core_files_get_files since moodle 2.2 onward)
# moodle_file_upload (Deprecated, use core_files_upload since moodle 2.2 onward)

File contents are encoded in base64, and for web service transmission, it's not efficient. Mobile devices don't have enough memory to decode/encode web service request/response containing large files.

So we developed some alternative solutions to upload/download files.

== File upload ==

The entry point is ''/webservice/upload.php'', simply use HTTP POST method to upload files, it requires a web service token for authentication. If the upload is successfully, the files will be saved, prior to at least Moodle 2.9 in the user private file area but since in the user draft area. Previously you could force the files to be saved in the draft area by specifying the then optional parameter: ''filearea=draft''. Since at least Moodle 2.9, only two optional parameters are used, ''itemid'' to specify the draft area id – default 0 which is a new draft area - and ''filepath'' default \‘/\’ to specify the file’s path.

It is envisaged the ''itemid'' parameter will be used when the files are uploaded singularly in separate HTTP calls and the files are required to be in the same draft file area. The client retrieves the ''itemid'' of the first uploaded file and uses it in subsequent uploads to specify the files must be saved in the same draft file area.

On every successful upload, the file/s information are returned in JSON format. If an error occurs, an error message will be sent back in JSON format too.

Say, we want to upload <tt>users.csv</tt> from current directory using <tt>curl</tt>:
<code bash>
$ curl -X POST -F "file_1=@users.csv" https://SITENAME/webservice/upload.php?token=TOKEN \
| jq

[
{
"component": "user",
"contextid": 567,
"userid": "123",
"filearea": "draft",
"filename": "users.csv",
"filepath": "/",
"itemid": 880413555,
"license": "allrightsreserved",
"author": "User User",
"source": "O:8:\"stdClass\":1:{s:6:\"source\";s:13:\"users.csv\";}"
}
]
</code>

Once all the files are uploaded, you can call the webservice that accepts files and pass it the ''itemid'' of the draft area containing the list of files for the request. The service can identify the uploads and manipulate them as necessary. An example of a webservice that accepts files is: ''mod_assign_save_submission''.

To accept file uploads, the the service must allow "files download" (''Administration > Plugins > Web services > Manage services > Edit service > Advanced button'')

There is an oldish code example on [https://github.com/moodlehq/sample-ws-clients/tree/master/PHP-HTTP-filehandling code example on Github].

== File download ==
We serve the files through ''/webservice/pluginfile.php''. This script requires a web service token for authentication.

Look at the [https://github.com/moodlehq/sample-ws-clients/tree/master/PHP-HTTP-filehandling code example on Github].

In case of issue, think to check that:
# the service associated with the token allow "''files download''" (''Administration > Plugins > Web services > Manage services > Edit service > Advanced button'')
# the web service is valid

Note: you could notice that ''/webservice/pluginfile.php'' has the exact same stucture than ''/pluginfile.php''. We don't serve the files through ''/pluginfile.php'' for web service clients because this script requires user's login session to work. It's why it might not be an option for web service client.

== Returning files in Web Services ==

Since Moodle 3.2, you can return a complete file area list via Web Services using the static get_area_files method in external_util.

<code php>
$forum->introfiles = external_util::get_area_files($context->id, 'mod_forum', 'intro', false, false);
</code>

You can also use the external_files structure definition in combination with the method to return the most common file fields required by WS clientes.

<code php>
public static function get_forums_by_courses_returns() {
return new external_multiple_structure(
new external_single_structure(
array(
'id' => new external_value(PARAM_INT, 'Forum id'),
....
'introfiles' => new external_files('Files in the introduction text', VALUE_OPTIONAL),
</code>

== See also ==
* [[Web_services|Web services developer documentation]]
* [[:en:Web_services|Web services user documentation]]

[[Category:Web_Services]]

Web services files handling

2021-01-31T15:15:36Z

Kabalin: /* File upload */ add example how to upload using curl

== Summary ==

Since Moodle 2.0, we provide web service functions to upload and download files. They are:

# moodle_file_get_files (Deprecated, use core_files_get_files since moodle 2.2 onward)
# moodle_file_upload (Deprecated, use core_files_upload since moodle 2.2 onward)

File contents are encoded in base64, and for web service transmission, it's not efficient. Mobile devices don't have enough memory to decode/encode web service request/response containing large files.

So we developed some alternative solutions to upload/download files.

== File upload ==

The entry point is ''/webservice/upload.php'', simply use HTTP POST method to upload files, it requires a web service token for authentication. If the upload is successfully, the files will be saved, prior to at least Moodle 2.9 in the user private file area but since in the user draft area. Previously you could force the files to be saved in the draft area by specifying the then optional parameter: ''filearea=draft''. Since at least Moodle 2.9, only two optional parameters are used, ''itemid'' to specify the draft area id – default 0 which is a new draft area - and ''filepath'' default \‘/\’ to specify the file’s path.

It is envisaged the ''itemid'' parameter will be used when the files are uploaded singularly in separate HTTP calls and the files are required to be in the same draft file area. The client retrieves the ''itemid'' of the first uploaded file and uses it in subsequent uploads to specify the files must be saved in the same draft file area.

On every successful upload, the file/s information are returned in JSON format. If an error occurs, an error message will be sent back in JSON format too.

Say, we want to upload <tt>users.csv</tt> from current directory using <tt>curl</tt>:
<code bash>
$ curl -X POST -F "file_1=@users.csv" https://SITENAME/webservice/upload.php?token=TOKEN \
| jq

[
{
"component": "user",
"contextid": 567,
"userid": "123",
"filearea": "draft",
"filename": "users.csv",
"filepath": "/",
"itemid": 880413555,
"license": "allrightsreserved",
"author": "User User",
"source": "O:8:\"stdClass\":1:{s:6:\"source\";s:13:\"users.csv\";}"
}
]
</code>

Once all the files are uploaded, you can call the webservice that accepts files and pass it the ''itemid'' of the draft area containing the list of files for the request. The service can identify the uploads and manipulate them as necessary. An example of a webservice that accepts files is: ''mod_assign_save_submission''.

To accept file uploads, the the service must allow "files download" (''Administration > Plugins > Web services > Manage services > Edit service > Advanced button'')

There is an oldish code example on [https://github.com/moodlehq/sample-ws-clients/tree/master/PHP-HTTP-filehandling code example on Github].

=== CURL example ===

Say your file

== File download ==
We serve the files through ''/webservice/pluginfile.php''. This script requires a web service token for authentication.

Look at the [https://github.com/moodlehq/sample-ws-clients/tree/master/PHP-HTTP-filehandling code example on Github].

In case of issue, think to check that:
# the service associated with the token allow "''files download''" (''Administration > Plugins > Web services > Manage services > Edit service > Advanced button'')
# the web service is valid

Note: you could notice that ''/webservice/pluginfile.php'' has the exact same stucture than ''/pluginfile.php''. We don't serve the files through ''/pluginfile.php'' for web service clients because this script requires user's login session to work. It's why it might not be an option for web service client.

== Returning files in Web Services ==

Since Moodle 3.2, you can return a complete file area list via Web Services using the static get_area_files method in external_util.

<code php>
$forum->introfiles = external_util::get_area_files($context->id, 'mod_forum', 'intro', false, false);
</code>

You can also use the external_files structure definition in combination with the method to return the most common file fields required by WS clientes.

<code php>
public static function get_forums_by_courses_returns() {
return new external_multiple_structure(
new external_single_structure(
array(
'id' => new external_value(PARAM_INT, 'Forum id'),
....
'introfiles' => new external_files('Files in the introduction text', VALUE_OPTIONAL),
</code>

== See also ==
* [[Web_services|Web services developer documentation]]
* [[:en:Web_services|Web services user documentation]]

[[Category:Web_Services]]

Writing acceptance tests

2019-10-31T14:55:00Z

Kabalin: Added icon selector to the list

== Introduction ==

This documentation gives some hints, how to write behat tests for core and for plugins. The focus of the documentation is on behat tests for plugins. They are written in some kind of natural language and describe how the front-end of moodle should behave, when a user interacts with it.

Each test consists of a set of so called steps in a GIVEN, WHEN, THEN style:
* '''GIVEN''': These steps outline the state of your moodle platform at the start of your test. Here you can create users, courses and plugin instances.
* '''WHEN''': These steps usually execute the functionality of your plugin, which is under test.
* '''THEN''': These steps describe the expected behaviour of your plugin. They usually check if different elements can or can't be seen.
This matches the standard [http://xunitpatterns.com/Four%20Phase%20Test.html Four-phase test pattern]. The fourth phase is 'tear-down' which we don't need because Behat automatically cleans up after each test.

To initialize and run your tests, please follow the instructions of [[Running_acceptance_test]].

== Create your own tests ==
Behat tests are located within the directory tests/behat of your plugin.
The different tests are defined in files with the ending *.feature.
First, you have to define the header of your test:
<code behat>
@mod @mod_yourplugin @javascript
Feature: Here comes a description of your user story.
</code>
The tags on top of the feature description can be used to select specific test cases when running the tests.
The '@javascript' tag should only be used, if javascript is needed to execute your test. This is dependent on the step you will use in your definition.
Javascript tests are usually much slower than tests executed without javascript.

Afterwards you can specify a scenario:
<code behat>
@javascript
Scenario: Description of your scenario, which you want to test.
When I log in as "student1"
And I am on "Course 1" course homepage
</code>
Again you can define specific tags. Afterwards you write the steps, which should be executed during your test.

==== Multiple Scenarios ====
You can have an arbitrary amount of scenarios within a test. Please make sure they all belong to the same feature.
If you have certain steps, which should be executed for every scenario of a feature, you can define them using a background:
<code behat>
Background:
Given the following "courses" exist:
| fullname | shortname | category | groupmode |
| Course 1 | C1 | 0 | 1 |
And the following "users" exist:
| username | firstname | lastname | email |
| teacher1 | Theo | Teacher | teacher1@example.com |
</code>
This is usually used, to define the different '''GIVEN''' steps.

==== Use existing steps ====
There are different ways how to effectively browse the available existing steps:

====== Moodle Administration ======
Moodle offers within its administration menu under Site Administration > Development > Acceptance Testing a complete and searchable list of all available step definitions.
However, make sure you installed the behat test site first!

====== PhpStorm ======
In PhpStorm or IntelliJ you can install the behat extension. Then you get auto completions within feature files, which helps a lot during behat test development.

==== Providing values to steps ====
Most of the steps requires values, there are methods to provide values to steps, the method depends on the step specification.

* '''A string/text'''; is the most common case, the texts are wrapped between double quotes (" character) you have to replace the info about the expected value for your value; for example something like '''I press "BUTTON_STRING"''' should become '''I press "Save and return to course"'''. If you want to add a string which contains a " character, you can escape it with \", for example '''I fill the "Name" field with "Alan alias \"the legend\""'''. You can identify this steps because they ends with '''_STRING'''
* '''A number'''; some steps requires numbers as values, to be more specific an undetermined number of digits from 0 to 9 (Natural numbers + 0) you can identify them because the expected value info string ends with '''_NUMBER'''
* '''A table'''; is a relation between values, the most common use of it is to fill forms. The steps which requires tables are easily identifiable because they finish with ''':''' The steps description gives info about what the table columns must contain, for example '''Fills a moodle form with field/value data'''. Here you don't need to escape the double quotes if you want to include them as part of the value.
* '''A PyString'''; is a multiline string, most commonly used to fill out forms when a newline is required. Like steps with tables, steps which require PyStrings will end with ":"
* '''A field value'''; There are many different field types, if an argument requires a field value the expected value will depend on the field type:
** Text-based fields: It expects the text. This includes textareas, input type text, input type password...
** Checkbox: It expects 1 to check and for checked and "" to uncheck or for unchecked
** Select: It expects the option text or the option value. In case you interact with a multi-select you should specify the options separating them with commas. For example: '''option1, option2, option3'''
** Radio: The text of the radio option
* '''A selector'''; there are steps that can be used with different kinds of elements, for example '''I click on "User Name" "link"''' or '''I click on "User Name" "button"''' this is a closed list of elements, they always works together with another argument, where you specify the locator (eg. the link text in a link) In the 'Acceptance testing' interface you can see a drop-down menu to select one of these options:
** field - for searching a field by its id, name, value or label
** link - for searching a link by its href, id, title, img alt or value
** button - for searching a button by its name, id, value, img alt or title
** link_or_button - for searching for both, links and buttons
** select - for searching a select field by its id, name or label
** checkbox - for searching a checkbox by its id, name, or label
** radio - for searching a radio button by its id, name, or label
** file - for searching a file input by its id, name, or label
** optgroup - for searching optgroup by its label
** option - for searching an option by its content
** dialogue - for searching a dialogue with the specified header text
** filemanager - for searching a filemanager by it's id or label
** block - for searching a Moodle block by it's English name or it's frankenstyle name
** section - for searching for a section on a course page by it's title or its written out date (e.g. "1 January - 7 January"). Use "frontpage" "section" for the frontpage section if it has no title (default)
** activity - for searching for an activity module in a course list by it's title
** region - for searching a Moodle page region with that id, in fact it works with all the page's ids
** table_row - for searching a table row which contains the specified text
** table - for searching a table by its id or caption
** icon - for searching an icon by its title
** fieldset - for searching a fieldset by it's id or legend
** css_element - for searching an element by its CSS selector
** xpath_element - for searching an element by its XPath
* '''A text selector'''; similar to a selector but those are the elements that returns an area of the DOM, they are useful in steps following the format '''... in the "Community finder" "block"''' where you are clicking or looking for some text inside a specific area. In the 'Acceptance testing' interface you can see a drop-down menu to select one of these options:
** dialogue - for searching a dialogue with the specified header text
** block - for searching a Moodle block by it's English name or it's frankenstyle name
** section - for searching for a section on a course page by it's title or its written out date (e.g. "1 January - 7 January"). Use "frontpage" "section" for the frontpage section if it has no title (default)
** activity - for searching for an activity module in a course list by it's title
** region - for searching a Moodle page region with that id, in fact it works with all the page's ids
** table_row - for searching a table row which contains the specified text
** table - for searching a table by its id or caption
** fieldset - for searching a fieldset by it's id or legend
** css_element - for searching an element by its CSS selector
** xpath_element - for searching an element by its XPath

====== Checking table values ======
You can check if specific value exists or not in a table row/column by using:
* Then "STRING_IN_ROW" row "COLUMN_HEADER" column of "TABLE_ID" table should contain "VALUE_TO_CHECK"
* Then the following should exist in the "TABLE_ID" table:
| COLUMN_HEADER1 | COLUMN_HEADER2 |
| VALUE_IN_ROW_1 | VALUE_IN_ROW_1 |
| VALUE_IN_ROW_2 | VALUE_IN_ROW_2 |

==== Advanced use cases ====
Most of the time the usage of existing step definitions is straight forward. However, there are some exceptions were it might get complicated. Some of them are listed here:

====== Uploading files ======
Note than some tests requires files to be uploaded, in this case
* The '''I upload "FILEPATH_STRING" file to "FILEPICKER_FIELD_STRING" filepicker''' step can be used when located in the form page
* The file to upload should be included along with the Moodle codebase in COMPONENTNAME/tests/fixtures/*
* The file to upload is specified by it's path, which should be relative to the codebase root ('''lib/tests/fixtures/users.csv''' for example)
* '''/''' should be used as directory separator and the file names can not include this '''/''' character as all of them would be converted to the OS-dependant directory separator to maintain the compatibility with Windows systems.
* The scenarios that includes files uploading should be tagged using the '''@_file_upload''' tag
<code behat>
@editor @editor_atto @atto @atto_media @_file_upload
Feature: Add media to Atto
To write rich text - I need to add media.

Background:
Given I log in as "admin"
And I follow "Manage private files..."
And I upload "lib/editor/atto/tests/fixtures/moodle-logo.webm" file to "Files" filemanager
And I upload "lib/editor/atto/tests/fixtures/moodle-logo.mp4" file to "Files" filemanager
And I upload "lib/editor/atto/tests/fixtures/moodle-logo.png" file to "Files" filemanager
And I upload "lib/editor/atto/tests/fixtures/pretty-good-en.vtt" file to "Files" filemanager
And I upload "lib/editor/atto/tests/fixtures/pretty-good-sv.vtt" file to "Files" filemanager
And I click on "Save changes" "button"
...
</code>

====== Field groups ======
This section describes how you can use the step definitions
<code behat>
When I set the following fields to these values:
...
When I set the field "([^"]|\"*)" to "([^"]|\"*)"
</code>
for field groups. Examples for such field groups are the duration field or the date_time_selector. These are not displayed as one single input field within the front-end but consist of multiple input fields within one row.
You can access each single input field of a group using
<code behat>
identifierOfYourField[keyOfTheSpecificInput]
</code>
Examples would be:
<code behat>
When I set the following fields to these values:
| myDate[day] | 21 |
| myDate[month] | 12 |
| myDate[hour] | 14 |
| myDuration[number] | 10 |
| myDuration[unit] | days |
</code>

====== Human-readable and relative dates ======
When testing plugins with deadlines, for instance for submissions, it is often necessary to set certain time values to dates relative to today.
You can specify a relative time enclosed within two ## blocks. For example:
* ## yesterday ##
* ## 2 days ago ##
You can use everything according to [http://php.net/manual/en/datetime.formats.php].

Especially useful are the relative formats from: [http://php.net/manual/en/datetime.formats.relative.php]

Additionally, you can specify a format you want the date to be returned into:
* ## yesterday ## myformat ##
These formats can be used as outlined in [http://php.net/manual/en/function.date.php].
This can be combined with the field groups:
<code behat>
When I set the following fields to these values:
| myDate[day] | ## yesterday ## j ## |
| myDate[month] | ## yesterday ## n ## |
| myDate[year] | ## yesterday ## Y ## |
</code>

== Good practice ==

=== Test one thing per scenario ===

The ideal that you should strive for, is that each scenario tests just one specific bit of functionality. Therefore, if one test fails, the scenario name should tell you exactly what the bug is. Also, any bug should cause just one scenario to fail, not lots of unrelated ones. If you can achieve this, then the idea is that it minimises the time from seeing a test fail to having fixed the bug that was detected. Of course, this ideal is not always achievable, but in my experience it is worth striving for.

=== Set-up (Given) should not use the UI ===

The setup is not what you are really testing here. Therefore, it should be as quick and reliable as possible. The way to achieve this is with steps like <tt>And the following "Thing" exist:</tt> which directly insert the data into the database. If necessary, write extra steps for your plugin to setup the things you need.

=== Don't use XPath or CSS selectors - fix your Accessibility bugs ===

If, the only way you can identify something in the page that you want to manipulate is with a step like <tt>I set the field with xpath "//textarea[contains(@name, 'answer')]" to "frog"</tt>, then this is probably the sign that you have an Accessibility bug, because Behat accesses the page very like a screen-reader user would.

You should be able to refer to things with steps like <tt>I set the field "Answer" to "frog"'</tt> or <tt>I click on "True" "radio" in the "First question" "question"</tt>. If not, you should probably think about fixing the accessibility bug, rather than resorting to unreadable selectors in your Behat test.

=== When you define more steps in your plugin, make it clear they come from your plugin ===

When defining new Step definitions in your plugin, try to make sure the step name identifies it as belonging to your plugin. So, don't make a step called <tt>I disable UI plugins</tt>. Call it something like <tt>I disable UI plugins in the CodeRunner question type</tt>.

[[Category:Behat]]

Acceptance testing

2019-02-14T14:50:30Z

Kabalin: Missing category

This page is a starting point for working with acceptance tests (behat tests). These tests are suited if you want to test the front-end and with that the behaviour of your site / your plugin / your code.

If you want to write your own tests have a look at: [[Writing acceptance tests]]

If you want to run behat tests of the existing suite or the ones you have written for your own plugin please visit: [[Running acceptance test]]

[[Category:Behat]]

User:Ruslan Kabalin

2018-11-19T14:21:16Z

Kabalin:

For details, please see my profile on [https://moodle.org/user/profile.php?id=23389 moodle.org].

Writing acceptance tests

2018-11-09T11:54:18Z

Kabalin: Add useful information about steps, it has been located in the old version of Acceptance_testing document, but still useful as this is not covered anywhere. Might be not complete though, but at least something.

== Introduction ==
This documentation gives some hints, how to write behat tests for core and for plugins.
The focus of the documentation is on behat tests for plugins.
They are written in some kind of natural language and describe how the front-end of moodle should behave, when a user interacts with it.
Each test consists of a set of so called steps in a GIVEN, WHEN, THEN style:
* '''GIVEN''': These steps outline the state of your moodle platform at the start of your test. Here you can create users, courses and plugin instances.
* '''WHEN''': These steps usually execute the functionality of your plugin, which is under test.
* '''THEN''': These steps describe the expected behaviour of your plugin. They usually check if different elements can or can't be seen.

To initialize and run your tests, please follow the instructions of [[Running_acceptance_test]].

== Create you own tests ==
Behat tests are located within the directory tests/behat of your plugin.
The different tests are defined in files with the ending *.feature.
First, you have to define the header of your test:
<code behat>
@mod @mod_yourplugin @javascript
Feature: Here comes a description of your user story.
</code>
The tags on top of the feature description can be used to select specific test cases when running the tests.
The '@javascript' tag should only be used, if javascript is needed to execute your test. This is dependent on the step you will use in your definition.
Javascript tests are usually much slower than tests executed without javascript.

Afterwards you can specify a scenario:
<code behat>
@javascript
Scenario: Description of your scenario, which you want to test.
When I log in as "student1"
And I am on "Course 1" course homepage
</code>
Again you can define specific tags. Afterwards you write the steps, which should be executed during your test.

==== Multiple Scenarios ====
You can have an arbitrary amount of scenarios within a test. Please make sure they all belong to the same feature.
If you have certain steps, which should be executed for every scenario of a feature, you can define them using a background:
<code behat>
Background:
Given the following "courses" exist:
| fullname | shortname | category | groupmode |
| Course 1 | C1 | 0 | 1 |
And the following "users" exist:
| username | firstname | lastname | email |
| teacher1 | Theo | Teacher | teacher1@example.com |
</code>
This is usually used, to define the different '''GIVEN''' steps.

==== Use existing steps ====
There are different ways how to effectively browse the available existing steps:

====== Moodle Administration ======
Moodle offers within its administration menu under Site Administration > Development > Acceptance Testing a complete and searchable list of all available step definitions.
However, make sure you installed the behat test site first!

====== PhpStorm ======
In PhpStorm or IntelliJ you can install the behat extension. Then you get auto completions within feature files, which helps a lot during behat test development.

==== Providing values to steps ====
Most of the steps requires values, there are methods to provide values to steps, the method depends on the step specification.

* '''A string/text'''; is the most common case, the texts are wrapped between double quotes (" character) you have to replace the info about the expected value for your value; for example something like '''I press "BUTTON_STRING"''' should become '''I press "Save and return to course"'''. If you want to add a string which contains a " character, you can escape it with \", for example '''I fill the "Name" field with "Alan alias \"the legend\""'''. You can identify this steps because they ends with '''_STRING'''
* '''A number'''; some steps requires numbers as values, to be more specific an undetermined number of digits from 0 to 9 (Natural numbers + 0) you can identify them because the expected value info string ends with '''_NUMBER'''
* '''A table'''; is a relation between values, the most common use of it is to fill forms. The steps which requires tables are easily identifiable because they finish with ''':''' The steps description gives info about what the table columns must contain, for example '''Fills a moodle form with field/value data'''. Here you don't need to escape the double quotes if you want to include them as part of the value.
* '''A PyString'''; is a multiline string, most commonly used to fill out forms when a newline is required. Like steps with tables, steps which require PyStrings will end with ":"
* '''A field value'''; There are many different field types, if an argument requires a field value the expected value will depend on the field type:
** Text-based fields: It expects the text. This includes textareas, input type text, input type password...
** Checkbox: It expects 1 to check and for checked and "" to uncheck or for unchecked
** Select: It expects the option text or the option value. In case you interact with a multi-select you should specify the options separating them with commas. For example: '''option1, option2, option3'''
** Radio: The text of the radio option
* '''A selector'''; there are steps that can be used with different kinds of elements, for example '''I click on "User Name" "link"''' or '''I click on "User Name" "button"''' this is a closed list of elements, they always works together with another argument, where you specify the locator (eg. the link text in a link) In the 'Acceptance testing' interface you can see a drop-down menu to select one of these options:
** field - for searching a field by its id, name, value or label
** link - for searching a link by its href, id, title, img alt or value
** button - for searching a button by its name, id, value, img alt or title
** link_or_button - for searching for both, links and buttons
** select - for searching a select field by its id, name or label
** checkbox - for searching a checkbox by its id, name, or label
** radio - for searching a radio button by its id, name, or label
** file - for searching a file input by its id, name, or label
** optgroup - for searching optgroup by its label
** option - for searching an option by its content
** dialogue - for searching a dialogue with the specified header text
** filemanager - for searching a filemanager by it's id or label
** block - for searching a Moodle block by it's English name or it's frankenstyle name
** section - for searching for a section on a course page by it's title or its written out date (e.g. "1 January - 7 January"). Use "frontpage" "section" for the frontpage section if it has no title (default)
** activity - for searching for an activity module in a course list by it's title
** region - for searching a Moodle page region with that id, in fact it works with all the page's ids
** table_row - for searching a table row which contains the specified text
** table - for searching a table by its id or caption
** fieldset - for searching a fieldset by it's id or legend
** css_element - for searching an element by its CSS selector
** xpath_element - for searching an element by its XPath
* '''A text selector'''; similar to a selector but those are the elements that returns an area of the DOM, they are useful in steps following the format '''... in the "Community finder" "block"''' where you are clicking or looking for some text inside a specific area. In the 'Acceptance testing' interface you can see a drop-down menu to select one of these options:
** dialogue - for searching a dialogue with the specified header text
** block - for searching a Moodle block by it's English name or it's frankenstyle name
** section - for searching for a section on a course page by it's title or its written out date (e.g. "1 January - 7 January"). Use "frontpage" "section" for the frontpage section if it has no title (default)
** activity - for searching for an activity module in a course list by it's title
** region - for searching a Moodle page region with that id, in fact it works with all the page's ids
** table_row - for searching a table row which contains the specified text
** table - for searching a table by its id or caption
** fieldset - for searching a fieldset by it's id or legend
** css_element - for searching an element by its CSS selector
** xpath_element - for searching an element by its XPath

====== Checking table values ======
You can check if specific value exists or not in a table row/column by using:
* Then "STRING_IN_ROW" row "COLUMN_HEADER" column of "TABLE_ID" table should contain "VALUE_TO_CHECK"
* Then the following should exist in the "TABLE_ID" table:
| COLUMN_HEADER1 | COLUMN_HEADER2 |
| VALUE_IN_ROW_1 | VALUE_IN_ROW_1 |
| VALUE_IN_ROW_2 | VALUE_IN_ROW_2 |

==== Advanced use cases ====
Most of the time the usage of existing step definitions is straight forward. However, there are some exceptions were it might get complicated. Some of them are listed here:

====== Uploading files ======
Note than some tests requires files to be uploaded, in this case
* The '''I upload "FILEPATH_STRING" file to "FILEPICKER_FIELD_STRING" filepicker''' step can be used when located in the form page
* The file to upload should be included along with the Moodle codebase in COMPONENTNAME/tests/fixtures/*
* The file to upload is specified by it's path, which should be relative to the codebase root ('''lib/tests/fixtures/users.csv''' for example)
* '''/''' should be used as directory separator and the file names can not include this '''/''' character as all of them would be converted to the OS-dependant directory separator to maintain the compatibility with Windows systems.
* The scenarios that includes files uploading should be tagged using the '''@_file_upload''' tag
<code behat>
@editor @editor_atto @atto @atto_media @_file_upload
Feature: Add media to Atto
To write rich text - I need to add media.

Background:
Given I log in as "admin"
And I follow "Manage private files..."
And I upload "lib/editor/atto/tests/fixtures/moodle-logo.webm" file to "Files" filemanager
And I upload "lib/editor/atto/tests/fixtures/moodle-logo.mp4" file to "Files" filemanager
And I upload "lib/editor/atto/tests/fixtures/moodle-logo.png" file to "Files" filemanager
And I upload "lib/editor/atto/tests/fixtures/pretty-good-en.vtt" file to "Files" filemanager
And I upload "lib/editor/atto/tests/fixtures/pretty-good-sv.vtt" file to "Files" filemanager
And I click on "Save changes" "button"
...
</code>

====== Field groups ======
This section describes how you can use the step definitions
<code behat>
When I set the following fields to these values:
...
When I set the field "([^"]|\"*)" to "([^"]|\"*)"
</code>
for field groups. Examples for such field groups are the duration field or the date_time_selector. These are not displayed as one single input field within the front-end but consist of multiple input fields within one row.
You can access each single input field of a group using
<code behat>
identifierOfYourField[keyOfTheSpecificInput]
</code>
Examples would be:
<code behat>
When I set the following fields to these values:
| myDate[day] | 21 |
| myDate[month] | 12 |
| myDate[hour] | 14 |
| myDuration[number] | 10 |
| myDuration[unit] | days |
</code>

====== Relative dates ======
When testing plugins with deadlines, for instance for submissions, it is often necessary to set certain time values to dates relative to today.
You can specify a relative time enclosed within two ## blocks. For example:
* ## yesterday ##
* ## 2 days ago ##
You can use everything according to [http://php.net/manual/en/datetime.formats.php].

Especially useful are the relative formats from: [http://php.net/manual/en/datetime.formats.relative.php]

Additionally, you can specify a format you want the date to be returned into:
* ## yesterday ## myformat ##
These formats can be used as outlined in [http://php.net/manual/en/function.date.php].
This can be combined with the field groups:
<code behat>
When I set the following fields to these values:
| myDate[day] | ## yesterday ## j ## |
| myDate[month] | ## yesterday ## n ## |
| myDate[year] | ## yesterday ## Y ## |
</code>

Grunt

2018-10-12T10:14:36Z

Kabalin: /* Running grunt: add info on verbose param */

{{Moodle 2.9}}

Grunt is a command line tool used to prepare our javascript and less-generated css for production usage. After making any change to javascript or less files in Moodle, you must run grunt to lint, minify and package the javascript/css properly so that it can be served by Moodle.

== Install grunt ==
The Javascript modules (AMD and YUI) and less css in Moodle must be processed by some build tools before they will be visible to your web browser. We use "[http://gruntjs.com/ grunt]" as a build tool to wrap our different processes. Grunt is a build tool written in Javascript that runs in the "[http://nodejs.org/ nodejs]" environment. This means you first have to install nodejs - and it's package manager "[https://www.npmjs.com/ npm]". The details of how to install those packages will vary by operating system, but on Linux it's likely to be:
apt-get install nodejs npm
See also: [http://askubuntu.com/questions/594656/how-to-install-the-latest-versions-of-nodejs-and-npm-for-ubuntu-14-04-lts/711976 how to install the latest version of nodejs and npm for ubuntu 14.04]

There are downloadable packages for other operating systems here: http://nodejs.org/download/.

Once this is done, cd into your Moodle directory and run the command:
npm install
to install all of the required tools.

You also need to install the grunt-cli package globally in order to have a "grunt" command in your path. To do this run:
npm install -g grunt-cli

== Running grunt ==
Typical commands:

grunt amd # Short-cut for grunt jshint uglify, rebuild all AMD modules.
grunt shifter # Run shifter
grunt js # Short-cut for grunt amd shifter

grunt css # Run less
grunt # Try to do the right thing:
# * If you are in a folder called amd, do grunt amd
# * If you are in a folder called yui/src/something, do grunt shifter
# * Otherwise build everything (grunt css js).

grunt watch # Watch for changes and re-run grunt tasks depending on what file changes
grunt eslint --show-lint-warnings # Show pedantic lint warnings for JS

On Linux/Mac it will build everything in the current folder and below. You need to cd into the amd folder of your module root, i.e. <tt>dirroot/blocks/foo/amd</tt> before running <tt>grunt amd</tt> - this will compile only your plugins AMD source files. You can make output more verbose by adding <tt>-v</tt> parameter, if used with <tt>grunt shifter</tt> this will actually show what your lint errors are. On Windows, you need to specify the path on the command line like <tt>--root=admin/tool/templatelibrary</tt>.

== Using Grunt in additional plugins ==

You may want to use Grunt for performing tasks in your custom Moodle plugins. For building AMD and YUI modules in your plugin, the standard configuration Gruntfile.js located in the Moodle root should work well. For building CSS files from LESS templates, you will have to set up a separate Grunt installation in the root of your plugin.

If you do not have it yet, create the package.json file in the root of your plugin:

{
"name": "moodle-plugintype_pluginname"
}

Install grunt, grunt less and grunt watch modules. Note that you should put the folder node_modules into your plugin's .gitignore file, too.

$ cd /path/to/your/plugin/root
$ npm install --save-dev grunt grunt-contrib-less grunt-contrib-watch grunt-load-gruntfile

Create a Gruntfile.js in the root of your plugin and configure the task for building CSS files from LESS:

<code javascript>
"use strict";

module.exports = function (grunt) {

// We need to include the core Moodle grunt file too, otherwise we can't run tasks like "amd".
require("grunt-load-gruntfile")(grunt);
grunt.loadGruntfile("../../Gruntfile.js");

// Load all grunt tasks.
grunt.loadNpmTasks("grunt-contrib-less");
grunt.loadNpmTasks("grunt-contrib-watch");
grunt.loadNpmTasks("grunt-contrib-clean");

grunt.initConfig({
watch: {
// If any .less file changes in directory "less" then run the "less" task.
files: "less/*.less",
tasks: ["less"]
},
less: {
// Production config is also available.
development: {
options: {
// Specifies directories to scan for @import directives when parsing.
// Default value is the directory of the source, which is probably what you want.
paths: ["less/"],
compress: true
},
files: {
"styles.css": "less/styles.less"
}
},
}
});
// The default task (running "grunt" in console).
grunt.registerTask("default", ["less"]);
};
</code>

Now running "grunt" or "grunt less" in your plugin root folder will compile the file less/styles.less and saves it as styles.css. Running "grunt watch" will watch the less/*.less files and if some is changed, it will immediately rebuild the CSS file.

If you are working on a custom theme, you may have multiple less/*.less files that you want to compile to their style/*.css counterparts. You can either define an explicit list all such file pairs, or let that list be created for you by making use of [http://gruntjs.com/configuring-tasks#building-the-files-object-dynamically expand:true feature] of gruntfile.js:

<code javascript>
// This dynamically creates the list of files to be processed.
files: [
{
expand: true,
cwd: "less/",
src: "*.less",
dest: "style/",
ext: ".css"
}
]
</code>

== See also ==
* [[YUI/Shifter]]
* [[Javascript Modules]]
* [[LESS]]

[[Category:AJAX]]
[[Category:Javascript]]

Developer notes

2018-05-01T10:48:33Z

Kabalin: /* Other */

This area is for developers to work on various bits of code and documentation as necessary. Once material has matured it should be linked to from the main [[Developer documentation|Developer documentation]] page.

==Core code==

*[[Other lang issues|Language issues]]
*[[Datalib Notes]]
*[[Application/session variables]]
*[[Filters schema]]
*[[Filterall support]]
*[[Groups documentation for module developers]]
*[[Plan to improve ability to delegate administrator tasks to course category level|Plan to improve ability to delegate administrator tasks to course category level]]
*[[Stealth mode and nested activities|Stealth mode and nested activities]]
*[[Enrolment_plugins_2.0|How enrolments should work in Moodle 2.0]]
*[[Redesigning the override roles page|Redesigning the override roles page]]

===Gradebook===

*[[Gradebook_improvements|Gradebook improvements]] - ideas from Petr.
*[[Tim's_Gradebook_thoughts|Tim's Gradebook thoughts]]

==Modules and other recognised plugin types==

===Lesson===

*[[Adding_question_types_to_lesson|Adding question types to lesson module]]
*[[New lesson navigation | New lesson navigation]]
*[[Adding blocks to lesson | Adding blocks to lesson]]

===Quiz & question types===

* [[File storage conversion Quiz and Questions|File storage conversion Quiz and Questions]] - notes for MDL-16094.
* [[How the quiz navigation should work in Moodle 2.0|How the quiz navigation should work in Moodle 2.0]] - MDL-20276.
* [[Moodle 2.0 question bank improvements|Moodle 2.0 question bank improvements]] - including question tagging and improved searchability.
* [[Question_Engine_2|Proposal to change the Moodle Question Engine]] This supersedes
** [[Plans for adaptive mode|Plans for adaptive mode]]
** [[Implementation of true negative marks in MC-type questions|Implementation of true negative marks in MC-type questions]]
* [[Calculated question : adding new math functions]]
* [[Numerical question units and intervals]]
* [[Future question bank/sharing/versioning requirements|Future question bank/sharing/versioning requirements]]
* [[States of a quiz attempt]]
* [[Optional checkbox "This is all my own work" before submitting a quiz]]
* [[The OU PMatch algorithm]]
* [[Provide print option for a Quiz]]

===Other activity modules===

*[[Forum development|Forum functional upgrade]]
*[[Wiki development|Wiki module development]]
*[[Schedule development|Proposed replacement for Scheduler]]

===Gradebook Plugins===

*[[External Database Plugin]]

===Other===

*[[Blogs and forums|Blogs, forums and the nature of discussion]]
*[[Conditional activities]]
*[[Improved Payment Plugin]]
*[[Moodle-specific customisations to the HTML editor]]
*[[Moodle Automatic Regression Test and Inspection Nit-picker]]
*[[ VSTU projects|Projects developed in Volgograd State Technical University]] becomes to many to simple list them on that page.
*[[HTML5_player|HTML5 player]]

== Markup & Theming ==
* [[Moodle CSS System]], idea from forum discussion on [http://moodle.org/mod/forum/discuss.php?d=126009 Object Oriented CSS]

==Other==

*[[MoodleDocs development]]
*[[Usability]]
*[[Document Management API]]
*[[wikindx|Possible integration of WIKINDX with Moodle]]
*[[Snapshot - flat HTML export of complete course]]
*[[Offline Moodle | Development:Offline Moodle - A Moodle that runs on a mobile device with the internet]]
*[[A standard set of fixtures for unit tests?|A standard set of fixtures for unit tests?]]
*[[reportbuilder|Possible integration Totara Report Builder into Moodle]]
*[[openbadges|Open Badges]]
*[[Course Reset Proposal]]

==Archive: past proposals==

===Things that got implemented===

====Core code====

*[[Ajax user selector|Ajax user selector]]
*[[Roles]] - in Moodle 1.7
*[[Moodle forms library]] - in Moodle 1.8
**[[Martin form notes]]

====Quiz & question types====

*[[Quiz UI redesign | Quiz UI redesign]]
*[[Administration page for question types|Administration page for question types]]
*[[Plan_to_Improve_Flexibility_of_Question_Category_Sharing_and_Permissions|Plans for enhancing the question bank]] - in Moodle 1.9
*[[Email notification when a quiz is submitted|Email notification when a quiz is submitted]] - in Moodle 1.9
*[[Plans for enhancing import/export in questiontype plugins]] - in Moodle 1.9
*[[quiz_navigation | Quiz navigation]]
*[[Open_protocol_for_accessing_question_engines|Open protocol for accessing question engines]]
*[[Quiz report enhancements|Quiz report enhancements]]
*[[Flagging questions during a quiz attempt|Flagging questions during a quiz attempt]]

====Other====

*[[Quiz and quesions community testing day]]

Developer notes

2018-05-01T10:47:59Z

Kabalin: /* Other */ Add html5 player orphaned page.

This area is for developers to work on various bits of code and documentation as necessary. Once material has matured it should be linked to from the main [[Developer documentation|Developer documentation]] page.

==Core code==

*[[Other lang issues|Language issues]]
*[[Datalib Notes]]
*[[Application/session variables]]
*[[Filters schema]]
*[[Filterall support]]
*[[Groups documentation for module developers]]
*[[Plan to improve ability to delegate administrator tasks to course category level|Plan to improve ability to delegate administrator tasks to course category level]]
*[[Stealth mode and nested activities|Stealth mode and nested activities]]
*[[Enrolment_plugins_2.0|How enrolments should work in Moodle 2.0]]
*[[Redesigning the override roles page|Redesigning the override roles page]]

===Gradebook===

*[[Gradebook_improvements|Gradebook improvements]] - ideas from Petr.
*[[Tim's_Gradebook_thoughts|Tim's Gradebook thoughts]]

==Modules and other recognised plugin types==

===Lesson===

*[[Adding_question_types_to_lesson|Adding question types to lesson module]]
*[[New lesson navigation | New lesson navigation]]
*[[Adding blocks to lesson | Adding blocks to lesson]]

===Quiz & question types===

* [[File storage conversion Quiz and Questions|File storage conversion Quiz and Questions]] - notes for MDL-16094.
* [[How the quiz navigation should work in Moodle 2.0|How the quiz navigation should work in Moodle 2.0]] - MDL-20276.
* [[Moodle 2.0 question bank improvements|Moodle 2.0 question bank improvements]] - including question tagging and improved searchability.
* [[Question_Engine_2|Proposal to change the Moodle Question Engine]] This supersedes
** [[Plans for adaptive mode|Plans for adaptive mode]]
** [[Implementation of true negative marks in MC-type questions|Implementation of true negative marks in MC-type questions]]
* [[Calculated question : adding new math functions]]
* [[Numerical question units and intervals]]
* [[Future question bank/sharing/versioning requirements|Future question bank/sharing/versioning requirements]]
* [[States of a quiz attempt]]
* [[Optional checkbox "This is all my own work" before submitting a quiz]]
* [[The OU PMatch algorithm]]
* [[Provide print option for a Quiz]]

===Other activity modules===

*[[Forum development|Forum functional upgrade]]
*[[Wiki development|Wiki module development]]
*[[Schedule development|Proposed replacement for Scheduler]]

===Gradebook Plugins===

*[[External Database Plugin]]

===Other===

*[[Blogs and forums|Blogs, forums and the nature of discussion]]
*[[Conditional activities]]
*[[Improved Payment Plugin]]
*[[Moodle-specific customisations to the HTML editor]]
*[[Moodle Automatic Regression Test and Inspection Nit-picker]]
*[[ VSTU projects|Projects developed in Volgograd State Technical University]] becomes to many to simple list them on that page.
*[[HTML5 player|HTML5_player]]

== Markup & Theming ==
* [[Moodle CSS System]], idea from forum discussion on [http://moodle.org/mod/forum/discuss.php?d=126009 Object Oriented CSS]

==Other==

*[[MoodleDocs development]]
*[[Usability]]
*[[Document Management API]]
*[[wikindx|Possible integration of WIKINDX with Moodle]]
*[[Snapshot - flat HTML export of complete course]]
*[[Offline Moodle | Development:Offline Moodle - A Moodle that runs on a mobile device with the internet]]
*[[A standard set of fixtures for unit tests?|A standard set of fixtures for unit tests?]]
*[[reportbuilder|Possible integration Totara Report Builder into Moodle]]
*[[openbadges|Open Badges]]
*[[Course Reset Proposal]]

==Archive: past proposals==

===Things that got implemented===

====Core code====

*[[Ajax user selector|Ajax user selector]]
*[[Roles]] - in Moodle 1.7
*[[Moodle forms library]] - in Moodle 1.8
**[[Martin form notes]]

====Quiz & question types====

*[[Quiz UI redesign | Quiz UI redesign]]
*[[Administration page for question types|Administration page for question types]]
*[[Plan_to_Improve_Flexibility_of_Question_Category_Sharing_and_Permissions|Plans for enhancing the question bank]] - in Moodle 1.9
*[[Email notification when a quiz is submitted|Email notification when a quiz is submitted]] - in Moodle 1.9
*[[Plans for enhancing import/export in questiontype plugins]] - in Moodle 1.9
*[[quiz_navigation | Quiz navigation]]
*[[Open_protocol_for_accessing_question_engines|Open protocol for accessing question engines]]
*[[Quiz report enhancements|Quiz report enhancements]]
*[[Flagging questions during a quiz attempt|Flagging questions during a quiz attempt]]

====Other====

*[[Quiz and quesions community testing day]]

HTML5 player

2018-05-01T10:46:32Z

Kabalin:

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = Closed, released in 3.2
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1110024
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=marina Marina Glancy]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 player with flash fallback for integration in Moodle and plan its implementation.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* [http://mediaelementjs.com/ MediaElement.js]
* ?Are there other alternatives?

== Comparison Matrix ==

{| class="nicetable"
|-
!
! [[#Flowplayer_HTML5|Flowplayer HTML5]]
! [[#Video.JS|Video.JS]]
! [[#Projekktor|Projekktor]]
! [[#MediaElement.js|MediaElement.js]]
! No Player
|-
! Accessible Player:
| colspan="5"|
|-
!
* Keyboard control
| Yes
| Yes (http://accessibility.oit.ncsu.edu/blog/2013/05/09/accessible-video-js-player-available-on-global-accessibility-awareness-day/) This was instructed by Greg Krause, one of the key accessibility advisors for Moodle.
| Yes (configurable)
| Yes
| Yes
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
| Yes
| Yes (see http://caniuse.com/webvtt)
|-
!
* Touch interface
| Yes
| Yes
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="5"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
|-
!
* CSS customisation
| Yes
| Yes
| Yes
| Yes
| Yes
|-
!
* RTL support
| Yes
| No
| No
| Unknown (CSS, so I guess so...)
| Yes
|-
! Mobile platforms:
| colspan="5"|
|-
!
* iOS
| Yes
| No
| Yes
| Yes
| Yes
|-
!
* Android
| Yes
| No
| Yes
| Yes
| Yes
|-
! Streaming protocols:
| colspan="5"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
| Yes
| No
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
| HLS
| via Media Source Extension
|-
!
* MPEG-DASH
| Yes (via [http://demos.flowplayer.org/api/dash.html plugin])
| Yes (via [https://github.com/videojs/videojs-contrib-dash plugin])
| ?
| ?
| ?
|-
! Audio player
| No
| Yes
| Yes
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
| style="border-bottom: 2px solid;" | Yes
| style="border-bottom: 2px solid;" | No
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
| MIT
| no extra code needed
|-
! JS library
| jQuery
| -
| jQuery
| jQuery
| none required
|-
! Plugins infrastructure
| No
| Yes
| Yes
| Yes
| No
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
| Flash and Silverlight (for .wmv support) fallback, used to provide the HTML5 video/audio elements.
| The Video tag can contain fallback content (e.g. Flash object) for browsers that don't support it at all (http://camendesign.com/code/video_for_everybody), but not based on codec support.
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* Poor documentation
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== MediaElement.js ===

'''Pros:'''
* Flash fall-forward - uses Flash/Silverlight to provide the HTML5 MediaElement API.
* Consistent HTML/CSS Player
* No logo on screen.

'''Cons:'''
* ...

'''Technical notes (lessons learned from the prototypes)'''

* ...

'''Missing features'''

* ...

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

=== HTML5 browser native ===

'''Pros:'''
* Simple
* Standard on mobile

'''Cons:'''
* IE8 has no support

'''Technical notes'''
*

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=mediaelementjs MediaElement.js] version 2.6.14
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=native Native browser support].

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in [[#Flowplayer_HTML5|corresponding section above]], it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout, display platform incompatibility message prior to attempt to play, and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

In initial stage FlowPlayer HTML5 (or any other) will handle all existing HTML5 Video extensions as per core_media_player_html5video class, plus m3u8 (HLS). It will also be possible optionally to make flash files handled by HTML5 Video player as well (possibility of using existing flash FlowPlayer for flv files will remain).

== Mock-Ups/Prototypes ==

See [[#Sample_Pages|Sample pages]] section.

== Workaround ==

As intermediate solution, if you require player consistency throughout all browsers and platforms, you may consider using JW Player filter: https://github.com/lucisgit/moodle-filter_jwplayer Notice, that JW Player is not free for commercial use.

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx
* A mind map representation of [https://www.mindmup.com/#m:g10BzEUW_tmkNcvVFZ5d1N4VUV5UUU using Video in various parts and plugins of Moodle].

[[Category:Project]]

HTML5 player

2018-05-01T10:45:58Z

Kabalin:

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = Closed, released in 3.2
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1110024
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=marina Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 player with flash fallback for integration in Moodle and plan its implementation.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* [http://mediaelementjs.com/ MediaElement.js]
* ?Are there other alternatives?

== Comparison Matrix ==

{| class="nicetable"
|-
!
! [[#Flowplayer_HTML5|Flowplayer HTML5]]
! [[#Video.JS|Video.JS]]
! [[#Projekktor|Projekktor]]
! [[#MediaElement.js|MediaElement.js]]
! No Player
|-
! Accessible Player:
| colspan="5"|
|-
!
* Keyboard control
| Yes
| Yes (http://accessibility.oit.ncsu.edu/blog/2013/05/09/accessible-video-js-player-available-on-global-accessibility-awareness-day/) This was instructed by Greg Krause, one of the key accessibility advisors for Moodle.
| Yes (configurable)
| Yes
| Yes
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
| Yes
| Yes (see http://caniuse.com/webvtt)
|-
!
* Touch interface
| Yes
| Yes
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="5"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
|-
!
* CSS customisation
| Yes
| Yes
| Yes
| Yes
| Yes
|-
!
* RTL support
| Yes
| No
| No
| Unknown (CSS, so I guess so...)
| Yes
|-
! Mobile platforms:
| colspan="5"|
|-
!
* iOS
| Yes
| No
| Yes
| Yes
| Yes
|-
!
* Android
| Yes
| No
| Yes
| Yes
| Yes
|-
! Streaming protocols:
| colspan="5"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
| Yes
| No
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
| HLS
| via Media Source Extension
|-
!
* MPEG-DASH
| Yes (via [http://demos.flowplayer.org/api/dash.html plugin])
| Yes (via [https://github.com/videojs/videojs-contrib-dash plugin])
| ?
| ?
| ?
|-
! Audio player
| No
| Yes
| Yes
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
| style="border-bottom: 2px solid;" | Yes
| style="border-bottom: 2px solid;" | No
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
| MIT
| no extra code needed
|-
! JS library
| jQuery
| -
| jQuery
| jQuery
| none required
|-
! Plugins infrastructure
| No
| Yes
| Yes
| Yes
| No
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
| Flash and Silverlight (for .wmv support) fallback, used to provide the HTML5 video/audio elements.
| The Video tag can contain fallback content (e.g. Flash object) for browsers that don't support it at all (http://camendesign.com/code/video_for_everybody), but not based on codec support.
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* Poor documentation
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== MediaElement.js ===

'''Pros:'''
* Flash fall-forward - uses Flash/Silverlight to provide the HTML5 MediaElement API.
* Consistent HTML/CSS Player
* No logo on screen.

'''Cons:'''
* ...

'''Technical notes (lessons learned from the prototypes)'''

* ...

'''Missing features'''

* ...

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

=== HTML5 browser native ===

'''Pros:'''
* Simple
* Standard on mobile

'''Cons:'''
* IE8 has no support

'''Technical notes'''
*

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=mediaelementjs MediaElement.js] version 2.6.14
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=native Native browser support].

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in [[#Flowplayer_HTML5|corresponding section above]], it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout, display platform incompatibility message prior to attempt to play, and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

In initial stage FlowPlayer HTML5 (or any other) will handle all existing HTML5 Video extensions as per core_media_player_html5video class, plus m3u8 (HLS). It will also be possible optionally to make flash files handled by HTML5 Video player as well (possibility of using existing flash FlowPlayer for flv files will remain).

== Mock-Ups/Prototypes ==

See [[#Sample_Pages|Sample pages]] section.

== Workaround ==

As intermediate solution, if you require player consistency throughout all browsers and platforms, you may consider using JW Player filter: https://github.com/lucisgit/moodle-filter_jwplayer Notice, that JW Player is not free for commercial use.

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx
* A mind map representation of [https://www.mindmup.com/#m:g10BzEUW_tmkNcvVFZ5d1N4VUV5UUU using Video in various parts and plugins of Moodle].

[[Category:Project]]

Frankenstyle

2016-05-23T15:46:46Z

Kabalin: /* Core subsystems */ Add antivirus

'Frankenstyle component names' refers to the naming convention that is used to uniquely identify a Moodle plugin based on the type of plugin and its name. They are used throughout the Moodle code (with a notable exception being the css class names in the themes).

Martin Dougiamas invented the word 'frankenstyle' to describe this naming system which was invented by Petr Škoda.

== Format ==

Frankenstyle component names have a prefix and then a folder name, separated by an underscore.

# The prefix is determined by the type of plugin. For example, the prefix for an activity module is '''mod'''.
# The name is the folder name of the plugin, always lower case. For example, the name for Quiz is '''quiz'''.

So the frankenstyle component name for the quiz module is '''mod_quiz'''.

== Plugin types ==

See [[Plugin types]] page for the list of all supported plugin types in Moodle and their frankenstyle prefix.

To get a definitive list in your version of Moodle 2.x, use a small Moodle script with <tt>print_object(get_plugin_types());</tt>.

== Core subsystems ==

Subsystems in Moodle are not plugins themselves but can be referred to using '''core_xxx''' where xxx is the subsystem name as defined in get_core_subsystems().

You can see these being used in the @package parameter in phpdocs, or in the [[Web_services_Roadmap|webservice function names]].

{| class="nicetable"
|-
! Core subsystem
! Frankenstyle component name
|-
| Access
| core_access
|-
| Antivirus
| core_antivirus
|-
| Badges
| core_badges
|-
| Conditional availability
| core_condition
|-
| Comment
| core_comment
|-
| Completion
| core_completion
|-
| Course
| core_course
|-
| Enrol
| core_enrol
|-
| Files
| core_files
|-
| Forms
| core_form
|-
| Grade
| core_grade
|-
| Groups
| core_group
|-
| Messages
| core_message
|-
| Mnet
| core_mnet
|-
| My home page
| core_my
|-
| Notes
| core_notes
|-
| Ratings
| core_rating
|-
| Role
| core_role
|-
| RSS
| core_rss
|-
| Tag
| core_tag
|-
| User
| core_user
|-
| Web service
| core_webservice
|}

== Usage ==

Frankenstyle component names are used in:

=== Function names ===

All plugin functions must start with full frankenstyle prefix. For backwards compatibility modules may also use '''modulename_''' as prefix.

=== Class names ===

All plugin classes must start frankenstyle prefix, ex: mod_forum_some_class.

=== Constants ===

All plugin constants must start with uppercase frankenstyle prefix, example MOD_FORUM_XXXX.

=== Table names ===

All table names for a plugin must begin with its frankenstyle name (after the standard Moodle table prefix).

(The exception to this rule is Moodle activities which (for historical reasons) do not have mod_ in front of the plugin name)

Examples: mdl_'''local_coolreport''', mdl_'''local_coolreport'''_users

=== Plugin configuration table ===

In the '''config_plugins''' table, column '''plugin''', the frankenstyle name is used.

=== Capabilities ===

All capabilities for a plugin use the frankenstyle name, except with a / instead of a _.

Example: '''mod/quiz''':viewattempt

=== Language files===

The main language file for each plugin (with the notable exception of activity modules) is the frankenstyle component name.

Examples: /blocks/participants/lang/en/'''block_participants'''.php

=== Renderers ===

=== Module Subplugins ===

It is possible to extend modules without having to change the basic module's code. See [[Subplugins]] for details.

=== Other places (TODO) ===

* @package declarations in phpdocs, see [[Coding_style#PHPDoc]]
* [[Web_services_Roadmap|web service function names]]
* [http://moodle.org Moodle Plugins database]

Please add more as they come up.

==See also==

* [[Plugins]]
* [[Subplugins]]
* [[Core APIs]]
* [[Automatic class loading]]

[[Category:Plugins]]

Plugin types

2016-05-23T15:39:45Z

Kabalin: Add Antivirus plugins

{{Plugins development}}

The M in Moodle stands for modular. The easiest and most maintainable way to add new functionality to Moodle is by writing one of these types of plugin.
If none of the standardized types fits your needs, you can use the "local" type.

== List of Moodle plugin types ==

{| class="nicetable"
|-
! Plugin type
! Component name ([[Frankenstyle]])
! Moodle path
! Description
! Moodle versions
|-
| [[Activity modules]]
| mod
| /mod
| Activity modules are essential types of plugins in Moodle as they provide activities in courses. For example: Forum, Quiz and Assignment.
| 1.0+
|-
| [[Antivirus plugins]]
| antivirus
| /lib/antivirus
| Antivirus scanner plugins provide virus scanning functionality using third-party virus scanning tools in Moodle. For example: ClamAV.
| 3.1+
|-
| [[Assign_submission_plugins|Assignment submission plugins]]
| assignsubmission
| /mod/assign/submission
| Different forms of assignment submissions
| 2.3+
|-
| [[Assign_feedback_plugins|Assignment feedback plugins]]
| assignfeedback
| /mod/assign/feedback
| Different forms of assignment feedbacks
| 2.3+
|-
| [[Book tools]]
| booktool
| /mod/book/tool
| Small information-displays or tools that can be moved around pages
| 2.1+
|-
| [[Database fields]]
| datafield
| /mod/data/field
| Different types of data that may be added to the Database activity module
| 1.6+
|-
| [[Database presets]]
| datapreset
| /mod/data/preset
| Pre-defined templates for the Database activity module
| 1.6+
|-
| [[External tool source|LTI sources]]
| ltisource
| /mod/lti/source
| LTI providers can be added to external tools easily through the external tools interface see [https://docs.moodle.org/en/External_tool Documentation on External Tools]. This type of plugin is specific to LTI providers that need a plugin that can register custom handlers to process LTI messages
| 2.7+
|-
| [[LTI services]]
| ltiservice
| /mod/lti/service
| Allows the implementation of LTI services as described by the IMS LTI specification
| 2.8+
|-
| [[Quiz reports]]
| quiz
| /mod/quiz/report
| Display and analyse the results of quizzes, or just plug miscellaneous behaviour into the quiz module
| 1.1+
|-
| [[Quiz access rules]]
| quizaccess
| /mod/quiz/accessrule
| Add conditions to when or where quizzes can be attempted, for example only from some IP addresses, or student must enter a password first
| 2.2+
|-
| [[SCORM reports]]
| scormreport
| /mod/scorm/report
| Analysis of SCORM attempts
| 2.2+
|-
| [[Workshop grading strategies]]
| workshopform
| /mod/workshop/form
| Define the type of the grading form and implement the calculation of the grade for submission in the [[Workshop]] module
| 2.0+
|-
| [[Workshop allocation methods]]
| workshopallocation
| /mod/workshop/allocation
| Define ways how submissions are assigned for assessment in the [[Workshop]] module
| 2.0+
|-
| [[Workshop evaluation methods]]
| workshopeval
| /mod/workshop/eval
| Implement the calculation of the grade for assessment (grading grade) in the [[Workshop]] module
| 2.0+
|-
| [[Blocks]]
| block
| /blocks
| Small information-displays or tools that can be moved around pages
| 2.0+
|-
| [[Question types]]
| qtype
| /question/type
| Different types of question (e.g. multiple-choice, drag-and-drop) that can be used in quizzes and other activities
| 1.6+
|-
| [[Question behaviours]]
| qbehaviour
| /question/behaviour
| Control how student interact with questions during an attempt
| 2.1+
|-
| [[Question formats|Question import/export formats]]
| qformat
| /question/format
| Import and export question definitions to/from the question bank
| 1.6+
|-
| [[Filters|Text filters]]
| filter
| /filter
| Automatically convert, highlight, and transmogrify text posted into Moodle.
| 1.4+
|-
| [[Editors]]
| editor
| /lib/editor
| Alternative text editors for editing content
| 2.0+
|-
| [[Atto|Atto editor plugins]]
| atto
| /lib/editor/atto/plugins
| Extra functionality for the Atto text editor
| 2.7+
|-
| [[TinyMCE editor plugins]]
| tinymce
| /lib/editor/tinymce/plugins
| Extra functionality for the TinyMCE text editor.
| 2.4+
|-
| [[Enrolment plugins]]
| enrol
| /enrol
| Ways to control who is enrolled in courses
| 2.0+
|-
| [[Authentication plugins]]
| auth
| /auth
| Allows connection to external sources of authentication
| 2.0+
|-
| [[Admin tools]]
| tool
| /admin/tool
| Provides utility scripts useful for various site administration and maintenance tasks
| 2.2+
|-
| [[Log stores]]
| logstore
| /admin/tool/log/store
| Event logs storage back-ends
| 2.7+
|-
| [[Antivirus plugins]]
| antivirus
| /lib/antivirus
| Infrastructure for scanning and detecting viruses in user uploaded files
| 3.1+
|-
| [[Availability conditions]]
| availability
| /availability/condition
| Conditions to restrict user access to activities and sections.
| 2.7+
|-
| [[Calendar types]]
| calendartype
| /calendar/type
| Defines how dates are displayed throughout Moodle
| 2.6+
|-
| [[Messaging consumers]]
| message
| /message/output
| Represent various targets where messages and notifications can be sent to (email, sms, jabber, ...)
| 2.0+
|-
| [[Course formats]]
| format
| /course/format
| Different ways of laying out the activities and blocks in a course
| 1.3+
|-
| [[Data formats]]
| dataformat
| /dataformat
| Formats for data exporting and downloading
| 3.1+
|-
| [[User profile fields]]
| profilefield
| /user/profile/field
| Add new types of data to user profiles
| 1.9+
|-
| [[Reports]]
| report
| /report
| Provides useful views of data in a Moodle site for admins and teachers
| 2.2+
|-
| [[Course reports]]
| coursereport
| /course/report
| Reports of activity within the course
| Up to 2.1 (for 2.2+ see [[Reports]])
|-
| [[Gradebook export]]
| gradeexport
| /grade/export
| Export grades in various formats
| 1.9+
|-
| [[Gradebook import]]
| gradeimport
| /grade/import
| Import grades in various formats
| 1.9+
|-
| [[Gradebook reports]]
| gradereport
| /grade/report
| Display/edit grades in various layouts and reports
| 1.9+
|-
| [[Grading methods|Advanced grading methods]]
| gradingform
| /grade/grading/form
| Interfaces for actually performing grading in activity modules (eg Rubrics)
| 2.2+
|-
| [[MNet services]]
| mnetservice
| /mnet/service
| Allows to implement remote services for the [[MNet]] environment (deprecated, use web services instead)
| 2.0+
|-
| [[Webservice protocols]]
| webservice
| /webservice
| Define new protocols for web service communication (such as SOAP, XML-RPC, JSON, REST ...)
| 2.0+
|-
| [[Repository plugins]]
| repository
| /repository
| Connect to external sources of files to use in Moodle
| 2.0+
|-
| [[Portfolio plugins]]
| portfolio
| /portfolio
| Connect external portfolio services as destinations for users to store Moodle content
| 1.9+
|-
| [[Search engines]]
| search
| /search/engine
| Search engine backends to index Moodle's contents.
| 3.1+
|-
| [[Plagiarism plugins]]
| plagiarism
| /plagiarism
| Define external services to process submitted files and content
| 2.0+
|-
| [[Cache store]]
| cachestore
| /cache/stores
| Cache storage back-ends.
| 2.4+
|-
| [[Cache locks]]
| cachelock
| /cache/locks
| Cache lock implementations.
| 2.4+
|-
| [[Themes]]
| theme
| /theme
| Change the look of Moodle by changing the the HTML and the CSS.
| 2.0+
|-
| [[Local plugins]]
| local
| /local
| Generic plugins for local customisations
| 2.0+
|-
| [[Assignment types|Legacy assignment types]]
| assignment
| /mod/assignment/type
| Different forms of assignments to be graded by teachers
| 1.x - 2.2
|-
| [[Admin reports|Legacy admin reports]]
| report
| /admin/report
| Provides useful views of data in a Moodle site, for admins only.
| Up to 2.1 (for 2.2+ see [[Reports]])
|}

== Obtaining the list of plugin types known to your Moodle ==

To get the most exact list of types in your version of Moodle, use the following script. Put it to a file in the root directory of your Moodle installation and execute it via command line.

<code php>
<?php
define('CLI_SCRIPT', true);
require('config.php');

$pluginman = core_plugin_manager::instance();

foreach ($pluginman->get_plugin_types() as $type => $dir) {
$dir = substr($dir, strlen($CFG->dirroot));
printf("%-20s %-50s %s".PHP_EOL, $type, $pluginman->plugintype_name_plural($type), $dir);
}
</code>

==Things you can find in all plugins==

Although there are many different types of plugin, there are some things that work the same way in all plugin types, and we have [[Things that work the same in all plugin types|a page that describes them]].

Additionally you probably want to look at the page [[Plugin files]].

== Naming conventions ==

Warning if you have to choose a plugin (directory) name. The name is validated by the method <tt>lib/classes/component.php::is_valid_plugin_name()</tt> with a regexp: <tt>/^[a-z](?:[a-z0-9_](?!__))*[a-z0-9]+$/</tt>. In particular, the minus (-) character is not considered as valid, and the plugin will be silently ignored if the name is not valid.

There is an exception for [[Activity modules|activity modules]] that can not have the underscore in their name for legacy reasons.

== See also ==

* [[Guidelines_for_contributed_code|Guidelines for contributing code]]
* [[Core APIs]]
* [[Frankenstyle]]
* [http://moodle.org/plugins Moodle Plugins directory]

[[Category:Coding guidelines|Plugins]]
[[Category:Plugins]]

Moodle 3.1 release notes

2016-05-23T15:25:51Z

Kabalin: /* For developers */ Add antivirus plugin documentation link.

[[Releases]] > {{FULLPAGENAME}}

Release date: 23 May 2016

Here is [https://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+mdl+AND+resolution+%3D+fixed+AND+fixVersion+in+%28%223.1%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true the full list of fixed issues in 3.1].

See our [https://docs.moodle.org/31/en/New_features New Features page] for a more user-friendly introduction to Moodle 3.1 with screenshots.

If you are upgrading from previous version, make sure you read the [https://docs.moodle.org/31/en/Upgrading Upgrading] documentation.

==Server requirements==

These are just the minimum supported versions. We recommend keeping all of your software up-to-date.

* Moodle upgrade: Moodle 2.7 or later (if upgrading from earlier versions, you must upgrade to 2.7.14 as a first step)
* PHP version: minimum PHP 5.4.4 (always use latest PHP 5.4.x , 5.5.x or 5.6.x on Windows - http://windows.php.net/download/). PHP 7 is supported but has some [https://docs.moodle.org/dev/Moodle_and_PHP7#Can_I_use_PHP7_yet.3F engine limitations].
* Ghostscript should be installed for pdf annotation.
* Unoconv should be installed for file conversion used by pdf annotations (new in Moodle 3.1)
* '''New requirement for Moodle 3.1 comparing to 3.0''': PHP extension <tt>xmlreader</tt>

=== Database requirements ===

Moodle supports the following database servers. Again, version numbers are just the minimum supported version. We recommend running the latest stable version of any software.

{| class="nicetable"
|-
! Database
! Minimum version
! Recommended
|-
| [http://www.postgresql.org/ PostgreSQL]
| 9.1
| Latest
|-
| [http://www.mysql.com/ MySQL]
| 5.5.31
| Latest
|-
| [https://mariadb.org/ MariaDB]
| 5.5.31
| Latest
|-
| [http://www.microsoft.com/en-us/server-cloud/products/sql-server/ Microsoft SQL Server]
| 2008
| Latest
|-
| [http://www.oracle.com/us/products/database/overview/index.html Oracle Database]
| 10.2
| Latest
|}

==Client requirements==

=== Browser support ===

{| class="nicetable"
|-
! Browser
! Minimum version
! Recommended version
! Notes
|-
| [https://www.google.com/intl/en_au/chrome/browser/ Google Chrome]
| 30.0
| Latest
|
|-
| [http://www.mozilla.org/en-US/ Mozilla Firefox]
| 25.0
| Latest
|
|-
| [http://www.apple.com/safari/ Apple Safari]
| 6
| Latest
|
|-
| [http://windows.microsoft.com/en-AU/internet-explorer/download-ie Microsoft Internet Explorer]
| 9
| Latest
| Version 10 is required for drag-and-drop upload of content from outside the browser into Moodle
|}

==Major features==

===Highlights===

* MDL-53451 - Competencies support in Moodle
* MDL-52954 - Improvements to the Assignment grading user interface
* MDL-31989 - [https://docs.moodle.org/31/en/Global_search Global Search] API allows to search forums, wikis and other content throughout the whole site. [https://docs.moodle.org/31/en/Global_search Installation and setup] of SOLR server is required,
* MDL-52002 - Significant performance improvements in gradebook calculations
* MDL-48012 - [https://docs.moodle.org/31/en/Recycle_bin Recycle bin] plugin is now part of standard Moodle distribution: allow instructors to "undo" deletions of course modules and courses. [https://moodleassociation.org/ Moodle Users Association] project
* MDL-49279 - Add support in moodle plugins for exporting "[[Moodle Mobile Remote add-ons|Mobile app addons]]"

===Forum===

* MDL-372 - Allow to [https://docs.moodle.org/31/en/Using_Forum#Pinned_posts "pin" discussions] to keep them always on the top of the list
* MDL-34160 - Allow forum email subject to be customised
* MDL-47365 - Add [https://docs.moodle.org/31/en/Using_Forum#Permalinks permalink] option to forum posts
* MDL-51214 - Rename the News forum to [https://docs.moodle.org/31/en/Announcements "Announcements"]
* MDL-44087 - Forum does not observe message notification settings for digest emails
* MDL-53050 - Highlight the selected forum post when deep linking with a #anchor

===Assignment===

* MDL-52397 - Feedback for Assignments is not sent if the assignment grade timemodified setting was set to two days ago
* MDL-52596 - Add a 'maxperpage' site wide setting for grading table size (to mitigate broken grading pages in large courses)
* MDL-52269 - Not obvious to tell if an assignment is in blind marking if user holds the "mod/assign:viewblinddetails" capabilty
* MDL-52270 - Difficult to cross reference users with their blind identities
* MDL-44598 - List student names on 'grant extension' screen
* MDL-52490 - Download selected assign submissions as a zip file
* MDL-52290 - EditPDF - Also show the total page number in the pagination
* MDL-52489 - "Download all submissions as a zip" should maintain the folder structure in students submissions

===External tool (LTI)===

* MDL-52154 - Rework LTI admin screens
* MDL-45064 - Option to add Preconfigured LTI Tool to Activity Chooser
* MDL-52035 - Integrate LTI Provider support in Moodle as the [https://docs.moodle.org/31/en/Publish_as_LTI_tool Publish as LTI tool]
* MDL-52821 - Compliance: Send tool_consumer_instance_description in LTI launch request

===Feedback===

* MDL-53738 - Feedback activity module will be enabled by default in new 3.1 installations. If you are upgrading to 3.1 we recommend you to enable it manually.
* MDL-52094 - Various improvements to UI and bug fixes, including:
** Performance improvement to download responses as raw data in multiple formats (CSV, Excel, etc.) - now available on "Show responses" page instead of "Analysis"
** Allow any characters in labels, do not display empty labels
** Do not display empty pages
** Map frontpage feedback to multiple courses without leaving the form
** Improved display of automatic question numbers
** Disable "Response time" for anonymous feedbacks
** Use moodleforms to display feedback

===SCORM===

* MDL-45712 - Add Result field to the SCORM Interactions Report
* MDL-48680 - Add score and status submission events to SCORM activity
* MDL-42473 - Add group support to SCORM activity

===Quiz===

* MDL-52738 - Quiz attempt/review page should have a previous button to match next
* MDL-46092 - Add the OU styling of the Quiz navigation into Moodle core as the default
* MDL-46091 - Rationalise confirmations when you start a quiz
* MDL-52806 - Show right answers when manually grading automatically marked questions
* MDL-53304 - Immediate feedback behaviours should not show a disabled check button when you can't use it

===Other activity modules===

* MDL-42190 - Workshop: Possibility to delete a submission
* MDL-51306 - Folder: [https://docs.moodle.org/31/en/Folder_resource Bulk download all files within a folder activity as ZIP file]
* MDL-52414 - Lesson: Allow Default Settings for [https://docs.moodle.org/31/en/Lesson_settings Lesson Module Settings]
* MDL-51267 - URL/File: Make setting up a [https://docs.moodle.org/31/en/URL_resource_settings#General URL]/[https://docs.moodle.org/31/en/File_resource_settings#Uploading_files File] resource more obvious
* MDL-50794 - Workshop: [https://docs.moodle.org/31/en/Workshop_settings Restricting file types as attachments] to a workshop

===Gradebook===

* MDL-48634 - Option to rescale existing grades when changing max points
* MDL-52522 - grade_minmaxtouse should be respected for overridden categories
* MDL-51900 - Tab Down Grade Column in Single View of Gradebook
* MDL-52309 - Make Grade History report require user to submit parameters before the report starts running

===Performance===

* MDL-51374 - Do not purge entire databasemeta cache when there are structure changes (esp temp tables).
* MDL-51603 - Refactor downloading of csv, ods, excel etc files in reports and exports across moodle to stream progressively
* MDL-34925 - Improve bulk user export performance
* MDL-50385 - Performance improvement to the grade history report

===Tagging===

* MDL-50851 - Introduce tag collections - ability to separate independent tag areas
* MDL-52252 - Add tags to modules (Resources and Activities)
* MDL-25742 - Allow to search wiki pages by tags
* MDL-51283 - Rename "official" tags to "standard", allow admin to set for each tag area how to use standard tags
* MDL-16855 - Add tag filtering to "Manage tags" page
* MDL-52707 - Allow tags to be combined

===Usability===

* MDL-27628 - [https://docs.moodle.org/31/en/Course_meta_link Enrol meta:] Possible to add multiple courses without leaving the form
* MDL-51818 - Move the profile 'Message' button to be next to the user picture
* MDL-52258 - Calendar now shows duration in calendar block
* MDL-53043 - Move user search box above the students list in the manual enrolments popup
* MDL-35590 - Navigation block redesign to meet ARIA specification
* MDL-49963 - Allow to message all participants when there are more than one page in participants list
* MDL-51354 - Help popup and improved name for events dropdown menu on the course and site logs pages
* MDL-53026 - Use inplace editable for editing cohort names
* MDL-51706 - Move plagiarism links to the top of the summary and full text outputs
* MDL-53382 - "Show all" link on participants page should be moved beneath the page switcher

===Other improvements===

* MDL-53057 - Add [https://docs.moodle.org/31/en/File_system_repository#Using_a_File_System_repository_file search feature to the File system repository]
* MDL-48506 - Improve memcached cache store so that it is multi-site safe
* MDL-50661 - Restyle "Clean" theme to use Logo and Header in Frontpage with smaller logo option in other pages.
* MDL-36652 - When downloading an Excel spreadsheet of student logs, have the course short name included in the file name.
* MDL-53207 - Display stock avatar instead of own user picture from messages from fake users
* MDL-51698 - Markup the crumb trail so search engines understand it and leverage it
* MDL-53072 - Option to choose whether we include suspended users when auto-creating groups
* MDL-52869 - Convert inline activity name edit to use the inplace editable element

===For administrators===

* MDL-26935 - New capability to control role renaming
* MDL-28030 - Add config.php settings to allow plugins to rewrite output moodle_urls (eg clean / semantic urls)
* MDL-52752 - Administrators can specify an alternate URL to use for MathJax
* MDL-52219 - Completion tracking & availability should default to on for new installs
* MDL-52990 - Enable all emails to be themed, ie add 4 wrapper mustache templates
* MDL-53260 - Option to display CLI upgrade messages in English
* MDL-52386 - Allow to control field for flagging enabled/disabled users in LDAP authentication (useful for Active Directory)
* MDL-52383 - Calendar "Days to look ahead" should allow intervals up to 1 year
* MDL-49934 - Admins or managers should be able to retrieve assignments info via get_assignments web service

==Security issues==

There are no security issues included in this release, please refer to [https://docs.moodle.org/dev/Moodle_3.0.4_release_notes Moodle 3.0.4 release notes]

==For developers==

===Significant new areas===

* MDL-31989 - [https://docs.moodle.org/dev/Search_API Global Search] API allows to index and search forums, wikis and other content throughout the whole site.
* MDL-49279, MDL-50032 - Add support in moodle plugins for exporting "[[Moodle Mobile Remote add-ons|Mobile app addons]]"
* MDL-53451 - Competencies support in Moodle ([https://docs.moodle.org/dev/Competency_API documentation])
* MDL-50887 - Implement plugins infrastructure for antivirus and create ClamAV plugin ([https://docs.moodle.org/dev/Antivirus_plugins documentation]).
* MDL-51603 - New [https://docs.moodle.org/dev/Data_formats Dataformat] plugin type for downloading data as csv, ods, excel etc (eg from table_sql export)
* MDL-50851 - Significant changes to Tags API, tag areas can now implement callbacks to display tagged items ([https://docs.moodle.org/dev/Tag_API documentation])
* MDL-46891 - Upgrade to behat 3.x ([https://docs.moodle.org/dev/Acceptance_testing/Migrating_from_Behat_2.5_to_3.x_in_Moodle documentation])

===Smaller new things===

* MDL-51802 - Reusable element for inplace editing ([https://docs.moodle.org/dev/Inplace_editable documentation])
* MDL-30811 - Introduce notification stack to moodle sessions ([https://docs.moodle.org/dev/Notifications documentation])
* MDL-52237 - Add a callback to inject nodes in the user profile navigation
* MDL-51324 - New course chooser element for moodleforms ([https://docs.moodle.org/dev/lib/formslib.php_Form_Definition#autocomplete documentation])
* MDL-53311 - Reusable element for displaying tree similar to navigation tree ([https://docs.moodle.org/dev/Tree documentation])

===Smaller changes in core APIs===

* MDL-52954 - file_storage class can now convert between office documents ([https://docs.moodle.org/dev/File_API#Convert_between_file_formats_.28office_documents.29 documentation])
* MDL-53274 - Throw exception (in developer mode) if page context is not set, otherwise it is easily missed in AJAX calls
* MDL-52826, MDL-52715 - Allow to use moodleforms in AJAX requests ([https://docs.moodle.org/dev/Fragment documentation])
* MDL-51718 - Allow to specify scheme in moodle_url
* MDL-51700 - Ajax service should clean the return values of the external functions
* MDL-53962 - '''Changes to webservices XML-RPC API''' - it is now '''critical''' to specify parameters for XML-RPC calls in the correct order. Previously Zend may have been able to work out the order, our new implementation, at this stage, cannot.

===Themeability improvements===

* MDL-50464 - New renderer for RSS Client Block allows themes to customise its look

===Changes related to particular plugins===

* MDL-52013 - Allow mod_assign plugins to add calendar events
* MDL-48362 - Improve the enrol API to prevent logic in the UI ([https://docs.moodle.org/dev/Enrolment_plugins#Standard_Editing_UI documentation])
* MDL-52996 - Allow Atto customisation for special-purpose plugins
* MDL-52781 - Improved validation on user fields when creating users from external datasources
* MDL-53304 - Changes to interactive question behaviour may cause the unit tests for your question type to break if you have followed the common patter. You will need to make changes like [https://github.com/moodle/moodle/commit/81e47a35e8bb98a94ea88e45eee63dcda1b46f74#diff-d16a78021131604bb14ae59ebe6eeebbL235 this].

===Deprecations===

For full list of deprecations refer to lib/upgrade.txt and upgrade.txt files in the folder where the particular plugin is located. Here are the most major deprecations:

* MDL-49414 - Remove deprecated web services
* MDL-48621 - Deprecate the old events system
* MDL-52207 - Delete Zend framework

==See also==
*[[Moodle 3.0 release notes]]

[[Category:Release notes]]
[[Category:Moodle 3.1]]

[[fr:Notes de mise à jour de Moodle 3.1]]
[[es:Notas de Moodle 3.1]]

Antivirus plugins

2016-05-23T15:20:50Z

Kabalin: /* Example */

{{Moodle 3.1}}

== Introduction ==

Antivirus plugins implement virus scanning functionality in Moodle. This allows external contributor to develop plugins for different antivirus products and extend existing antivirus functionality to different areas of Moodle. The plugin for ClamAV antivirus tool is included in the core.

== History ==

Antivirus scanning using ClamAV has been initially introduced in Moodle 1.3 in the [https://github.com/moodle/moodle/commit/18b8fbfa patchset] committed by Penny Leach. Since that time, the code has been refactored a number of times to match File and Repository API changes, however always remained limited to ClamAV antivirus product. In Moodle 3.1 antivirus scanning has been re-introduced as a separate plugin type with ClamAV plugin included in the core.

== Current status ==

The antivirus functionality is ongoing work, covered in MDL-50886. It most likely there will be some more API changes in upcoming release.

== Example ==

The best example of antivirus plugin is ClamAV antivirus scanner plugin included in the core (<tt>[https://github.com/moodle/moodle/tree/MOODLE_31_STABLE/lib/antivirus/clamav /lib/antivirus/clamav]</tt>).

== File structure ==

All files for an antivirus plugin go within <tt>/lib/antivirus/name</tt>, where <tt>name</tt> is the name of the antivirus plugin, e.g. for ScanMyFile plugin used in examples below, the file structure will be as follows:

<code>
lib/antivirus/scanmyfile/
|-- classes
| `-- scanner.php
|-- db
| `-- upgrade.php
|-- lang
| `-- en
| `-- antivirus_scanmyfile.php
|-- settings.php
|-- tests
| `-- scanner_test.php
`-- version.php
</code>

=== version.php ===

Standard [[version.php]] for the plugin.

=== settings.php ===

Standard [[Admin_settings]] for the plugin configuration, make sure plugin configuration is stored in <tt>config_plugins</tt> table.

Example:

<code php>
if ($ADMIN->fulltree) {
$settings->add(new admin_setting_configexecutable('antivirus_scanmyfile/pathtoscanner',
new lang_string('pathtoscanner', 'antivirus_scanmyfile'), new lang_string('configpathtoscanner', 'antivirus_scanmyfile'), ''));
}
</code>

=== lang/en/antivirus_scanmyfile.php ===

Language strings for the plugin. Required strings:

* '''pluginname''' - name of plugin.

Example:

<code php>
$string['pluginname'] = 'SanMyFile antivirus';
$string['pathtoscanner'] = 'Path to scanner';
$string['configpathtoscanner'] = 'Define full path to scanner';
</code>

You will usually need to add your own strings for two main purposes:

* Adding configuration settings.
* Displaying information about scanning errors.

=== db (directory) ===

Standard upgrade/install routines for plugin.

=== classes/scanner.php ===

The file contains <tt>scanner</tt> class defined in <tt>antivirus_name</tt> namespace, that extends <tt>\core\antivirus\scanner</tt> class and implements the back-end for the antivirus scanning. It is expected that the class will contain at least two methods:

* <tt>is_configured()</tt> - returns true, if this antivirus plugin is configured.
* <tt>scan_file($file, $filename, $deleteinfected)</tt> - performs the ''$file'' scanning using antivirus functionality, using ''$filename'' as filename string in any reporting, deletes infected file if ''$deleteinfected'' is true.

It is expected that <tt>scan_file()</tt> function will throw exception of <tt>\core\antivirus\scanner_exception</tt> type if virus is found, otherwise will return ''void''.

The simplified example of scanner.php is shown below:

<code php>
// You must use the right namespace (matching your plugin antivirus name).
namespace antivirus_scanmyfile;

defined('MOODLE_INTERNAL') || die();

class scanner extends \core\antivirus\scanner {

public function is_configured() {
// Parent's get_config() function is effectively a wrapper of get_config('antivirus_scanmyfile', 'somesettingname') call.
return (bool)$this->get_config('pathtoscanner');
}

public function scan_file($file, $filename, $deleteinfected) {
if (!is_readable($file)) {
// This should not happen.
debugging('File is not readable.');
return;
}

// Execute the scan using antivirus own scanning tool, we assume it returns 0 if no virus is found, 1 if file is infected, any other number on error.
$return = $this->scan_file_using_scanmyfile_scanner_tool($file);

if ($return == 0) {
// Perfect, no problem found, file is clean.
return;
} else if ($return == 1) {
// Infection found.
if ($deleteinfected) {
unlink($file);
}
throw new \core\antivirus\scanner_exception('virusfounduser', '', array('filename' => $filename));
} else {
// Unknown problem.
debugging('Error occurred during file scanning.');
return;
}
}

public function scan_file_using_scanmyfile_scanner_tool($file) {
// Scanning routine using antivirus own tool goes here.
// ...
// For example purposes, we assume it returns 0 if no virus is found, 1 if file is infected, any other number on error.
return $return;
}
}
</code>

=== tests/scanner_test.php (optional) ===

Normally you would write a unit test for the antivirus plugin inside this file. Since plugin rely on external tool, it might be a good idea to replace real component with "double". See ClamAV plugin for example and PHPUnit [https://phpunit.de/manual/current/en/test-doubles.html manual section].

Antivirus plugins

2016-05-23T15:19:31Z

Kabalin: /* classes/scanner.php */

{{Moodle 3.1}}

== Introduction ==

Antivirus plugins implement virus scanning functionality in Moodle. This allows external contributor to develop plugins for different antivirus products and extend existing antivirus functionality to different areas of Moodle. The plugin for ClamAV antivirus tool is included in the core.

== History ==

Antivirus scanning using ClamAV has been initially introduced in Moodle 1.3 in the [https://github.com/moodle/moodle/commit/18b8fbfa patchset] committed by Penny Leach. Since that time, the code has been refactored a number of times to match File and Repository API changes, however always remained limited to ClamAV antivirus product. In Moodle 3.1 antivirus scanning has been re-introduced as a separate plugin type with ClamAV plugin included in the core.

== Current status ==

The antivirus functionality is ongoing work, covered in MDL-50886. It most likely there will be some more API changes in upcoming release.

== Example ==

The best example of antivirus plugin is ClamAV antivirus scanner plugin included in the core (<tt>/lib/antivirus/clamav</tt>).

== File structure ==

All files for an antivirus plugin go within <tt>/lib/antivirus/name</tt>, where <tt>name</tt> is the name of the antivirus plugin, e.g. for ScanMyFile plugin used in examples below, the file structure will be as follows:

<code>
lib/antivirus/scanmyfile/
|-- classes
| `-- scanner.php
|-- db
| `-- upgrade.php
|-- lang
| `-- en
| `-- antivirus_scanmyfile.php
|-- settings.php
|-- tests
| `-- scanner_test.php
`-- version.php
</code>

=== version.php ===

Standard [[version.php]] for the plugin.

=== settings.php ===

Standard [[Admin_settings]] for the plugin configuration, make sure plugin configuration is stored in <tt>config_plugins</tt> table.

Example:

<code php>
if ($ADMIN->fulltree) {
$settings->add(new admin_setting_configexecutable('antivirus_scanmyfile/pathtoscanner',
new lang_string('pathtoscanner', 'antivirus_scanmyfile'), new lang_string('configpathtoscanner', 'antivirus_scanmyfile'), ''));
}
</code>

=== lang/en/antivirus_scanmyfile.php ===

Language strings for the plugin. Required strings:

* '''pluginname''' - name of plugin.

Example:

<code php>
$string['pluginname'] = 'SanMyFile antivirus';
$string['pathtoscanner'] = 'Path to scanner';
$string['configpathtoscanner'] = 'Define full path to scanner';
</code>

You will usually need to add your own strings for two main purposes:

* Adding configuration settings.
* Displaying information about scanning errors.

=== db (directory) ===

Standard upgrade/install routines for plugin.

=== classes/scanner.php ===

The file contains <tt>scanner</tt> class defined in <tt>antivirus_name</tt> namespace, that extends <tt>\core\antivirus\scanner</tt> class and implements the back-end for the antivirus scanning. It is expected that the class will contain at least two methods:

* <tt>is_configured()</tt> - returns true, if this antivirus plugin is configured.
* <tt>scan_file($file, $filename, $deleteinfected)</tt> - performs the ''$file'' scanning using antivirus functionality, using ''$filename'' as filename string in any reporting, deletes infected file if ''$deleteinfected'' is true.

It is expected that <tt>scan_file()</tt> function will throw exception of <tt>\core\antivirus\scanner_exception</tt> type if virus is found, otherwise will return ''void''.

The simplified example of scanner.php is shown below:

<code php>
// You must use the right namespace (matching your plugin antivirus name).
namespace antivirus_scanmyfile;

defined('MOODLE_INTERNAL') || die();

class scanner extends \core\antivirus\scanner {

public function is_configured() {
// Parent's get_config() function is effectively a wrapper of get_config('antivirus_scanmyfile', 'somesettingname') call.
return (bool)$this->get_config('pathtoscanner');
}

public function scan_file($file, $filename, $deleteinfected) {
if (!is_readable($file)) {
// This should not happen.
debugging('File is not readable.');
return;
}

// Execute the scan using antivirus own scanning tool, we assume it returns 0 if no virus is found, 1 if file is infected, any other number on error.
$return = $this->scan_file_using_scanmyfile_scanner_tool($file);

if ($return == 0) {
// Perfect, no problem found, file is clean.
return;
} else if ($return == 1) {
// Infection found.
if ($deleteinfected) {
unlink($file);
}
throw new \core\antivirus\scanner_exception('virusfounduser', '', array('filename' => $filename));
} else {
// Unknown problem.
debugging('Error occurred during file scanning.');
return;
}
}

public function scan_file_using_scanmyfile_scanner_tool($file) {
// Scanning routine using antivirus own tool goes here.
// ...
// For example purposes, we assume it returns 0 if no virus is found, 1 if file is infected, any other number on error.
return $return;
}
}
</code>

=== tests/scanner_test.php (optional) ===

Normally you would write a unit test for the antivirus plugin inside this file. Since plugin rely on external tool, it might be a good idea to replace real component with "double". See ClamAV plugin for example and PHPUnit [https://phpunit.de/manual/current/en/test-doubles.html manual section].

Antivirus plugins

2016-05-23T15:18:37Z

Kabalin: /* classes/scanner.php */

{{Moodle 3.1}}

== Introduction ==

Antivirus plugins implement virus scanning functionality in Moodle. This allows external contributor to develop plugins for different antivirus products and extend existing antivirus functionality to different areas of Moodle. The plugin for ClamAV antivirus tool is included in the core.

== History ==

Antivirus scanning using ClamAV has been initially introduced in Moodle 1.3 in the [https://github.com/moodle/moodle/commit/18b8fbfa patchset] committed by Penny Leach. Since that time, the code has been refactored a number of times to match File and Repository API changes, however always remained limited to ClamAV antivirus product. In Moodle 3.1 antivirus scanning has been re-introduced as a separate plugin type with ClamAV plugin included in the core.

== Current status ==

The antivirus functionality is ongoing work, covered in MDL-50886. It most likely there will be some more API changes in upcoming release.

== Example ==

The best example of antivirus plugin is ClamAV antivirus scanner plugin included in the core (<tt>/lib/antivirus/clamav</tt>).

== File structure ==

All files for an antivirus plugin go within <tt>/lib/antivirus/name</tt>, where <tt>name</tt> is the name of the antivirus plugin, e.g. for ScanMyFile plugin used in examples below, the file structure will be as follows:

<code>
lib/antivirus/scanmyfile/
|-- classes
| `-- scanner.php
|-- db
| `-- upgrade.php
|-- lang
| `-- en
| `-- antivirus_scanmyfile.php
|-- settings.php
|-- tests
| `-- scanner_test.php
`-- version.php
</code>

=== version.php ===

Standard [[version.php]] for the plugin.

=== settings.php ===

Standard [[Admin_settings]] for the plugin configuration, make sure plugin configuration is stored in <tt>config_plugins</tt> table.

Example:

<code php>
if ($ADMIN->fulltree) {
$settings->add(new admin_setting_configexecutable('antivirus_scanmyfile/pathtoscanner',
new lang_string('pathtoscanner', 'antivirus_scanmyfile'), new lang_string('configpathtoscanner', 'antivirus_scanmyfile'), ''));
}
</code>

=== lang/en/antivirus_scanmyfile.php ===

Language strings for the plugin. Required strings:

* '''pluginname''' - name of plugin.

Example:

<code php>
$string['pluginname'] = 'SanMyFile antivirus';
$string['pathtoscanner'] = 'Path to scanner';
$string['configpathtoscanner'] = 'Define full path to scanner';
</code>

You will usually need to add your own strings for two main purposes:

* Adding configuration settings.
* Displaying information about scanning errors.

=== db (directory) ===

Standard upgrade/install routines for plugin.

=== classes/scanner.php ===

The file contains <tt>scanner</tt> class defined in <tt>antivirus_name</tt> namespace, that extends <tt>\core\antivirus\scanner</tt> class and implements the back-end for the antivirus scanning. It is expected that the class will contain at least two methods:

* <tt>is_configured()</tt> - returns true, if this antivirus plugin is configured.
* <tt>scan_file($file, $filename, $deleteinfected)</tt> - performs the ''$file'' scanning using antivirus functionality, using ''$filename'' as filename string in any reporting, deletes infected file if ''$deleteinfected'' is true.

It is expected that <tt>scan_file()</tt> function will throw exception of <tt>\core\antivirus\scanner_exception</tt> type if virus is found, otherwise will return ''void''.

The simplified example of scanner.php is shown below:

<code php>
// You must use the right namespace (matching your plugin antivirus name).
namespace antivirus_scanmyfile;

defined('MOODLE_INTERNAL') || die();

class scanner extends \core\antivirus\scanner {

public function is_configured() {
// Parent's get_config() function is effectively a wrapper of get_config('antivirus_scanmyfile', 'somesettingname') call.
return (bool)$this->get_config('pathtoscanner');
}

public function scan_file($file, $filename, $deleteinfected) {
if (!is_readable($file)) {
// This should not happen.
debugging('File is not readable.');
return;
}

// Execute the scan using antivirus own scanning tool, we assume it returns 0 if no virus is found, 1 if file is infected, any other number on error.
$return = scan_file_using_scanmyfile_scanner_tool($file);

if ($return == 0) {
// Perfect, no problem found, file is clean.
return;
} else if ($return == 1) {
// Infection found.
if ($deleteinfected) {
unlink($file);
}
throw new \core\antivirus\scanner_exception('virusfounduser', '', array('filename' => $filename));
} else {
// Unknown problem.
debugging('Error occurred during file scanning.');
return;
}
}

scan_file_using_scanmyfile_scanner_tool($file) {
// Scanning routine using antivirus own tool goes here.
// ...
// For example purposes, we assume it returns 0 if no virus is found, 1 if file is infected, any other number on error.
return $return;
}
}
</code>

=== tests/scanner_test.php (optional) ===

Normally you would write a unit test for the antivirus plugin inside this file. Since plugin rely on external tool, it might be a good idea to replace real component with "double". See ClamAV plugin for example and PHPUnit [https://phpunit.de/manual/current/en/test-doubles.html manual section].

Antivirus plugins

2016-05-23T15:14:45Z

Kabalin: /* lang/en/antivirus_scanmyfile.php */

{{Moodle 3.1}}

== Introduction ==

Antivirus plugins implement virus scanning functionality in Moodle. This allows external contributor to develop plugins for different antivirus products and extend existing antivirus functionality to different areas of Moodle. The plugin for ClamAV antivirus tool is included in the core.

== History ==

Antivirus scanning using ClamAV has been initially introduced in Moodle 1.3 in the [https://github.com/moodle/moodle/commit/18b8fbfa patchset] committed by Penny Leach. Since that time, the code has been refactored a number of times to match File and Repository API changes, however always remained limited to ClamAV antivirus product. In Moodle 3.1 antivirus scanning has been re-introduced as a separate plugin type with ClamAV plugin included in the core.

== Current status ==

The antivirus functionality is ongoing work, covered in MDL-50886. It most likely there will be some more API changes in upcoming release.

== Example ==

The best example of antivirus plugin is ClamAV antivirus scanner plugin included in the core (<tt>/lib/antivirus/clamav</tt>).

== File structure ==

All files for an antivirus plugin go within <tt>/lib/antivirus/name</tt>, where <tt>name</tt> is the name of the antivirus plugin, e.g. for ScanMyFile plugin used in examples below, the file structure will be as follows:

<code>
lib/antivirus/scanmyfile/
|-- classes
| `-- scanner.php
|-- db
| `-- upgrade.php
|-- lang
| `-- en
| `-- antivirus_scanmyfile.php
|-- settings.php
|-- tests
| `-- scanner_test.php
`-- version.php
</code>

=== version.php ===

Standard [[version.php]] for the plugin.

=== settings.php ===

Standard [[Admin_settings]] for the plugin configuration, make sure plugin configuration is stored in <tt>config_plugins</tt> table.

Example:

<code php>
if ($ADMIN->fulltree) {
$settings->add(new admin_setting_configexecutable('antivirus_scanmyfile/pathtoscanner',
new lang_string('pathtoscanner', 'antivirus_scanmyfile'), new lang_string('configpathtoscanner', 'antivirus_scanmyfile'), ''));
}
</code>

=== lang/en/antivirus_scanmyfile.php ===

Language strings for the plugin. Required strings:

* '''pluginname''' - name of plugin.

Example:

<code php>
$string['pluginname'] = 'SanMyFile antivirus';
$string['pathtoscanner'] = 'Path to scanner';
$string['configpathtoscanner'] = 'Define full path to scanner';
</code>

You will usually need to add your own strings for two main purposes:

* Adding configuration settings.
* Displaying information about scanning errors.

=== db (directory) ===

Standard upgrade/install routines for plugin.

=== classes/scanner.php ===

The file contains <tt>scanner</tt> class defined in <tt>antivirus_name</tt> namespace, that extends <tt>\core\antivirus\scanner</tt> class and implements the back-end for the antivirus scanning. It is expected that the class will contain at least two methods:

* <tt>is_configured()</tt> - returns true, if this antivirus plugin is configured.
* <tt>scan_file($file, $filename, $deleteinfected)</tt> - performs the ''$file'' scanning using antivirus functionality, using ''$filename'' as filename string in any reporting, deletes infected file if ''$deleteinfected'' is true.

It is expected that <tt>scan_file()</tt> function will throw exception of <tt>\core\antivirus\scanner_exception</tt> type if virus is found, otherwise will return ''void''.

The simplified example of scanner.php is shown below:

<code php>
// You must use the right namespace (matching your plugin antivirus name).
namespace antivirus_scanmyfile;

defined('MOODLE_INTERNAL') || die();

class scanner extends \core\antivirus\scanner {

public function is_configured() {
// Parent's get_config() function is effectively a wrapper of get_config('antivirus_scanmyfile', 'somesettingname') call.
return (bool)$this->get_config('pathtoscanner');
}

public function scan_file($file, $filename, $deleteinfected) {
if (!is_readable($file)) {
// This should not happen.
debugging('File is not readable.');
return;
}

// Execute the scan using antivirus own scanning tool, we assume it returns 0 if no virus is found, 1 if file is infected, any other number on error.
$return = scan_file_using_scanmyfile_scanner_tool($file);

if ($return == 0) {
// Perfect, no problem found, file is clean.
return;
} else if ($return == 1) {
// Infection found.
if ($deleteinfected) {
unlink($file);
}
throw new \core\antivirus\scanner_exception('virusfounduser', '', array('filename' => $filename));
} else {
// Unknown problem.
debugging('Error occurred during file scanning.');
return;
}
}
}
</code>

=== tests/scanner_test.php (optional) ===

Normally you would write a unit test for the antivirus plugin inside this file. Since plugin rely on external tool, it might be a good idea to replace real component with "double". See ClamAV plugin for example and PHPUnit [https://phpunit.de/manual/current/en/test-doubles.html manual section].

Antivirus plugins

2016-05-23T15:13:39Z

Kabalin: Created page with "{{Moodle 3.1}} == Introduction == Antivirus plugins implement virus scanning functionality in Moodle. This allows external contributor to develop plugins for different antiv..."

{{Moodle 3.1}}

== Introduction ==

Antivirus plugins implement virus scanning functionality in Moodle. This allows external contributor to develop plugins for different antivirus products and extend existing antivirus functionality to different areas of Moodle. The plugin for ClamAV antivirus tool is included in the core.

== History ==

Antivirus scanning using ClamAV has been initially introduced in Moodle 1.3 in the [https://github.com/moodle/moodle/commit/18b8fbfa patchset] committed by Penny Leach. Since that time, the code has been refactored a number of times to match File and Repository API changes, however always remained limited to ClamAV antivirus product. In Moodle 3.1 antivirus scanning has been re-introduced as a separate plugin type with ClamAV plugin included in the core.

== Current status ==

The antivirus functionality is ongoing work, covered in MDL-50886. It most likely there will be some more API changes in upcoming release.

== Example ==

The best example of antivirus plugin is ClamAV antivirus scanner plugin included in the core (<tt>/lib/antivirus/clamav</tt>).

== File structure ==

All files for an antivirus plugin go within <tt>/lib/antivirus/name</tt>, where <tt>name</tt> is the name of the antivirus plugin, e.g. for ScanMyFile plugin used in examples below, the file structure will be as follows:

<code>
lib/antivirus/scanmyfile/
|-- classes
| `-- scanner.php
|-- db
| `-- upgrade.php
|-- lang
| `-- en
| `-- antivirus_scanmyfile.php
|-- settings.php
|-- tests
| `-- scanner_test.php
`-- version.php
</code>

=== version.php ===

Standard [[version.php]] for the plugin.

=== settings.php ===

Standard [[Admin_settings]] for the plugin configuration, make sure plugin configuration is stored in <tt>config_plugins</tt> table.

Example:

<code php>
if ($ADMIN->fulltree) {
$settings->add(new admin_setting_configexecutable('antivirus_scanmyfile/pathtoscanner',
new lang_string('pathtoscanner', 'antivirus_scanmyfile'), new lang_string('configpathtoscanner', 'antivirus_scanmyfile'), ''));
}
</code>

=== lang/en/antivirus_scanmyfile.php ===

Language strings for the plugin. Required strings:

* '''pluginname''' - name of plugin.

Example:

<code php>
$string['pluginname'] = 'ClamAV antivirus';
$string['pathtoscanner'] = 'Path to scanner';
$string['configpathtoscanner'] = 'Define full path to scanner';
</code>

You will usually need to add your own strings for two main purposes:

* Adding configuration settings.
* Displaying information about scanning errors.

=== db (directory) ===

Standard upgrade/install routines for plugin.

=== classes/scanner.php ===

The file contains <tt>scanner</tt> class defined in <tt>antivirus_name</tt> namespace, that extends <tt>\core\antivirus\scanner</tt> class and implements the back-end for the antivirus scanning. It is expected that the class will contain at least two methods:

* <tt>is_configured()</tt> - returns true, if this antivirus plugin is configured.
* <tt>scan_file($file, $filename, $deleteinfected)</tt> - performs the ''$file'' scanning using antivirus functionality, using ''$filename'' as filename string in any reporting, deletes infected file if ''$deleteinfected'' is true.

It is expected that <tt>scan_file()</tt> function will throw exception of <tt>\core\antivirus\scanner_exception</tt> type if virus is found, otherwise will return ''void''.

The simplified example of scanner.php is shown below:

<code php>
// You must use the right namespace (matching your plugin antivirus name).
namespace antivirus_scanmyfile;

defined('MOODLE_INTERNAL') || die();

class scanner extends \core\antivirus\scanner {

public function is_configured() {
// Parent's get_config() function is effectively a wrapper of get_config('antivirus_scanmyfile', 'somesettingname') call.
return (bool)$this->get_config('pathtoscanner');
}

public function scan_file($file, $filename, $deleteinfected) {
if (!is_readable($file)) {
// This should not happen.
debugging('File is not readable.');
return;
}

// Execute the scan using antivirus own scanning tool, we assume it returns 0 if no virus is found, 1 if file is infected, any other number on error.
$return = scan_file_using_scanmyfile_scanner_tool($file);

if ($return == 0) {
// Perfect, no problem found, file is clean.
return;
} else if ($return == 1) {
// Infection found.
if ($deleteinfected) {
unlink($file);
}
throw new \core\antivirus\scanner_exception('virusfounduser', '', array('filename' => $filename));
} else {
// Unknown problem.
debugging('Error occurred during file scanning.');
return;
}
}
}
</code>

=== tests/scanner_test.php (optional) ===

Normally you would write a unit test for the antivirus plugin inside this file. Since plugin rely on external tool, it might be a good idea to replace real component with "double". See ClamAV plugin for example and PHPUnit [https://phpunit.de/manual/current/en/test-doubles.html manual section].

Deprecation

2015-03-12T15:59:59Z

Kabalin: /* Step 1. Immediate action */ Fix Coding style deprecated section link.

== What is deprecation? ==

[http://en.wikipedia.org/wiki/Deprecation Deprecation], in its programming sense, is the process of taking older code and marking it as no longer being useful within the codebase, usually because it has been superseded by newer code. The deprecated code is not immediately removed from the codebase because doing so may cause regression errors.

== Why is deprecation needed? ==

In an open source project, the end use of the codebase varies. People may have customisations and plugins that depend on a function that has been targeted for deprecation. Rather than simply removing a function, we must gracefully deprecate the function over a period covered by a number of released versions.

== Moodle Core deprecation process ==

Once it is decided that a function should be deprecated, a two-step process should be followed.

Note that both steps should always happen as earlier as possible in the 6-months period between major releases, so all developers will have time to adjust their code and ensure it will work in the next release. Obviously, no changes will be allowed after code freeze (the APIs must remain 100% unmodified after it).

Every deprecation should be documented in the corresponding upgrade.txt files '''at least''' once, but ideally both on initial deprecation and on final removal.

=== Step 1. Immediate action ===

Deprecation affects only the current master version, in other words, the deprecation only becomes affective after the next [[Releases|major release]].

* If the function is not a member of a class (in other words, it is an independent function), it should be moved, with its PHPDoc and all comments, to ''lib/deprecationlib.php'', which is included everywhere. If the function is a class member, it will need to be deprecated in its current location.
** Deprecated behat step definitions should be moved to lib/tests/behat/behat_deprecated.php, including a call to behat_deprecated::deprecated_message() proposing an alternative to the deprecated method.
* A debugging message should be added to the function so that, when [[:en:Debugging|developer debugging mode]] is on, attention is drawn to the deprecation. The message should state that the function being called has been deprecated. If the function has been replaced, the user should be directed to the alternative.

debugging('foobar() is deprecated, please use foobar::blah() instead.', DEBUG_DEVELOPER);

* If the deprecated function has been replaced with a new function, ideally the new function should be called from the deprecated function, so that the new functionality is used. This will make maintenance easier moving forward.
* A <tt>@deprecated</tt> tag should be added to the PHPDoc for the function description so that IDEs describing the function will note that it is deprecated, documenting which version it was deprecated in and the MDL issue associated with it. See the guidelines in [[Coding_style#.40deprecated_.28and_.40todo.29]].
* There will need to be an issue associated with the initial part of the deprecation. A second issue needs to be created to finish the job. The first issue will be linked to second issue. The second issue needs to be a sub-task of an appropriate [http://tracker.moodle.org/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=summary+%7E+%22meta+AND+deprecation%22+order+by+created&runQuery=true&clear=true deprecation META]. For example, if the current version is 2.3.2, the function will be marked as deprecated in 2.4 and should normally be removed for 2.6, so the second issue should be a subtask of a deprecation META for the 2.6 version (MDL-34434). This second issue should include instructions on how to remove the function so that when it comes time to do so, the task is trivial for any developer.
* A <tt>@todo</tt> tag can be added linking to the issues created for further action. (optional)
* A <tt>@see</tt> tag can be added to point to the new apis that can be used. (optional)

Longer deprecation periods can be considered for functions that are widely used.

=== Step 2. Final deprecation ===

* If a function has been marked as deprecated for 2.x (eg. 2.4) and set for removal at 2.x+2 (eg. 2.6), soon after the release of 2.x+1.1 (eg. 2.5.1), the 2.x+2 deprecation META will be processed. This means that the deprecated function will be removed before 2.x+2, but only in the master version. This allows any potential regressions caused by the removal of the function to be exposed as soon as possible.
* All content of the function is removed and in the skeleton that remains, an error statement should be included that reports that the function has been removed. You can direct developers to new function(s) in this message.

throw new coding_exception('check_potential_filename() can not be used any more, please use new file API');

* The PHPDoc for the function should have <tt>@param</tt> and <tt>@return</tt> tags removed to reduce the temptation for developers to consider using the function and make it obvious in IDEs that the function has been deprecated. The <tt>@deprecated</tt> tag should remain. When feasible the description should be removed as well, '''but do not remove the information about what you should use instead of the deprecated function'''.

== See also... ==

* [[Process]]
* [[Release process]]

[[Category:Processes]]
[[Category:Core development]]

HTML5 player

2015-03-10T13:36:41Z

Kabalin: /* Comparison Matrix */ Fix colspan for section fields.

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1110024
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 player with flash fallback for integration in Moodle and plan its implementation.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* [http://mediaelementjs.com/ MediaElement.js]
* ?Are there other alternatives?

== Comparison Matrix ==

{| class="nicetable"
|-
!
! [[#Flowplayer_HTML5|Flowplayer HTML5]]
! [[#Video.JS|Video.JS]]
! [[#Projekktor|Projekktor]]
! [[#MediaElement.js|MediaElement.js]]
! No Player
|-
! Accessible Player:
| colspan="5"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
| Yes
| unknown
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
| Yes
| Yes (see http://caniuse.com/webvtt)
|-
!
* Touch interface
| Yes
| Yes
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="5"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
| No
|-
!
* CSS customisation
| Yes
| Yes
| Yes
| Yes
| unknown
|-
!
* RTL support
| Yes
| No
| No
| Unknown (CSS, so I guess so...)
| Unknown
|-
! Mobile platforms:
| colspan="5"|
|-
!
* iOS
| Yes
| No
| Yes
| Yes
| Yes
|-
!
* Android
| Yes
| No
| Yes
| Yes
| Yes
|-
! Streaming protocols:
| colspan="5"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
| Yes
| No
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
| HLS
| Only in Chrome so far (Media Source Extension)
|-
! Audio player
| No
| Yes
| Yes
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
| style="border-bottom: 2px solid;" | Yes
| style="border-bottom: 2px solid;" | No
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
| MIT
| no extra code needed
|-
! JS library
| jQuery
| -
| jQuery
| jQuery
| none required
|-
! Plugins infrastructure
| No
| Yes
| Yes
| Yes
| No
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
| Flash and Silverlight (for .wmv support) fallback, used to provide the HTML5 video/audio elements.
| The Video tag can contain fallback content (e.g. Flash object) for browsers that don't support it at all (http://camendesign.com/code/video_for_everybody), but not based on codec support.
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* Poor documentation
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== MediaElement.js ===

'''Pros:'''
* Flash fall-forward - uses Flash/Silverlight to provide the HTML5 MediaElement API.
* Consistent HTML/CSS Player
* No logo on screen.

'''Cons:'''
* ...

'''Technical notes (lessons learned from the prototypes)'''

* ...

'''Missing features'''

* ...

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

=== HTML5 browser native ===

'''Pros:'''
* Simple

'''Cons:'''
* IE8 has no support

'''Technical notes'''
*

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=mediaelementjs MediaElement.js] version 2.6.14
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=native Native browser support].

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in [[#Flowplayer_HTML5|corresponding section above]], it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout, display platform incompatibility message prior to attempt to play, and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

In initial stage FlowPlayer HTML5 (or any other) will handle all existing HTML5 Video extensions as per core_media_player_html5video class, plus m3u8 (HLS). It will also be possible optionally to make flash files handled by HTML5 Video player as well (possibility of using existing flash FlowPlayer for flv files will remain).

== Mock-Ups/Prototypes ==

See [[#Sample_Pages|Sample pages]] section.

== Workaround ==

As intermediate solution, if you require player consistency throughout all browsers and platforms, you may consider using JW Player filter: https://github.com/lucisgit/moodle-filter_jwplayer Notice, that JW Player is not free for commercial use.

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]

HTML5 player

2015-03-10T11:28:05Z

Kabalin:

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1110024
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 player with flash fallback for integration in Moodle and plan its implementation.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* [http://mediaelementjs.com/ MediaElement.js]
* ?Are there other alternatives?

== Comparison Matrix ==

{| class="nicetable"
|-
!
! [[#Flowplayer_HTML5|Flowplayer HTML5]]
! [[#Video.JS|Video.JS]]
! [[#Projekktor|Projekktor]]
! [[#MediaElement.js|MediaElement.js]]
! No Player
|-
! Accessible Player:
| colspan="4"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
| Yes
| unknown
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
| Yes
| Yes (see http://caniuse.com/webvtt)
|-
!
* Touch interface
| Yes
| Yes
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="4"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
| No
|-
!
* CSS customisation
| Yes
| Yes
| Yes
| Yes
| unknown
|-
!
* RTL support
| Yes
| No
| No
| Unknown (CSS, so I guess so...)
| Unknown
|-
! Mobile platforms:
| colspan="4"|
|-
!
* iOS
| Yes
| No
| Yes
| Yes
| Yes
|-
!
* Android
| Yes
| No
| Yes
| Yes
| Yes
|-
! Streaming protocols:
| colspan="4"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
| Yes
| No
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
| HLS
| Only in Chrome so far (Media Source Extension)
|-
! Audio player
| No
| Yes
| Yes
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
| style="border-bottom: 2px solid;" | Yes
| style="border-bottom: 2px solid;" | No
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
| no extra code needed
| MIT
|-
! JS library
| jQuery
| -
| jQuery
| jQuery
| none required
|-
! Plugins infrastructure
| No
| Yes
| Yes
| Yes
| No
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
| Flash and Silverlight (for .wmv support) fallback, used to provide the HTML5 video/audio elements.
| The Video tag can contain fallback content (e.g. Flash object) for browsers that don't support it at all (http://camendesign.com/code/video_for_everybody), but not based on codec support.
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* Poor documentation
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

=== MediaElement.js ===

'''Pros:'''
* Flash fall-forward - uses Flash/Silverlight to provide the HTML5 MediaElement API.
* Consistent HTML/CSS Player
* No logo on screen.

'''Cons:'''
* ...

'''Technical notes (lessons learned from the prototypes)'''

* ...

'''Missing features'''

* ...

=== HTML5 browser native ===

'''Pros:'''
* Simple

'''Cons:'''
* IE8 has no support

'''Technical notes'''
*

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=mediaelementjs MediaElement.js] version 2.6.14
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=native Native browser support].

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in [[#Flowplayer_HTML5|corresponding section above]], it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout, display platform incompatibility message prior to attempt to play, and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

In initial stage FlowPlayer HTML5 (or any other) will handle all existing HTML5 Video extensions as per core_media_player_html5video class, plus m3u8 (HLS). It will also be possible optionally to make flash files handled by HTML5 Video player as well (possibility of using existing flash FlowPlayer for flv files will remain).

== Mock-Ups/Prototypes ==

See [[#Sample_Pages|Sample pages]] section.

== Workaround ==

As intermediate solution, if you require player consistency throughout all browsers and platforms, you may consider using JW Player filter: https://github.com/lucisgit/moodle-filter_jwplayer Notice, that JW Player is not free for commercial use.

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]

HTML5 player

2015-03-10T11:26:50Z

Kabalin: /* Sample Pages */ Add mediaelementjs sample page.

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1110024
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 player with flash fallback for integration in Moodle and plan its implementation.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* [http://mediaelementjs.com/ MediaElement.js]
* ?Are there other alternatives?

== Comparison Matrix ==

{| class="nicetable"
|-
!
! [[#Flowplayer_HTML5|Flowplayer HTML5]]
! [[#Video.JS|Video.JS]]
! [[#Projekktor|Projekktor]]
! [[#MediaElement.js|MediaElement.js]]
! No Player
|-
! Accessible Player:
| colspan="4"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
| Yes
| unknown
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
| Yes
| Yes (see http://caniuse.com/webvtt)
|-
!
* Touch interface
| Yes
| Yes
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="4"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
| No
|-
!
* CSS customisation
| Yes
| Yes
| Yes
| Yes
| unknown
|-
!
* RTL support
| Yes
| No
| No
| Unknown (CSS, so I guess so...)
| Unknown
|-
! Mobile platforms:
| colspan="4"|
|-
!
* iOS
| Yes
| No
| Yes
| Yes
| Yes
|-
!
* Android
| Yes
| No
| Yes
| Yes
| Yes
|-
! Streaming protocols:
| colspan="4"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
| Yes
| No
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
| HLS
| Only in Chrome so far (Media Source Extension)
|-
! Audio player
| No
| Yes
| Yes
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
| style="border-bottom: 2px solid;" | Yes
| style="border-bottom: 2px solid;" | No
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
| no extra code needed
| MIT
|-
! JS library
| jQuery
| -
| jQuery
| jQuery
| none required
|-
! Plugins infrastructure
| No
| Yes
| Yes
| Yes
| No
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
| Flash and Silverlight (for .wmv support) fallback, used to provide the HTML5 video/audio elements.
| The Video tag can contain fallback content (e.g. Flash object) for browsers that don't support it at all (http://camendesign.com/code/video_for_everybody), but not based on codec support.
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* Poor documentation
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== MediaElement.js ===

'''Pros:'''
* Flash fall-forward - uses Flash/Silverlight to provide the HTML5 MediaElement API.
* Consistent HTML/CSS Player
* No logo on screen.

'''Cons:'''
* ...

'''Technical notes (lessons learned from the prototypes)'''

* ...

'''Missing features'''

* ...

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

=== HTML5 browser native ===

'''Pros:'''
* Simple

'''Cons:'''
* IE8 has no support

'''Technical notes'''
*

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=mediaelementjs MediaElement.js] version 2.6.14
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=native Native browser support].

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in [[#Flowplayer_HTML5|corresponding section above]], it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout, display platform incompatibility message prior to attempt to play, and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

In initial stage FlowPlayer HTML5 (or any other) will handle all existing HTML5 Video extensions as per core_media_player_html5video class, plus m3u8 (HLS). It will also be possible optionally to make flash files handled by HTML5 Video player as well (possibility of using existing flash FlowPlayer for flv files will remain).

== Mock-Ups/Prototypes ==

See [[#Sample_Pages|Sample pages]] section.

== Workaround ==

As intermediate solution, if you require player consistency throughout all browsers and platforms, you may consider using JW Player filter: https://github.com/lucisgit/moodle-filter_jwplayer Notice, that JW Player is not free for commercial use.

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]

Acceptance testing

2015-02-03T11:34:59Z

Kabalin: /* Output formats */ Added a note about "-f pretty"

== Introduction ==
This page describes how we describe Moodle's functionalities and automatically test them.

Behat is a behavioural driven development (BDD) tool written in PHP, it can parse a human-readable list of sentences (called steps) and execute actions in a browser using Selenium or other tools to simulate user interactions.

For technical info: [[Behat integration]]

=== How it works ===
Behat parses and executes features files which describe Moodle's features (for example ''Post in a forum''). Each feature file is composed of many scenarios (for example ''Add a post to a discussion'' or ''Create a new discussion''), and finally each scenario is composed of steps (for example ''I press "Post to forum"'' or ''I should see "My post title"''). When the feature file is executed, every step internally is translated into a PHP method and is executed.

These features are executed nightly on the HQ servers using all the supported databases (MySQL, PostgreSQL, MSSQL and Oracle) and with different browsers (Firefox, Internet Explorer, Safari and Chrome) to avoid regressions and to test new functionalities.

=== Examples ===

Note that these snippets are only examples and may not work.

* There is a closed list of steps to use in the features, a feature written with the basic (or low-level) steps looks like this:
@auth
'''Feature''': Login
In order to login
As a moodle user
I need to be able to validate the username and password against moodle

'''Scenario''': Login as an existing user
Given I am on "login/index.php"
When I fill in "username" with "admin"
And I fill in "password" with "moodle"
And I press "loginbtn"
Then I should see "Moodle 101: Course Name"

'''Scenario''': Login as an unexisting user
Given I am on "login/index.php"
When I fill in "username" with "admin"
And I fill in "password" with "moodle"
And I press "loginbtn"
Then I should see "Moodle 101: Course Name"

Note that The 3 sentences below ''Feature: Login'' are only information about what we want to test.

These are simple scenarios, but most of Moodle's functionalities would require a huge list of this steps to test a scenario, imagine a ''Add a post to a discussion'' scenario; you need to login, create a course, create a user and enrol it in the course... Most of this steps is not what we intend to test in a ''Post in a forum'' feature, Moodle provides extra steps to quickly set up the context required to test a Moodle feature, for example:

@mod @mod_forum
'''Feature''': Add forum activities and discussions
In order to discuss topics with other users
As a moodle teacher
I need to add forum activities to moodle courses

'''Scenario''': Add a forum and a discussion
'''Given''' the following "users" exists:
| username | firstname | lastname | email |
| teacher1 | Teacher | 1 | teacher1@asd.com |
'''And''' the following "courses" exists:
| fullname | shortname | category |
| Course 1 | C1 | 0 |
'''And''' the following "course enrolments" exists:
| user | course | role |
| teacher1 | C1 | editingteacher |
'''And''' I log in as "teacher1"
'''And''' I follow "Course 1"
'''And''' I turn editing mode on
'''And''' I add a "Forum" to section "1" and I fill the form with:
| Forum name | Test forum name |
| Forum type | Standard forum for general use |
| Description | Test forum description |
'''When''' I add a new discussion to "Test forum name" forum with:
| Subject | Forum post subject |
| Message | This is the body |
'''Then''' I should see "Test forum name"

Note that:

* Each scenario is executed in an isolated testing environment, so the first step begins with an empty moodle site and what you set up in an scenario (like the ''Test forum name'' forum in the example above) is cleaned up after the scenario execution
* The prefixes "Given", "When" and "Then" are only informative and they are used to define the context (Given), specify the action (When) and check the results (Then), using them properly helps to understand what the scenario is testing.

== Quick start ==

This is a quick introduction to write a functional test (acceptance tests) using steps in a development/testing site, please DON'T USE THIS IN A PRODUCTION SITE.

To let you experience the pleasure of watching a feature file doing "your work" automatically in a real browser, this guide includes 2 optional steps to download Selenium and run it in another CLI.

# Open a command line interface
# '''cd /to/your/moodle/dirroot'''
# Edit config.php adding the following lines before the lib/setup.php include
#: <code language="text">$CFG->behat_prefix = 'b_';
$CFG->behat_dataroot = '/path/to/your/behat/dataroot/directory';
$CFG->behat_wwwroot = 'http://127.0.0.1'; // must be different from wwwroot
</code>
# '''curl http://getcomposer.org/installer | php''' (In case you have problems read https://docs.moodle.org/dev/Acceptance_testing#Installation)
# '''php admin/tool/behat/cli/init.php'''
# Download selenium-server-standalone-2.NN.N.jar from http://seleniumhq.org/download/, under "Selenium server (formerly the Selenium RC Server)"
# Open another command line interface and run '''java -jar /path/to/your/selenium/server/selenium-server-standalone-2.NN.N.jar'''
# '''vendor/bin/behat --config /path/to/your/behat/dataroot/directory/behat/behat.yml'''
# You just ran the current Moodle tests, now let's add your own test, add a blog entry for example
# Browse to your $CFG->behat_wwwroot, this is an empty test site and it is reset before each test (called scenario)
# From this point follow the steps you would follow to add manually a blog entry (login credentials are admin/admin)
# When you are done go to 'Site administration' -> 'Development' -> 'Acceptance testing', you will find the list of "actions" that can be run automatically, you can filter them to find what do you need to do (more steps can be added if you need, more info in https://docs.moodle.org/dev/Acceptance_testing#Adding_steps_definitions)
# To 'add a blog entry' we need to:
## Log in the system as a valid user
## Expand 'My profile' node of the navigation block
## Expand the 'Blogs' node of the navigation block
## Follow he 'Add a new entry' link
## Fill the moodle form with values for 'Entry title' and 'Blog entry body'
## Press the 'Save changes' button
## Verify you see the values you entered in the form and verify you are not in the form page
# This translated to steps is:
#: <code language="text">Given I log in as "admin"
And I expand "My profile" node
And I expand "Blogs" node
And I follow "Add a new entry"
And I set the following fields to these values:
| Entry title | I'm the name |
| Blog entry body | I'm the description |
When I press "Save changes"
Then I should see "User Blog"
And I should see "I'm the description"
And I should not see "Required"
</code>
# We need to wrap this steps following the behavior driven development guidelines (more info in https://docs.moodle.org/dev/Acceptance_testing#Writing_features)
#: <code language="text">
@core @core_blog
Feature: Add a blog entry
In order to let the world know about me
As a user
I need to write blog entries

@javascript
Scenario: Add a blog entry with valid data
Given I log in as "admin"
And I expand "My profile" node
And I expand "Blogs" node
And I follow "Add a new entry"
And I fill the moodle form with:
| Entry title | I'm the name |
| Blog entry body | I'm the description |
When I press "Save changes"
Then I should see "View all of my entries"
And I should see "I'm a description"
And I should not see "Required"
</code>
# And save it into a file, in this case '''blog/tests/behat/add_entry.feature'''
# '''php admin/tool/behat/cli/util.php --enable''' (This will update the available tests and steps definitions)
# '''vendor/bin/behat --config /path/to/your/behat/dataroot/directory/behat/behat.yml --tags @core_blog'''
# Selenium will open a browser (firefox by default) and you will see how the steps you have been writting are executed

You can also try to expand non existing nodes or change the 'Then' assertions to get a beautiful failure.

For detailed steps and/or troubleshooting:
* https://docs.moodle.org/dev/Acceptance_testing#Running_tests
* https://docs.moodle.org/dev/Acceptance_testing#Writing_features

== Requirements ==
* PHP 5.4 (see https://docs.moodle.org/dev/Acceptance_testing#Advanced_usage for PHP 5.3, only for non-production sites)
* Other dependencies are managed by the composer installer

== Installation ==
* Edit config.php
** Use $CFG->behat_dataroot to set the directory where behat test environment dataroot will be stored, something like '''$CFG->behat_dataroot = '/your/directory/path';'''. Ensure the directory can be created or have write permissions
** Use $CFG->behat_prefix to set the database prefix of the behat test environment database tables, something like '''$CFG->behat_prefix = 'behat_';'''
** Use $CFG->behat_wwwroot to set address to be used to access behat instance. It has to be different from $CFG->wwwroot, you can use for example localhost, 127.0.0.1 or any custom local host name specified in you /etc/hosts. If you use the built-in PHP server use "http://localhost:8000" or the value you set when you started it.
* Download composer
** '''cd /your/moodle/dirroot'''
** '''curl http://getcomposer.org/installer | php'''
*** If you don't have curl installed or you have problems running '''curl http://getcomposer.org/installer | php''':
**** Download '''http://getcomposer.org/installer'''
**** Store it in /your/moodle/dirroot/composerinstaller.php for example
**** Run it from /your/moodle/dirroot with '''php composerinstaller.php''', you can delete this file after running the next step ('''php composer.phar update --dev''')
* Install behat dependencies and enable the test environment
** '''cd /your/moodle/dirroot'''
** '''php admin/tool/behat/cli/init.php'''
* (Optional) If you want to run tests that involves Javascript (most of them) you will also need Selenium
** Download it from http://seleniumhq.org/download/, named "Selenium server (formerly the Selenium RC Server)"

== Verify your installation ==
* Test your installation by browsing your /admin/tool/behat/index.php page.
If you are using MAMP/WAMP/XAMPP and don't get the report working... then you need to ensure that your web servers knows where the PHP executable (commad line) is. To do that, edit the "envvars" file (usually under library/bin) and add to $PATH the path to your php executable. Then restart the apache server and try again.
For example, for MAMP you probably need to add:

<code php>
# Adding MAMP binaries communicate where CLI is
PATH="/Applications/MAMP/bin/php/php5.x.y/bin:$PATH"; export PATH
</code>

at the end of MAMP/Library/bin/envvars.

== Running tests ==
# (Optional) Start the PHP built-in web server if you configured the $CFG->behat_wwwroot to use it:
#* Open a command line interface and '''cd /to/your/moodle/dirroot'''
#* '''php -S localhost:8000''' (This is the test site URL that moodle uses by default, if you want to use another one you can override it in config.php with $CFG->behat_wwwroot attribute; more info in https://docs.moodle.org/dev/Acceptance_testing#Advanced_usage or config-dist.php)
# (Optional) Start the Selenium server (in case you want to run tests that involves Javascript)
#* (See http://www.installationpage.com/selenium/how-to-run-selenium-headless-firefox-in-ubuntu/ for running 'headless' Firefox and xvfm in a server environment)
#* Open another command line interface and '''java -jar /path/to/your/selenium/server/selenium-server-standalone-2.NN.N.jar'''
# Run Behat
#* '''vendor/bin/behat --config /path/to/your/CFG_behat_dataroot/behat/behat.yml''' (For more options '''vendor/bin/behat --help''' or http://docs.behat.org/guides/6.cli.html)
#* In case you don't want to run Javascript tests use the Behat tags option to skip them, '''vendor/bin/behat --tags ~@javascript --config /path/to/your/CFG_behat_dataroot/behat/behat.yml'''
#* If you followed all the steps and you receive an unknown weird error probably your system's Firefox version is not compatible with the Selenium version you are running, try downloading the latest Selenium release from it's website as explained above
# (Optional) If you are adding new tests or steps definitions update the tests list:
#* '''php admin/tool/behat/cli/util.php --enable'''
# (Optional) Disable test environment (if you want to prevent access to test environment)
#* '''php admin/tool/behat/cli/util.php --disable'''

'''Note that if you have the HTTP_PROXY environment variable set, which you may have had to do to run composer, then you also need to set NO_PROXY=localhost.'''

=== Tests filters ===
With the '''--tags''' or the '''-name''' Behat options you can filter which tests are going to run or which ones are going to be skipped. There are a few tags that you might be interested in:
* '''@javascript''': All the tests that runs in a browser using Javascript; they require Selenium to be running, otherwise an exception will be thrown.
* '''@_file_upload''': All the tests that involves file uploading or any OS feature that is not 100% part of the browser. They should only be executed when Selenium is running in the same machine where the tests are running.
* '''@_alert''': All the tests that involves Javascript dialogs (alerts, confirms...) are using a feature that is OS-dependant and out of the browser scope, so they should be tag appropriately as not all browsers manage them properly.
* '''@_switch_window''': All the tests that are using the '''I switch to "NAME" window''' step should be tagged as not all browsers manage them properly.
* '''@_switch_iframe''': All the tests that are using the '''I switch to "NAME" window''' steps should be tagged as it is an advanced feature and some browsers may have problems dealing with them
* '''@_cross_browser''': All the tests that should run against multiple combinations of browsers + OS in a regular basis. The features that are sensitive to different combinations of OS and browsers should be tagges as @_cross_browser.
* '''@componentname''': Moodle features uses the [https://docs.moodle.org/dev/Frankenstyle Frankenstyle] component name to tag the features according to the Moodle subsystem they belong to.

=== Output formats ===

If you want to see the failures immediately (rather than waiting ~3 hours for all the tests to finish) then either use the -v option to output a bit more information, or change the output format using --format. Format 'pretty' ('''-f pretty''') is sufficient for most cases, as it outputs each step outcomes in the command line making easier to see the progress.

== Run behat using different browsers ==

Following these instructions you can run behat in Firefox browser through Selenium, but you can run behat using different browsers through Selenium and even use phantomjs (Webkit). [[Acceptance_testing/Browsers|More info]]

== Advanced usage ==
There are a few settings for advanced use of Behat and execution in continuous integration systems, by default all this options are disabled, use this settings only if you know what you are doing.

* '''Different test server URL'''. If for example your are interested in allowing accesses from your local network because your Jenkins server is there you can set $CFG->behat_wwwroot to '''http://my.computer.local.ip:8000'''
* '''Behat configuration''', Moodle writes a behat.yml config file with info about the available tests and steps definitions along with other Behat parameters, you can override the Behat parameters we set and add your new parameters, your parameters will be merged with the Moodle ones giving priority to your values in case of conflict. This is useful for an advanced use of Behat, with multiple profiles, output formats, integration with continuous servers...
* '''Save screenshots of failures'''. You can use $CFG->behat_faildump_path to specify a directory where behat will generate a screenshot with the browser state each time a scenario fails. This is useful to detect where the problem was and work on a solution.
* '''Running with a browser other than Firefox''', by adding the following code to your config.php you can change the selected browser that is run when behat is invoked. In this case Chrome is selected, but internet explorer, firefox, iphone, android, chrome, htmlunit should be valid options. You will need to run '''php admin/tool/behat/cli/init.php''' for changes to take effect.

<code language="php">
$CFG->behat_config = array(
'default' => array(
'extensions' => array(
'Behat\MinkExtension\Extension' => array(
'selenium2' => array(
'browser' => 'chrome'
)
)
)
)
);
</code>

:Note that for Chrome, you will need the Selenium Chrome Driver (https://code.google.com/p/selenium/wiki/ChromeDriver), and it will need to be installed in the command search path.
* '''Switch completely to test environment''' option was removed in 2.7, it is recommended to always set $CFG->behat_wwwroot even in older versions instead.
* Note that when using cloud-based systems that can make use of non-standard capabilities like Saucelabs, you might want to provide configuration attributes containing the ''''-'''' character, which is automatically converted to ''''_'''' by the Symfony configuration manager that Behat is making use of (@see Symfony\Component\Config\Definition\Processor::normalizeKeys()) a way to avoid this restriction is to, adding to the vars you set like ''''max-duration'''' add the same var replacing dashes for underscores, this way the configuration manager will maintain the attribute containing dashes.
* '''Extra allowed settings''', moodle allows users to define many settings in config.php (see config-dist.php) when running the behat test site those settings are skipped to avoid interaction with the production environment, in case you are interested in allowing some of those extra settings to run the tests using a configuration similar to the one you are using in your production environment you can whitelist them adding them to $CFG->behat_extraallowedsettings (see config-dist.php for examples).
You can find more info and examples of how to use this settings in the config-dist.php file included in the Moodle codebase.

== Contributing ==

You can contribute the effort to automatically test all of Moodle's functionalities, please follow the [[contributor guide|https://docs.moodle.org/dev/Acceptance_testing/Contributing_automated_tests]]. Here you can find information about [[Acceptance_testing#Writing_features|how to write new features]] and [[Acceptance_testing#Adding_steps_definitions|how to write new step definitions]] if your changes requires a base change in the [https://github.com/moodlehq/moodle-behat-extension Moodle behat extension] you can find here how to do it following the integration workflow: https://docs.moodle.org/dev/Acceptance_testing/Contributing_to_Moodle_behat_extension.

== Writing features ==

All Moodle components and plugins (including 3rd party plugins) can specify their tests in .feature files using all the available steps.

Once you decided which functionality you want to specify as a feature you should:
# Select the most appropriate Moodle component to include your test and create a COMPONENTNAME/tests/behat/FEATURENAME.feature file
# Add a tag with the component name in Frankenstyle format (https://docs.moodle.org/dev/Frankenstyle) on the first line along with the plugin type or @core if it's a core subsystem
# Begin writing the user story of the feature, including in the 'As a ...' statement the main beneficiary of the feature:
#: <code lang="yaml">@plugintype @plugintype_pluginname
Feature: FEATURENAME
In order to ... // Why this feature is useful
As ... // It can be 'an admin', 'a teacher', 'a student', 'a guest', 'a user', 'a tests writer' and 'a developer'
I need to ... // The feature we want</code>
# From the beneficiary point of view, think of different scenarios to ensure the feature works as expected
# For each scenario you thought:
## Think of the initial context you need, for example ''1 course with 2 students on it and an assignment'', and which steps do you need to follow (interacting with the browser) to verify the scenario works as expected
## What you are testing requires Javascript? Think only on the feature you are testing (for example if you want to test that you can view your profile you don't need Javascript to click on a link and assert against plain HTML, but if you want to test something related with the course's gradebook you might want to test it with Javascript)
## Check the steps list (more info in https://docs.moodle.org/dev/Acceptance_testing#Available_steps) and set the initial context data (see https://docs.moodle.org/dev/Acceptance_testing#Fixtures for more info) and the steps to follow to verify all works as it should work.
## The prefixes ''Given'', ''When'' and ''Then'' separates the scenario in 3 parts, the initial context setup (''Given''), the action that provokes a change in the system (''When'') and the validation of that change outcomes (''Then'') So with a quick view at the scenario you can see what it is testing as the prefixes will be something like Given -> And -> And -> When -> And -> And -> Then -> And -> And -> And. Once we begin with the first ''Then'' we can consider that we are checking the outcomes so all the steps from there should be prefixed with ''Then''
## Copy the list of steps to the .feature file with the Scenario header:
##: <code lang="yaml">Scenario: Short description of the scenario
Given step 1
And step 2
And step 3
When step 4
And step 5
Then step 6</code>
## If the steps you are using requires Javascript add the @javascript tag above the "Scenario:" headline
##: <code lang="yaml">@javascript
Scenario: Short description of the scenario
...
...</code>
# Run the tests, when creating your new features/scenarios you can specify a '@wip' (work in progress) tag in both the line above the Scenario description and the tests runner (vendor/bin/behat) to execute only the new scenario instead of running the whole set of tests.
# Add extra tags to the scenario or the feature if required according to https://docs.moodle.org/dev/Acceptance_testing#Tests_filters

=== Available steps ===

Moodle provides a interface to list and filter the steps you can use when writing features. You can access it through the Administration block, following '''Site Administration''' -> '''Development''' -> '''Acceptance testing'''. It allows filtering by keyword, by the Moodle component or by the type of step:
* Processes to set up the environment
* Actions that provokes an event
* Checkings to ensure the outcomes are the expected ones

[[File:Acceptance_testing_UI_2.5.png]]

* This interface only works on sites where Behat is installed. If you are using the local PHP server, for example, you can access it on that site at http://localhost:8000 (log in as admin/admin).

=== Tips ===
* You can use a '''Background''' section before the '''Scenario''' sections, this steps will be executed before the steps of each scenario (http://docs.behat.org/guides/1.gherkin.html#backgrounds)
* You can use '''Scenario outlines''' if your scenarios are nearly the same and depends on a few vars; check out the link for an explicative example (http://docs.behat.org/guides/1.gherkin.html#scenario-outlines)
** If your scenario outline consists of many steps it may be useful to add a comment with the number of steps. If the the test fails behat will tell you in which step overall and you will have to divide by the number of steps of the scenario to know in which example.
* Is better to test the outcomes against the given data than against language strings, which are depending on the selected language.
* In case you need to interact with popup windows you need to switch to the window you want to interact with after opening it using the '''I switch to "popupwindowname" window''', close it when you finish interacting with it and return to the main window using '''I switch to main window'''
* The format of the .feature files is YAML which finds out the data hierarchy from the indentation of it's elements, so be sure that the elements are correctly nested and the indentation is correct using spaces when necessary

=== Providing values to steps ===
Most of the steps requires values, there are five methods to provide values to steps, the method depends on the step specification, you can know when a steps requires a value because you will see a drop down menu with a closed list of options that the step accepts as argument or an upper case string between double quotes, something like '''I press "BUTTON_STRING"''' or it ends with a ''':''' . The five methods are:
* '''A string/text'''; is the most common case, the texts are wrapped between double quotes (" character) you have to replace the info about the expected value for your value; for example something like '''I press "BUTTON_STRING"''' should become '''I press "Save and return to course"'''. If you want to add a string which contains a " character, you can escape it with \", for example '''I fill the "Name" field with "Alan alias \"the legend\""'''. You can identify this steps because they ends with '''_STRING'''
* '''A number'''; some steps requires numbers as values, to be more specific an undetermined number of digits from 0 to 9 (Natural numbers + 0) you can identify them because the expected value info string ends with '''_NUMBER'''
* '''A table'''; is a relation between values, the most common use of it is to fill forms. The steps which requires tables are easily identifiable because they finish with ''':''' The steps description gives info about what the table columns must contain, for example '''Fills a moodle form with field/value data'''. Here you don't need to escape the double quotes if you want to include them as part of the value.
* '''A field value'''; There are many different field types, if an argument requires a field value the expected value will depend on the field type:
** Text-based fields: It expects the text. This includes textareas, input type text, input type password...
** Checkbox: It expects 1 to check and for checked and "" to uncheck or for unchecked
** Select: It expects the option text or the option value. In case you interact with a multi-select you should specify the options separating them with commas. For example: '''option1, option2, option3'''
** Radio: The text of the radio option
* '''A selector'''; there are steps that can be used with different kinds of elements, for example '''I click on "User Name" "link"''' or '''I click on "User Name" "button"''' this is a closed list of elements, they always works together with another argument, where you specify the locator (eg. the link text in a link) In the 'Acceptance testing' interface you can see a drop-down menu to select one of these options:
** field - for searching a field by its id, name, value or label
** link - for searching a link by its href, id, title, img alt or value
** button - for searching a button by its name, id, value, img alt or title
** link_or_button - for searching for both, links and buttons
** select - for searching a select field by its id, name or label
** checkbox - for searching a checkbox by its id, name, or label
** radio - for searching a radio button by its id, name, or label
** file - for searching a file input by its id, name, or label
** optgroup - for searching optgroup by its label
** option - for searching an option by its content
** dialogue - for searching a dialogue with the specified header text
** filemanager - for searching a filemanager by it's id or label
** block - for searching a Moodle block by it's English name or it's frankenstyle name
** region - for searching a Moodle page region with that id, in fact it works with all the page's ids
** table_row - for searching a table row which contains the specified text
** table - for searching a table by its id or caption
** fieldset - for searching a fieldset by it's id or legend
** css_element - for searching an element by its CSS selector
** xpath_element - for searching an element by its XPath
* '''A text selector'''; similar to a selector but those are the elements that returns an area of the DOM, they are useful in steps following the format '''... in the "Community finder" "block"''' where you are clicking or looking for some text inside a specific area. In the 'Acceptance testing' interface you can see a drop-down menu to select one of these options:
** dialogue - for searching a dialogue with the specified header text
** block - for searching a Moodle block by it's English name or it's frankenstyle name
** region - for searching a Moodle page region with that id, in fact it works with all the page's ids
** table_row - for searching a table row which contains the specified text
** table - for searching a table by its id or caption
** fieldset - for searching a fieldset by it's id or legend
** css_element - for searching an element by its CSS selector
** xpath_element - for searching an element by its XPath

==== Uploading files ====
Note than some tests requires files to be uploaded, in this case
* The '''I upload "FILEPATH_STRING" file to "FILEPICKER_FIELD_STRING" filepicker''' step can be used when located in the form page
* The file to upload should be included along with the Moodle codebase in COMPONENTNAME/tests/fixtures/*
* The file to upload is specified by it's path, which should be relative to the codebase root ('''lib/tests/fixtures/users.csv''' for example)
* '''/''' should be used as directory separator and the file names can not include this '''/''' character as all of them would be converted to the OS-dependant directory separator to maintain the compatibility with Windows systems.
* The scenarios that includes files uploading should be tagged using the '''@_file_upload''' tag

==== Checking table values ====
You can check if specific value exists or not in a table row/column by using:
* Then "STRING_IN_ROW" row "COLUMN_HEADER" column of "TABLE_ID" table should contain "VALUE_TO_CHECK"
* Then the following should exist in the "TABLE_ID" table:
| COLUMN_HEADER1 | COLUMN_HEADER2 |
| VALUE_IN_ROW_1 | VALUE_IN_ROW_1 |
| VALUE_IN_ROW_2 | VALUE_IN_ROW_2 |

=== Fixtures ===

As seen in [[https://docs.moodle.org/dev/Acceptance_testing#Examples examples]] Moodle provides a way to quickly set up the contextual data (courses, users, enrolments...) that you need to properly test scenarios, this can be done using one of the site templates (TODO) or creating entities in the background section (common for all the steps) or in the "Given" part of your scenario. Note that this steps can only be used to set up the contextual data required to test the feature but they don't test what they are doing; for example, the "Given the following "users" exists" is not testing that Moodle is able to create a user, but to test that a user can add a blog entry you might want to use this step. For further info, acceptance tests are supposed to be black-boxed tests (the tester don't know about the internals of the application) and this steps are using internal Moodle data generators instead of running all the steps required to create a user or to create a course, which speeds up the test execution. There are other features to test that all this elements can be properly created.

==== Available elements ====
Most of the available elements can only be created in relation to other elements, to hide the complexity of the Moodle internals (references by contexts, ids...) the references can be done using more human-friendly mappings.

The examples below shows how to add elements referencing other elements, there are required fields to reference the elements, other attributes will be filled with random data if they are not specified.

* Course categories
** The required field is idnumber
** References between parent/children by their idnumber, using the "category" field
Given the following "categories" exist:
| name | category | idnumber |
| Category 1 | 0 | CAT1 |
| Category 2 | CAT1 | CAT2 |

* Courses
** The required field is shortname
** Uses the category idnumber as category reference
Given the following "courses" exist:
| fullname | shortname | category | format |
| Course 1 | COURSE1 | CAT1 | topics |
| Course 2 | COURSE2 | CAT2 | |

* Activities *(note that this step does not work with all kind of activities, only the ones that have data generators)*
** The required fields are activity, course and idnumber
** Uses activity to specify the activity type
** Uses the course shortname as course reference
** Other activity-dependant fields can be specified by it's field name
Given the following "activities" exist:
| activity | course | idnumber | name | intro |
| assign | C1 | assign1 | Test assignment name | Test assignment description |
| data | C1 | data1 | Test database name | Test database description |

* Groups
** The required fields are course and idnumber
** Uses the course shortname as course reference
Given the following "groups" exist:
| name | description | course | idnumber |
| Group 1 | Anything | COURSE1 | GROUP1 |

* Groupings
** The required fields are course and idnumber
** Uses the course shortname as course reference
Given the following "groupings" exist:
| name | course | idnumber |
| Grouping 1 | COURSE1 | GROUPING1 |
| Grouping 2 | COURSE1 | GROUPING2 |

* Users
** The required field is username (if password is not set username value will be used as password too)
Given the following "users" exist:
| username | email | firstname | lastname |
| testuser | asd@asd.com | Test | User |

* Course enrolments
** The required fields are user, course and role
** Uses the course shortname as course reference
** Uses the user username as user reference
** Uses the role shortname as role reference
** Uses the enrolment name as enrol reference
Given the following "course enrolments" exist:
| user | course | role | enrol |
| testuser | COURSE1 | editingteacher | manual |

* Roles
** The required field is shortname
** Uses a one of the following roles as archetype: manager, coursecreator, editingteacher, teacher, student, guest, user and frontpage
Given the following "roles" exist:
| shortname | name | description | archetype |
| custom1 | Custom Role 1 | | editingteacher |

* Role assigns
** The required fields are user, role, contextlevel and reference
** Uses the user username as user reference
** Uses the role shortname as role reference
** Uses contextlevel + reference to specify the context. See [[#Referencing_contexts]] for more info.
Given the following "role assigns" exist:
| user | role | contextlevel | reference |
| user1 | manager | System | |
| user2 | editingteacher | Category | CATEGORY1 |
| user3 | editingteacher | Course | COURSE1 |

* System role assigns (deprecated in favour of role assigns, see item right above this one)
** The required fields are user and role
** Uses the user username as user reference
** Uses the role shortname as role reference
Given the following "system role assigns" exist:
| user | role |
| testuser | manager |

* Permission overrides
** The required fields are capability, permissions, role, and the contextlevel + it's reference
** Uses contextlevel + reference to specify the context. See [[#Referencing_contexts]] for more info.
Given the following "permission overrides" exist:
| capability | permission | role | contextlevel | reference |
| mod/forum:editanypost | Allow | student | Course | C1 |
| mod/forum:replynews | Prevent | editingteacher | Course | C1 |
| mod/paquiro:sings | Prohibit | student | System | |

* Group members
** The required fields are user and group
** Uses the group idnumber as group reference
** Uses the user username as user reference
Given the following "group members" exist:
| user | group |
| testuser | GROUP1 |

* Grouping groups
** The required fields are grouping and group
** Uses the group idnumber as group reference
** Uses the grouping idnumber as grouping reference
Given the following "grouping groups" exist:
| grouping | group |
| GROUPING1 | GROUP1 |

* Cohorts
** The required field is idnumber
Given the following "cohorts" exist:
| name | idnumber |
| Cohort 1 | COHORT1 |

==== Referencing contexts ====

Moodle has different context levels, internally they have an identifier, but to reference them from steps we can use a more human way, using the level of the context (as specified below) and the reference, which will depend on the contextlevel we are using:
* contextlevel: '''System''', '''User''', '''Category''', '''Course''' or '''Activity module'''
* reference:
** System: Nothing, just leave the the cell empty
** User: The user '''username'''
** Category: The category '''idnumber'''
** Course: The course '''shortname'''
** Activity module: The activity '''idnumber'''

The data generators which makes use of these format are pointing to here.

=== Features check list ===
* It's a new feature or a new scenario of an existing feature
* Is using the '''Background''' section or '''Scenario Outlines''' instead of duplicating steps (only when applicable)
* Are using the appropriate Moodle component tag according to https://docs.moodle.org/dev/Acceptance_testing#Tests_filters
* The user story of the feature includes a valid stakeholder and makes sense according to https://docs.moodle.org/dev/Acceptance_testing#Writing_features
* Covers both JS and non-JS environments

== Adding steps definitions ==

Each Moodle component and plugin (including 3rd party plugins) can add new steps definitions. If you are writing tests and you notice that you are repeating the same group of steps you might want to create a new step definition that allows you to substitute the group of steps for one single step, something like ''I add a forum post with "blablabla" as description'' for example; also you can create whole new steps using the APIs provided by Behat and Mink if what you need to do is not covered by any of the available steps.

As commented in https://docs.moodle.org/dev/Acceptance_testing#Fixtures, this are black box tests, so we are not supposed to know about Moodle internals; translated to developer language it means don't use Moodle internals API calls, for example you should not try to cheat using a set_config() call, you should follow Moodle's user interface to reach the setting page and change it's value.

=== Example ===

You can use this example below or any of the existing steps definitions as a template.

* auth/tests/behat/behat_auth.php
class behat_auth extends behat_base {
/**
* Logs in the user. There should exist a user with the same value as username and password
*
* This second comment line will be not shown in the steps definitions list as it is only
* reading the first line in the comment block.
*
* @Given /^I log in as "(?P<username_string>(?:[^"]|\\")*)"$/
*/
public function i_log_in_as($username) {
return array(new Given('I am on homepage'),
new Given('I follow "' . get_string('login') . '"'),
new Given('I fill in "' . get_string('username') . '" with "' . $this->escape($username) . '"'),
new Given('I fill in "' . get_string('password') . '" with "'. $this->escape($username) . '"'),
new Given('I press "' . get_string('login') . '"')
);
}
}

=== Tips ===

If you are creating a completely new step definition there are also a few things to consider:
* Steps definitions should be compatible with both Javascript and non-Javascript tests, you can use $this->running_javascript() to deal with both
* The definition code will be executed by Behat, not by Moodle, you have to keep this in mind for example when throwing exceptions, Behat exceptions will give more info to the user about where is the problem
** You can find these exceptions in '''vendor/behat/mink/src/Behat/Mink/Exception/*'''
* Selenium is fast, sometimes it tries to interact with DOM elements or tries to execute actions that requires JS that are not loaded or ready to used; this is why, sometimes and randomly, you can see an "element not found" failure
** The quickest way to solve this problem is using behat_base::find*() methods (where the * corresponds to '''<nowiki>''</nowiki>''', '''_all''', or to a named selector preceded by '''_''', http://mink.behat.org/#named-selectors) which only requires the locator as argument. This methods will wait for the requested element to be ready or return an exception if the element is not found after the timeout value expires, you can also force the timeout value, which defaults to 6 seconds. An example of a named selector use is '''$button = $this->find_button("Save changes");''' if you are not sure about the element being available you always can wrap the find*() call in a try & catch.
** For advanced usages, the spin method is defined in '''lib/behat/behat_base::spin''', consider that all the contents of the closures passed to spin() can be executed more than once, so don't use irreversible actions that can invalidate the tests results (for example use find() methods but don't use click() methods)

If you create new steps definitions or tests you must run '''php admin/tool/behat/cli/util.php --enable''' to update the Behat config file before running '''vendor/bin/behat'''

=== Check list ===

New steps should be/have:
* Implemented as public methods of a PHP class whose name must begin with 'behat_' prefix and with '.php extension
* Using the class name as filename (adding the '.php' extension) and extending MOODLEDIRROOT/lib/behat/behat_base.php (or MOODLEDIRROOT/lib/behat/behat_files.php if it's a repository or is files-related)
* With a descriptive class name, for example the component name (it will be used when filtering steps definitions)
* Stored in COMPONENTNAME/tests/behat/ directory or lib/tests/behat/ if is not part of any other component
* Describe it's purpose in a single line inside the method doc comment, the size of the comment is not a problem
* Describe the regular expression with the most appropriate tag inside the method doc comment:
** '''@Given''' - A step to set up the initial context (for example ''the following "courses" exists'')
** '''@When''' - An action that provokes an event (for example ''I press the button "buttonname"'')
** '''@Then''' - Checkings to ensure the outcomes are the expected (for example ''I should see "whatever"'')
* Depending on the inputs your definition expects you must use a different regular expression:
** '''If you expect a number:''' "(?P<info_about_what_you_expect_number>\d+)" (note that the regular expression is quoted between '''"''')
** '''If you expect a string or a text:''' "(?P<info_about_what_you_expect_string>(?:[^"]|\\")*)" Don't use '''text_selector_string''' and '''selector_string''' as info strings, they are reserved to selector types (note that the regular expression is quoted between '''"''')
** '''If you expect a table with key/value pairs (for example to fill a form):''' Finish your regular expression with ''':''' and provide info in the description about the contents of the table
** '''If you expect a selector type:''' "(?P<selector_string>[^"]*)" or "(?P<text_selector_string>[^"]*)" depending on whether you want to use any selector or you want a text-based selector (more info about selectors in https://docs.moodle.org/dev/Acceptance_testing#Providing_values_to_steps)
* To make test writer's life better is good to include explicative info in the subexpressions of the regular expression about what the test writer is supposed to put in there (for example ''I expand "(?P<nodetext>(?:[^"]|\\")*)" node'')
* Is recommended to use the static part of the regular expression as the name of the method, using underscores instead of spaces (see current steps definitions)

== Troubleshooting ==

=== How can you tell if Selenium is running? ===

Try going to http://localhost:4444/selenium-server/. If Selenium is not running, nothing will happen. You will get a time-out. If selenium is running, you will get a 404 error page saying powered by Jetty at the bottom.

=== How can I stop Selenium? ===

Go to the URL http://localhost:4444/selenium-server/driver/?cmd=shutDownSeleniumServer. I think when it works it outputs "OKOK".

=== Behat tells me that lots of steps are undefined ===

You probably forgot the --config option in the behat command.

== Browser specific fixes ==

If you are interested in running behat in other browsers you might be interested on https://docs.moodle.org/dev/Acceptance_testing/Browsers

When running acceptance tests in conjunction with Selenium against Chrome, IE, or Safari there is a fix for the navigation bar that gets applied in order to avoid errors arising from a bug in the webdrivers for those browsers.

The issue: When an acceptance test goes to interact with an element on the page it first ensures that the element in the view-port and if not scrolls the browser to get the element into the view-port. If you are running against Chrome, IE, or Safari the browser scrolls the element only just inside the view-port. It doesn't however allow for any fixed position elements such as the navigation bar.
What happens: In some situations these browsers scroll up to reach a button, however not enough as the button ends up behind the navigation bar and cannot be interacted with.

Our solution: We can not change browser driver behaviour so we have integrated a work around. When running acceptance tests against one of these browsers we change the position attribute of the navigation bar from fixed to absolute. This is not ideal as it is not how the user experiences the site, however it allows us to run the full acceptance test suite against these browsers so we allowed it. A notice will be displayed when you start an acceptance test run if the browser specific fixes have been applied. See MDL-47734 / MDL-45231 for more details.

== See also ==

* Guidelines for contributors: [[Acceptance_testing/Contributing_automated_tests|Contributing automated tests]]
* Technical info: [[Behat integration]]
* Behat CLI command options: http://docs.behat.org/guides/6.cli.html
* How to use selectors to interact with the site elements: http://mink.behat.org/#traverse-the-page-selectors
[[Category:Behat]][[Category:Quality Assurance]]

[[es:Prueba de aceptación]]

Hackfest UK 2014

2014-06-16T09:39:18Z

Kabalin: /* HTML5 Player */

[[file:Hackfest_Logo_-_Narrow.png|202|right]]

[[Developer meetings]] > UK Hackfest April 2014

{| class="nicetable"
|-
| When
| Thursday 17 April, 2014
|-
| Where
| Moodlemoot Edinburgh, UK
|-
| Hashtag
| [https://twitter.com/search/%23mootuk14 #mootuk14]
|}

== What happened? ==

A Hackfest brings together Moodle developers to brainstorm future Moodle developments.

This hackfest had a group of around 40 developers. We met in Edinburgh on 17th April 2014 to discuss a range of topics (decided by the participants in unconference fashion), with the aim to distil knowledge into some blueprints for specifications of future Moodle features.

== Specifications ==

Specifications from subsequent work will be linked from here.

=== Element Library ===
* [[Render_library_specification|Specification]]
* [https://docs.google.com/document/d/1iisKZks8e_JqjpGTXip1dJ9hS29QsGG4mSomKcFGVRg/edit?usp=sharing Notes taken during Hackfest]
* Links
** [http://tracker.moodle.org/browse/MDL-36558 Tracker issue]
** [https://github.com/totara/moodle/tree/mdl-feature-element-library Example]
** [https://moodle.org/mod/forum/discuss.php?d=215807 Forum discussion]

=== Analytics ===
* [[Report_Builder_Specification|Specification]]
*[https://docs.google.com/document/d/1mlJjxewBOaZyQ14C0KIe5aV38hCmWF5aIQldlw-EwmU/edit?usp=sharing Notes taken during Hackfest]

=== LTI Usability Improvements ===
* [[LTI Usability Improvements|Specification]]
* [[Hackfest_UK_2014/LTI|Notes taken during Hackfest]] (Is this the start of a spec?)

=== Lesson activity module reboot ===
* [[Lesson activity module 2|Specification]]
* [https://docs.google.com/document/d/1XjiVY3ax9EuZ7gneofJR9z330rdI9bhD0yoOzt5tYRY/edit?usp=sharing Notes taken during Hackfest]

=== Email Logging and Reporting ===
* [[Email Logging and Reporting|Specification]]
* [[Hackfest_UK_2014/Email Logging|Notes taken during Hackfest]] (Is this the start of a spec?)

=== Bootstrap3 ===
* [[Bootstrap3|Specification]]
* [[Hackfest_UK_2014/Bootstrap3|Notes taken during Hackfest]] (Is this the start of a spec?)

=== HTML5 Player ===
* [https://docs.moodle.org/dev/HTML5_player Specification]
* [https://docs.google.com/document/d/11uOmoQdxZAy3dh-BHs7pkFFHyoUlQ8PD2SdxuhlDsK0/edit Notes taken during Hackfest]

=== Drag and Drop activities ===
* [[Drag and Drop activities|Specification]]
* [https://docs.google.com/document/d/15hme5Ky_YVQzks78HjDt8-kmZ3sT71WI4a_AK2LkSc8/edit Notes taken during Hackfest]

=== Add-ons Trust Model ===
* [[Add-ons trust model|Specification]] (This was more of an advisory brainstorm, perhaps a spec is not necessary.)
* [https://docs.google.com/document/d/1GTbTLHMfqMvB1N-lEDx_AybYRyN8M-RqIFjp5QDNLkk/edit Notes taken during Hackfest]

==Tools==

During the Hackfest, there was a session where developers named tools they were using. If you haven't heard of the tools below, you might want to check them out.

* PHP Xref
* Xdebug + IDE
* XHprof
* Code checker plugin
* PHPUnit
* MDK
* Moosh
* Grunt
* Git

== Other suggested topics ==

These are topics that were suggested, but were not chosen for sessions (unconference style), but may be worth future consideration.
* MUC best practice discussion
* Converter for Word docs to pages (possibly with drag-and-drop)
* Student > Group > Course > Qualification > Body hierarchy
* Internal verification and validation
* Course reset for blocks and local plugins
* RTL CSS as a separate file
* Global change data recorded on database tables
* In course search
* Resource tagging / Index
* Sharepoint integration repository
* Scheduled fileless backups
* How the OU does "View as student"
* Better way to hide activities, but have them available
* All communication via messaging sends multi-part emails
* "Safe" group membership upload/import
* Facebook style "Like" button or + and - buttons for ratings (MDL-45394)
* Blind marking issues for administrative users

Hackfest UK 2014

2014-05-09T08:37:26Z

Kabalin: Add tracker link for "Facebook style Like button"

[[file:Hackfest_Logo_-_Narrow.png|202|right]]

[[Developer meetings]] > UK Hackfest April 2014

{| class="nicetable"
|-
| When
| Thursday 17 April, 2014
|-
| Where
| Moodlemoot Edinburgh, UK
|-
| Hashtag
| [https://twitter.com/search/%23mootuk14 #mootuk14]
|}

== What happened? ==

A Hackfest brings together Moodle developers to brainstorm future Moodle developments.

This hackfest had a group of around 40 developers. We met in Edinburgh on 17th April 2014 to discuss a range of topics (decided by the participants in unconference fashion), with the aim to distil knowledge into some blueprints for specifications of future Moodle features.

== Specifications ==

Specifications from subsequent work will be linked from here.

=== Element Library ===
* [[Element library|Specification]]
* [https://docs.google.com/document/d/1iisKZks8e_JqjpGTXip1dJ9hS29QsGG4mSomKcFGVRg/edit?usp=sharing Notes taken during Hackfest]
* Links
** [http://tracker.moodle.org/browse/MDL-36558 Tracker issue]
** [https://github.com/totara/moodle/tree/mdl-feature-element-library Example]
** [https://moodle.org/mod/forum/discuss.php?d=215807 Forum discussion]

=== Analytics ===
* [[Analytics|Specification]]
*[https://docs.google.com/document/d/1mlJjxewBOaZyQ14C0KIe5aV38hCmWF5aIQldlw-EwmU/edit?usp=sharing Notes taken during Hackfest]

=== LTI Usability Improvements ===
* [[LTI Usability Improvements|Specification]]
* [[Hackfest_UK_2014/LTI|Notes taken during Hackfest]] (Is this the start of a spec?)

=== Lesson activity module reboot ===
* [[Lesson activity module 2|Specification]]
* [https://docs.google.com/document/d/1XjiVY3ax9EuZ7gneofJR9z330rdI9bhD0yoOzt5tYRY/edit?usp=sharing Notes taken during Hackfest]

=== Email Logging and Reporting ===
* [[Email Logging and Reporting|Specification]]
* [[Hackfest_UK_2014/Email Logging|Notes taken during Hackfest]] (Is this the start of a spec?)

=== Bootstrap3 ===
* [[Bootstrap3|Specification]]
* [[Hackfest_UK_2014/Bootstrap3|Notes taken during Hackfest]] (Is this the start of a spec?)

=== HTML5 Player ===
* [[HTML5 Player|Specification]]
* [https://docs.google.com/document/d/11uOmoQdxZAy3dh-BHs7pkFFHyoUlQ8PD2SdxuhlDsK0/edit Notes taken during Hackfest]

=== Drag and Drop activities ===
* [[Drag and Drop activities|Specification]]
* [https://docs.google.com/document/d/15hme5Ky_YVQzks78HjDt8-kmZ3sT71WI4a_AK2LkSc8/edit Notes taken during Hackfest]

=== Add-ons Trust Model ===
* [[Add-ons trust model|Specification]] (This was more of an advisory brainstorm, perhaps a spec is not necessary.)
* [https://docs.google.com/document/d/1GTbTLHMfqMvB1N-lEDx_AybYRyN8M-RqIFjp5QDNLkk/edit Notes taken during Hackfest]

==Tools==

During the Hackfest, there was a session where developers named tools they were using. If you haven't heard of the tools below, you might want to check them out.

* PHP Xref
* Xdebug + IDE
* XHprof
* Code checker plugin
* PHPUnit
* MDK
* Moosh
* Grunt
* Git

== Other suggested topics ==

These are topics that were suggested, but were not chosen for sessions (unconference style), but may be worth future consideration.
* MUC best practice discussion
* Converter for Word docs to pages (possibly with drag-and-drop)
* Student > Group > Course > Qualification > Body hierarchy
* Internal verification and validation
* Course reset for blocks and local plugins
* RTL CSS as a separate file
* Global change data recorded on database tables
* In course search
* Resource tagging / Index
* Sharepoint integration repository
* Scheduled fileless backups
* How the OU does "View as student"
* Better way to hide activities, but have them available
* All communication via messaging sends multi-part emails
* "Safe" group membership upload/import
* Facebook style "Like" button or + and - buttons for ratings (MDL-45394)
* Blind marking issues for administrative users

HTML5 player

2014-04-17T22:22:32Z

Kabalin: /* Comparison Matrix */

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1110024
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 player with flash fallback for integration in Moodle and plan its implementation.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* ?Are there other alternatives?

== Comparison Matrix ==

{| class="nicetable"
|-
!
! [[#Flowplayer_HTML5|Flowplayer HTML5]]
! [[#Video.JS|Video.JS]]
! [[#Projekktor|Projekktor]]
! No Player
|-
! Accessible Player:
| colspan="4"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
| unknown
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
| Yes
|-
!
* Touch interface
| Yes
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="4"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
| No
|-
!
* CSS customisation
| Yes
| Yes
| Yes
| unknown
|-
!
* RTL support
| Yes
| No
| No
| Unknown
|-
! Mobile platforms:
| colspan="4"|
|-
!
* iOS
| Yes
| No
| Yes
| Yes
|-
!
* Android
| Yes
| No
| Yes
| Yes
|-
! Streaming protocols:
| colspan="4"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
| No
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
| Only in Chrome so far (Media Source Extension)
|-
! Audio player
| No
| Yes
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
| style="border-bottom: 2px solid;" | No
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
| no extra code needed
|-
! JS library
| jQuery
| -
| jQuery
| none required
|-
! Plugins infrastructure
| No
| Yes
| Yes
| No
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
| VideoForEverybody can allow you to use any Flash player as fallback.
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* Poor documentation
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

=== HTML5 browser native ===

'''Pros:'''
* Simple

'''Cons:'''
* IE8 has no support

'''Technical notes'''
*

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in [[#Flowplayer_HTML5|corresponding section above]], it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout, display platform incompatibility message prior to attempt to play, and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

In initial stage FlowPlayer HTML5 (or any other) will handle all existing HTML5 Video extensions as per core_media_player_html5video class, plus m3u8 (HLS). It will also be possible optionally to make flash files handled by HTML5 Video player as well (possibility of using existing flash FlowPlayer for flv files will remain).

== Mock-Ups/Prototypes ==

See [[#Sample_Pages|Sample pages]] section.

== Workaround ==

As intermediate solution, if you require player consistency throughout all browsers and platforms, you may consider using JW Player filter: https://github.com/lucisgit/moodle-filter_jwplayer Notice, that JW Player is not free for commercial use.

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]

HTML5 player

2014-04-17T22:20:57Z

Kabalin:

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1110024
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 player with flash fallback for integration in Moodle and plan its implementation.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* ?Are there other alternatives?

== Comparison Matrix ==

{| class="nicetable"
|-
!
! [[#Flowplayer_HTML5|Flowplayer HTML5]]
! [[#Video.JS|Video.JS]]
! [[#Projekktor|Projekktor]]
! No Player
|-
! Accessible Player:
| colspan="4"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
| unknown
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
| Yes
|-
!
* Touch interface
| Yes
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="4"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
| No
|-
!
* CSS customisation
| Yes
| Yes
| Yes
| unknown
|-
!
* RTL support
| Yes
| No
| No
| Unknown
|-
! Mobile platforms:
| colspan="4"|
|-
!
* iOS
| Yes
| No
| Yes
| Yes
|-
!
* Android
| Yes
| No
| Yes
| Yes
|-
! Streaming protocols:
| colspan="4"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
| No
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
| Only in Chrome so far (Media Source Extension)
|-
! Audio player
| No
| Yes
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
| style="border-bottom: 2px solid;" | No
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
| no extra code needed
|-
! JS library
| jQuery
| -
| jQuery
| none required
|-
! Plugins infrastructure
| No
| Yes
| Yes
| No
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
| VideoForEverybody can allow you to use any Flash player as fallback.
|
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* Poor documentation
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

=== HTML5 browser native ===

'''Pros:'''
* Simple

'''Cons:'''
* IE8 has no support

'''Technical notes'''
*

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in [[#Flowplayer_HTML5|corresponding section above]], it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout, display platform incompatibility message prior to attempt to play, and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

In initial stage FlowPlayer HTML5 (or any other) will handle all existing HTML5 Video extensions as per core_media_player_html5video class, plus m3u8 (HLS). It will also be possible optionally to make flash files handled by HTML5 Video player as well (possibility of using existing flash FlowPlayer for flv files will remain).

== Mock-Ups/Prototypes ==

See [[#Sample_Pages|Sample pages]] section.

== Workaround ==

As intermediate solution, if you require player consistency throughout all browsers and platforms, you may consider using JW Player filter: https://github.com/lucisgit/moodle-filter_jwplayer Notice, that JW Player is not free for commercial use.

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]

HTML5 player

2014-04-17T22:20:15Z

Kabalin:

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1110024
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 player with flash fallback for integration in Moodle and plan its implementation.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* ?Are there other alternatives?

== Comparison Matrix ==

{| class="nicetable"
|-
!
! [[#Flowplayer_HTML5|Flowplayer HTML5]]
! [[#Video.JS|Video.JS]]
! [[#Projekktor|Projekktor]]
! No Player
|-
! Accessible Player:
| colspan="3"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
| unknown
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
| Yes
|-
!
* Touch interface
| Yes
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="3"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
| No
|-
!
* CSS customisation
| Yes
| Yes
| Yes
| unknown
|-
!
* RTL support
| Yes
| No
| No
| Unknown
|-
! Mobile platforms:
| colspan="3"|
|-
!
* iOS
| Yes
| No
| Yes
| Yes
|-
!
* Android
| Yes
| No
| Yes
| Yes
|-
! Streaming protocols:
| colspan="3"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
| No
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
| Only in Chrome so far (Media Source Extension)
|-
! Audio player
| No
| Yes
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
| style="border-bottom: 2px solid;" | No
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
| no extra code needed
|-
! JS library
| jQuery
| -
| jQuery
| none required
|-
! Plugins infrastructure
| No
| Yes
| Yes
| No
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
| VideoForEverybody can allow you to use any Flash player as fallback.
|
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* Poor documentation
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

=== HTML5 browser native ===

'''Pros:'''
* Simple

'''Cons:'''
* IE8 has no support

'''Technical notes'''
*

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in [[#Flowplayer_HTML5|corresponding section above]], it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout, display platform incompatibility message prior to attempt to play, and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

In initial stage FlowPlayer HTML5 (or any other) will handle all existing HTML5 Video extensions as per core_media_player_html5video class, plus m3u8 (HLS). It will also be possible optionally to make flash files handled by HTML5 Video player as well (possibility of using existing flash FlowPlayer for flv files will remain).

== Mock-Ups/Prototypes ==

See [[#Sample_Pages|Sample pages]] section.

== Workaround ==

As intermediate solution, if you require player consistency throughout all browsers and platforms, you may consider using JW Player filter: https://github.com/lucisgit/moodle-filter_jwplayer Notice, that JW Player is not free for commercial use.

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]

HTML5 player

2014-04-17T13:51:27Z

Kabalin:

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1110024
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 player with flash fallback for integration in Moodle and plan its implementation.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* ?Are there other alternatives?

{| class="nicetable"
|-
!
! [[#Flowplayer_HTML5|Flowplayer HTML5]]
! [[#Video.JS|Video.JS]]
! [[#Projekktor|Projekktor]]
! No Player
|-
! Accessible Player:
| colspan="3"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
|-
!
* Touch interface
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="3"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
|-
!
* CSS customisation
| Yes
| Yes
| Yes
|-
!
* RTL support
| Yes
| No
| No
|-
! Mobile platforms:
| colspan="3"|
|-
!
* iOS
| Yes
| No
| Yes
|-
!
* Android
| Yes
| No
| Yes
|-
! Streaming protocols:
| colspan="3"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
|-
! Audio player
| No
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
|-
! JS library
| jQuery
| -
| jQuery
|-
! Plugins infrastructure
| No
| Yes
| Yes
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* Poor documentation
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in [[#Flowplayer_HTML5|corresponding section above]], it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout, display platform incompatibility message prior to attempt to play, and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

In initial stage FlowPlayer HTML5 (or any other) will handle all existing HTML5 Video extensions as per core_media_player_html5video class, plus m3u8 (HLS). It will also be possible optionally to make flash files handled by HTML5 Video player as well (possibility of using existing flash FlowPlayer for flv files will remain).

== Mock-Ups/Prototypes ==

See [[#Sample_Pages|Sample pages]] section.

== Workaround ==

As intermediate solution, if you require player consistency throughout all browsers and platforms, you may consider using JW Player filter: https://github.com/lucisgit/moodle-filter_jwplayer Notice, that JW Player is not free for commercial use.

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]

Hackfest UK 2014

2014-04-17T13:12:35Z

Kabalin: /* Session 3 */

[[file:Hackfest_Logo_-_Narrow.png|202|right]]

[[Developer meetings]] > UK Hackfest April 2014

{| class="nicetable"
|-
| When
| Thu 14 April, 2014
|-
| Where
| Moodlemoot Edinburgh, UK
|-
| Alternate name
| Haven't come up with one yet
|-
| Hashtag
| [https://twitter.com/search/%23mootuk14 #mootuk14]
|}

== What happened? ==

A Hackfest brings together Moodle developers to brainstorm future Moodle developments.

A description of the activities at the Hackfest will be added here.

== Group notes ==

===Tools===

* Php Xref
* Xdebug + IDE
* XHprof
* codechecker
* PHPUnit
* MDK
* Moosh
* Grunt
* Git

==Specifications==

Specifications from subsequent work will be liked from here

=== Session 1 ===

* [https://docs.google.com/document/d/1iisKZks8e_JqjpGTXip1dJ9hS29QsGG4mSomKcFGVRg/edit?usp=sharing Moodle element library notes]
*[https://docs.google.com/document/d/1mlJjxewBOaZyQ14C0KIe5aV38hCmWF5aIQldlw-EwmU/edit?usp=sharing Moodle Analytics Notes]
* [[Hackfest_UK_2014/LTI|LTI Usability Improvements notes]]

=== Session 2 ===

* [https://docs.google.com/document/d/1XjiVY3ax9EuZ7gneofJR9z330rdI9bhD0yoOzt5tYRY/edit?usp=sharing Lesson refactoring notes]
* [[Hackfest_UK_2014/Email Logging|Email Logging Functionality and Reporting notes]]
* [[Hackfest_UK_2014/Bootstrap3|Bootstrap3 notes]]

=== Session 3 ===

* [https://docs.google.com/document/d/11uOmoQdxZAy3dh-BHs7pkFFHyoUlQ8PD2SdxuhlDsK0/edit | HTML5 Player notes]
* [[Add-ons trust model]]

Hackfest UK 2014

2014-04-17T13:11:28Z

Kabalin: /* Session 3 */

Hackfest UK 2014

2014-04-17T13:08:10Z

Kabalin: /* Session 3 */

Hackfest UK 2014

2014-04-17T13:07:47Z

Kabalin: /* Session 3 */

[[file:Hackfest_Logo_-_Narrow.png|202|right]]

[[Developer meetings]] > UK Hackfest April 2014

{| class="nicetable"
|-
| When
| Thu 14 April, 2014
|-
| Where
| Moodlemoot Edinburgh, UK
|-
| Alternate name
| Haven't come up with one yet
|-
| Hashtag
| [https://twitter.com/search/%23mootuk14 #mootuk14]
|}

== What happened? ==

A Hackfest brings together Moodle developers to brainstorm future Moodle developments.

A description of the activities at the Hackfest will be added here.

== Group notes ==

===Tools===

* Php Xref
* Xdebug + IDE
* XHprof
* codechecker
* PHPUnit
* MDK
* Moosh
* Grunt
* Git

==Specifications==

Specifications from subsequent work will be liked from here

=== Session 1 ===

* [https://docs.google.com/document/d/1iisKZks8e_JqjpGTXip1dJ9hS29QsGG4mSomKcFGVRg/edit?usp=sharing Moodle element library notes]
*[https://docs.google.com/document/d/1mlJjxewBOaZyQ14C0KIe5aV38hCmWF5aIQldlw-EwmU/edit?usp=sharing Moodle Analytics Notes]
* [[Hackfest_UK_2014/LTI|LTI Usability Improvements notes]]

=== Session 2 ===

* [https://docs.google.com/document/d/1XjiVY3ax9EuZ7gneofJR9z330rdI9bhD0yoOzt5tYRY/edit?usp=sharing Lesson refactoring notes]
* [[Hackfest_UK_2014/Email Logging|Email Logging Functionality and Reporting notes]]
* [[Hackfest_UK_2014/Bootstrap3|Bootstrap3 notes]]

=== Session 3 ===

[https://docs.google.com/document/d/11uOmoQdxZAy3dh-BHs7pkFFHyoUlQ8PD2SdxuhlDsK0/edit|HTML5 Player notes]

HTML5 player

2014-04-16T14:09:22Z

Kabalin: /* Work around */

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1110024
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 player with flash fallback for integration in Moodle and plan its implementation.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* ?Are there other alternatives?

{| class="nicetable"
|-
!
! [[#Flowplayer_HTML5|Flowplayer HTML5]]
! [[#Video.JS|Video.JS]]
! [[#Projekktor|Projekktor]]
|-
! Accessible Player:
| colspan="3"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
|-
!
* Touch interface
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="3"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
|-
!
* CSS customisation
| Yes
| Yes
| Yes
|-
!
* RTL support
| Yes
| No
| No
|-
! Mobile platforms:
| colspan="3"|
|-
!
* iOS
| Yes
| No
| Yes
|-
!
* Android
| Yes
| No
| Yes
|-
! Streaming protocols:
| colspan="3"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
|-
! Audio player
| No
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
|-
! JS library
| jQuery
| -
| jQuery
|-
! Plugins infrastructure
| No
| Yes
| Yes
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* Poor documentation
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in [[#Flowplayer_HTML5|corresponding section above]], it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout, display platform incompatibility message prior to attempt to play, and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

In initial stage FlowPlayer HTML5 (or any other) will handle all existing HTML5 Video extensions as per core_media_player_html5video class, plus m3u8 (HLS). It will also be possible optionally to make flash files handled by HTML5 Video player as well (possibility of using existing flash FlowPlayer for flv files will remain).

== Mock-Ups/Prototypes ==

See [[#Sample_Pages|Sample pages]] section.

== Workaround ==

As intermediate solution, if you require player consistency throughout all browsers and platforms, you may consider using JW Player filter: https://github.com/lucisgit/moodle-filter_jwplayer Notice, that JW Player is not free for commercial use.

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]

HTML5 player

2014-04-16T14:08:57Z

Kabalin: /* Alternatives */

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1110024
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 player with flash fallback for integration in Moodle and plan its implementation.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* ?Are there other alternatives?

{| class="nicetable"
|-
!
! [[#Flowplayer_HTML5|Flowplayer HTML5]]
! [[#Video.JS|Video.JS]]
! [[#Projekktor|Projekktor]]
|-
! Accessible Player:
| colspan="3"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
|-
!
* Touch interface
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="3"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
|-
!
* CSS customisation
| Yes
| Yes
| Yes
|-
!
* RTL support
| Yes
| No
| No
|-
! Mobile platforms:
| colspan="3"|
|-
!
* iOS
| Yes
| No
| Yes
|-
!
* Android
| Yes
| No
| Yes
|-
! Streaming protocols:
| colspan="3"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
|-
! Audio player
| No
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
|-
! JS library
| jQuery
| -
| jQuery
|-
! Plugins infrastructure
| No
| Yes
| Yes
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* Poor documentation
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in [[#Flowplayer_HTML5|corresponding section above]], it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout, display platform incompatibility message prior to attempt to play, and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

In initial stage FlowPlayer HTML5 (or any other) will handle all existing HTML5 Video extensions as per core_media_player_html5video class, plus m3u8 (HLS). It will also be possible optionally to make flash files handled by HTML5 Video player as well (possibility of using existing flash FlowPlayer for flv files will remain).

== Mock-Ups/Prototypes ==

See [[#Sample_Pages|Sample pages]] section.

== Work around ==

As intermediate solution, if you require player consistency throughout all browsers and platforms, you may consider using JW Player filter: https://github.com/lucisgit/moodle-filter_jwplayer Notice, that JW Player is not free for commercial use.

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]

HTML5 player

2014-04-16T14:08:23Z

Kabalin:

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1110024
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 player with flash fallback for integration in Moodle and plan its implementation.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* ?Are there other alternatives?

{| class="nicetable"
|-
!
! [[#Flowplayer_HTML5|Flowplayer HTML5]]
! [[#Video.JS|Video.JS]]
! [[#Projekktor|Projekktor]]
|-
! Accessible Player:
| colspan="3"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
|-
!
* Touch interface
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="3"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
|-
!
* CSS customisation
| Yes
| Yes
| Yes
|-
!
* RTL support
| Yes
| No
| No
|-
! Mobile platforms:
| colspan="3"|
|-
!
* iOS
| Yes
| No
| Yes
|-
!
* Android
| Yes
| No
| Yes
|-
! Streaming protocols:
| colspan="3"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
|-
! Audio player
| No
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
|-
! JS library
| jQuery
| -
| jQuery
|-
! Plugins infrastructure
| No
| Yes
| Yes
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* Poor documentation
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in [[#Flowplayer_HTML5|corresponding section above]], it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout, display platform incompatibility message prior to attempt to play, and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

In initial stage FlowPlayer HTML5 (or any other) will handle all existing HTML5 Video extensions as per core_media_player_html5video class, plus m3u8 (HLS). It will also be possible optionally to make flash files handled by HTML5 Video player as well (possibility of using existing flash FlowPlayer for flv files will remain).

== Mock-Ups/Prototypes ==

See [[#Sample_Pages|Sample pages]] section.

== Alternatives ==

As intermediate solution, if you require player consistency throughout all browsers and platforms, you may consider using JW Player filter: https://github.com/lucisgit/moodle-filter_jwplayer Notice, that JW Player is not free for commercial use.

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]

HTML5 player

2014-03-10T15:47:49Z

Kabalin: /* Project goals */

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1110024
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 player with flash fallback for integration in Moodle and plan its implementation.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* ?Are there other alternatives?

{| class="nicetable"
|-
!
! [[#Flowplayer_HTML5|Flowplayer HTML5]]
! [[#Video.JS|Video.JS]]
! [[#Projekktor|Projekktor]]
|-
! Accessible Player:
| colspan="3"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
|-
!
* Touch interface
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="3"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
|-
!
* CSS customisation
| Yes
| Yes
| Yes
|-
!
* RTL support
| Yes
| No
| No
|-
! Mobile platforms:
| colspan="3"|
|-
!
* iOS
| Yes
| No
| Yes
|-
!
* Android
| Yes
| No
| Yes
|-
! Streaming protocols:
| colspan="3"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
|-
! Audio player
| No
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
|-
! JS library
| jQuery
| -
| jQuery
|-
! Plugins infrastructure
| No
| Yes
| Yes
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* Poor documentation
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in [[#Flowplayer_HTML5|corresponding section above]], it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout, display platform incompatibility message prior to attempt to play, and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

In initial stage FlowPlayer HTML5 (or any other) will handle all existing HTML5 Video extensions as per core_media_player_html5video class, plus m3u8 (HLS). It will also be possible optionally to make flash files handled by HTML5 Video player as well (possibility of using existing flash FlowPlayer for flv files will remain).

== Mock-Ups/Prototypes ==

See [[#Sample_Pages|Sample pages]] section.

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]

HTML5 player

2014-03-10T15:45:36Z

Kabalin:

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1110024
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 with flash fallback for integration in Moodle.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* ?Are there other alternatives?

{| class="nicetable"
|-
!
! [[#Flowplayer_HTML5|Flowplayer HTML5]]
! [[#Video.JS|Video.JS]]
! [[#Projekktor|Projekktor]]
|-
! Accessible Player:
| colspan="3"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
|-
!
* Touch interface
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="3"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
|-
!
* CSS customisation
| Yes
| Yes
| Yes
|-
!
* RTL support
| Yes
| No
| No
|-
! Mobile platforms:
| colspan="3"|
|-
!
* iOS
| Yes
| No
| Yes
|-
!
* Android
| Yes
| No
| Yes
|-
! Streaming protocols:
| colspan="3"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
|-
! Audio player
| No
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
|-
! JS library
| jQuery
| -
| jQuery
|-
! Plugins infrastructure
| No
| Yes
| Yes
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* Poor documentation
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in [[#Flowplayer_HTML5|corresponding section above]], it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout, display platform incompatibility message prior to attempt to play, and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

In initial stage FlowPlayer HTML5 (or any other) will handle all existing HTML5 Video extensions as per core_media_player_html5video class, plus m3u8 (HLS). It will also be possible optionally to make flash files handled by HTML5 Video player as well (possibility of using existing flash FlowPlayer for flv files will remain).

== Mock-Ups/Prototypes ==

See [[#Sample_Pages|Sample pages]] section.

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]

HTML5 player

2014-03-10T15:37:14Z

Kabalin: /* Sub Tasks */

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1105373
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 with flash fallback for integration in Moodle.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* ?Are there other alternatives?

{| class="nicetable"
|-
!
! [[#Flowplayer_HTML5|Flowplayer HTML5]]
! [[#Video.JS|Video.JS]]
! [[#Projekktor|Projekktor]]
|-
! Accessible Player:
| colspan="3"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
|-
!
* Touch interface
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="3"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
|-
!
* CSS customisation
| Yes
| Yes
| Yes
|-
!
* RTL support
| Yes
| No
| No
|-
! Mobile platforms:
| colspan="3"|
|-
!
* iOS
| Yes
| No
| Yes
|-
!
* Android
| Yes
| No
| Yes
|-
! Streaming protocols:
| colspan="3"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
|-
! Audio player
| No
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
|-
! JS library
| jQuery
| -
| jQuery
|-
! Plugins infrastructure
| No
| Yes
| Yes
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* Poor documentation
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in [[#Flowplayer_HTML5|corresponding section above]], it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout, display platform incompatibility message prior to attempt to play, and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

In initial stage FlowPlayer HTML5 (or any other) will handle all existing HTML5 Video extensions as per core_media_player_html5video class, plus m3u8 (HLS). It will also be possible optionally to make flash files handled by HTML5 Video player as well (possibility of using existing flash FlowPlayer for flv files will remain).

== Mock-Ups/Prototypes ==

See [[#Sample_Pages|Sample pages]] section.

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]

HTML5 player

2014-03-10T14:46:10Z

Kabalin: /* Candidates */

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1105373
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 with flash fallback for integration in Moodle.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* ?Are there other alternatives?

{| class="nicetable"
|-
!
! [[#Flowplayer_HTML5|Flowplayer HTML5]]
! [[#Video.JS|Video.JS]]
! [[#Projekktor|Projekktor]]
|-
! Accessible Player:
| colspan="3"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
|-
!
* Touch interface
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="3"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
|-
!
* CSS customisation
| Yes
| Yes
| Yes
|-
!
* RTL support
| Yes
| No
| No
|-
! Mobile platforms:
| colspan="3"|
|-
!
* iOS
| Yes
| No
| Yes
|-
!
* Android
| Yes
| No
| Yes
|-
! Streaming protocols:
| colspan="3"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
|-
! Audio player
| No
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
|-
! JS library
| jQuery
| -
| jQuery
|-
! Plugins infrastructure
| No
| Yes
| Yes
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* Poor documentation
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in [[#Flowplayer_HTML5|corresponding section above]], it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout, display platform incompatibility message prior to attempt to play, and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

== Mock-Ups/Prototypes ==

See [[#Sample_Pages|Sample pages]] section.

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]

HTML5 player

2014-03-10T14:44:54Z

Kabalin: /* Video.JS */

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1105373
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 with flash fallback for integration in Moodle.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* ?Are there other alternatives?

{| class="nicetable"
|-
!
! Flowplayer HTML5
! Video.JS
! Projekktor
|-
! Accessible Player:
| colspan="3"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
|-
!
* Touch interface
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="3"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
|-
!
* CSS customisation
| Yes
| Yes
| Yes
|-
!
* RTL support
| Yes
| No
| No
|-
! Mobile platforms:
| colspan="3"|
|-
!
* iOS
| Yes
| No
| Yes
|-
!
* Android
| Yes
| No
| Yes
|-
! Streaming protocols:
| colspan="3"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
|-
! Audio player
| No
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
|-
! JS library
| jQuery
| -
| jQuery
|-
! Plugins infrastructure
| No
| Yes
| Yes
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* Poor documentation
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in [[#Flowplayer_HTML5|corresponding section above]], it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout, display platform incompatibility message prior to attempt to play, and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

== Mock-Ups/Prototypes ==

See [[#Sample_Pages|Sample pages]] section.

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]

HTML5 player

2014-03-10T14:44:16Z

Kabalin: /* Mock-Ups/Prototypes */

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1105373
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 with flash fallback for integration in Moodle.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* ?Are there other alternatives?

{| class="nicetable"
|-
!
! Flowplayer HTML5
! Video.JS
! Projekktor
|-
! Accessible Player:
| colspan="3"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
|-
!
* Touch interface
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="3"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
|-
!
* CSS customisation
| Yes
| Yes
| Yes
|-
!
* RTL support
| Yes
| No
| No
|-
! Mobile platforms:
| colspan="3"|
|-
!
* iOS
| Yes
| No
| Yes
|-
!
* Android
| Yes
| No
| Yes
|-
! Streaming protocols:
| colspan="3"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
|-
! Audio player
| No
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
|-
! JS library
| jQuery
| -
| jQuery
|-
! Plugins infrastructure
| No
| Yes
| Yes
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* Poor documentation
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in [[#Flowplayer_HTML5|corresponding section above]], it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout, display platform incompatibility message prior to attempt to play, and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

== Mock-Ups/Prototypes ==

See [[#Sample_Pages|Sample pages]] section.

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]

HTML5 player

2014-03-10T10:52:39Z

Kabalin: /* Video.JS */

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1105373
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 with flash fallback for integration in Moodle.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* ?Are there other alternatives?

{| class="nicetable"
|-
!
! Flowplayer HTML5
! Video.JS
! Projekktor
|-
! Accessible Player:
| colspan="3"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
|-
!
* Touch interface
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="3"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
|-
!
* CSS customisation
| Yes
| Yes
| Yes
|-
!
* RTL support
| Yes
| No
| No
|-
! Mobile platforms:
| colspan="3"|
|-
!
* iOS
| Yes
| No
| Yes
|-
!
* Android
| Yes
| No
| Yes
|-
! Streaming protocols:
| colspan="3"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
|-
! Audio player
| No
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
|-
! JS library
| jQuery
| -
| jQuery
|-
! Plugins infrastructure
| No
| Yes
| Yes
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* Poor documentation
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in [[#Flowplayer_HTML5|corresponding section above]], it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout, display platform incompatibility message prior to attempt to play, and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

== Mock-Ups/Prototypes ==

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]

HTML5 player

2014-03-10T10:51:28Z

Kabalin: /* Discussion */

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1105373
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 with flash fallback for integration in Moodle.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* ?Are there other alternatives?

{| class="nicetable"
|-
!
! Flowplayer HTML5
! Video.JS
! Projekktor
|-
! Accessible Player:
| colspan="3"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
|-
!
* Touch interface
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="3"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
|-
!
* CSS customisation
| Yes
| Yes
| Yes
|-
!
* RTL support
| Yes
| No
| No
|-
! Mobile platforms:
| colspan="3"|
|-
!
* iOS
| Yes
| No
| Yes
|-
!
* Android
| Yes
| No
| Yes
|-
! Streaming protocols:
| colspan="3"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
|-
! Audio player
| No
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
|-
! JS library
| jQuery
| -
| jQuery
|-
! Plugins infrastructure
| No
| Yes
| Yes
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in [[#Flowplayer_HTML5|corresponding section above]], it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout, display platform incompatibility message prior to attempt to play, and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

== Mock-Ups/Prototypes ==

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]

HTML5 player

2014-03-10T10:50:27Z

Kabalin: /* Discussion */

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1105373
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 with flash fallback for integration in Moodle.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* ?Are there other alternatives?

{| class="nicetable"
|-
!
! Flowplayer HTML5
! Video.JS
! Projekktor
|-
! Accessible Player:
| colspan="3"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
|-
!
* Touch interface
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="3"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
|-
!
* CSS customisation
| Yes
| Yes
| Yes
|-
!
* RTL support
| Yes
| No
| No
|-
! Mobile platforms:
| colspan="3"|
|-
!
* iOS
| Yes
| No
| Yes
|-
!
* Android
| Yes
| No
| Yes
|-
! Streaming protocols:
| colspan="3"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
|-
! Audio player
| No
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
|-
! JS library
| jQuery
| -
| jQuery
|-
! Plugins infrastructure
| No
| Yes
| Yes
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in corresponding section above, it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout, display platform incompatibility message prior to attempt to play, and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

== Mock-Ups/Prototypes ==

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]

HTML5 player

2014-03-10T10:47:54Z

Kabalin: /* Projekktor */

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1105373
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 with flash fallback for integration in Moodle.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* ?Are there other alternatives?

{| class="nicetable"
|-
!
! Flowplayer HTML5
! Video.JS
! Projekktor
|-
! Accessible Player:
| colspan="3"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
|-
!
* Touch interface
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="3"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
|-
!
* CSS customisation
| Yes
| Yes
| Yes
|-
!
* RTL support
| Yes
| No
| No
|-
! Mobile platforms:
| colspan="3"|
|-
!
* iOS
| Yes
| No
| Yes
|-
!
* Android
| Yes
| No
| Yes
|-
! Streaming protocols:
| colspan="3"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
|-
! Audio player
| No
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
|-
! JS library
| jQuery
| -
| jQuery
|-
! Plugins infrastructure
| No
| Yes
| Yes
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios and android (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in corresponding section above, it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

== Mock-Ups/Prototypes ==

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]

HTML5 player

2014-03-10T10:41:06Z

Kabalin: /* Cross-browser support checks */

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1105373
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 with flash fallback for integration in Moodle.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* ?Are there other alternatives?

{| class="nicetable"
|-
!
! Flowplayer HTML5
! Video.JS
! Projekktor
|-
! Accessible Player:
| colspan="3"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
|-
!
* Touch interface
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="3"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
|-
!
* CSS customisation
| Yes
| Yes
| Yes
|-
!
* RTL support
| Yes
| No
| No
|-
! Mobile platforms:
| colspan="3"|
|-
!
* iOS
| Yes
| No
| Yes
|-
!
* Android
| Yes
| No
| Yes
|-
! Streaming protocols:
| colspan="3"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
|-
! Audio player
| No
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
|-
! JS library
| jQuery
| -
| jQuery
|-
! Plugins infrastructure
| No
| Yes
| Yes
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

== Cross-browser support ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Discussion ===

The players comparison that has been carried out demonstrated that "least hassle" player is Flowplayer. Despite some drawbacks listed in corresponding section above, it is clearly a winner as it works as expected and according to documentation for all browsers and platforms I had chance to test it. This is the only player that supports RTL layout and was simple to configure (no undocumented tricks that I had to figure out to make it work). Both VideoJS and Projekktor do now perform properly in all cases. Among those two, I personally prefer Projekktor more for its extensive API, plugins infrastructure and configuration flexibility. However problems on mobile platforms and flash fallback inconsistency make them unreliable at this stage.

=== Compatibility results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

== Mock-Ups/Prototypes ==

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]

HTML5 player

2014-03-10T10:25:34Z

Kabalin: /* Projekktor */

{{Work in progress}}
{{Infobox Project
|name = HTML5 Player with flash fallback
|state = In Development
|tracker = https://tracker.moodle.org/browse/MDL-38158
|discussion = https://moodle.org/mod/forum/discuss.php?d=222753#p1105373
|assignee = [https://tracker.moodle.org/secure/ViewProfile.jspa?name=kabalin Ruslan Kabalin]
}}
{{Moodle 2.x}}

== Project goals ==

The purpose of this document is to choose HTML5 with flash fallback for integration in Moodle.

The aim of this change is to reach a consistent look of the player among different platforms and browsers, as well as making sure that player starts using flash if html5 is not supported by browser for the given format. Another aim is to improve accessibility and usability, enhance customisation.

== Considerations ==

* Usability of the player - is it easy to use it and intuitively understand how to use controls?
* Accessibility of the player - possibility of keyboard navigation, subtitles, support?
* Appearance of the player - can its interface be modified, themes support, RTL?
* Consistency among browsers - does player look the same?
* Audio support - can player handle HTML5 <audio> tag?
* Mobile platforms support - does player also work on iOS and Android?
* Streaming media support (including adaptive-bitrate delivery) - can player handle RTMP, Apple HLS, Adobe HDS, Microsoft HSS?
* Plugins support - can we use or develop community plugins easily?
* Embedding support - so users could post media content outside Moodle, if permitted.
* Maintainability of the links between the player and Moodle - how much work will we need to do every time we upgrade?

== Candidates ==

* [http://flowplayer.org/ Flowplayer HTML5]
* [http://www.videojs.com/ Video.JS]
* [http://www.projekktor.com/ Projekktor]
* ?Are there other alternatives?

{| class="nicetable"
|-
!
! Flowplayer HTML5
! Video.JS
! Projekktor
|-
! Accessible Player:
| colspan="3"|
|-
!
* Keyboard control
| Yes
| No
| Yes (configurable)
|-
!
* Subtitles support
| Yes
| Yes
| Yes (via plugin)
|-
!
* Touch interface
| Yes
| Yes
| Yes
|-
! Appearance:
| colspan="3"|
|-
!
* Skins
| Yes (via CSS)
| Yes (via CSS)
| Yes (via CSS)
|-
!
* CSS customisation
| Yes
| Yes
| Yes
|-
!
* RTL support
| Yes
| No
| No
|-
! Mobile platforms:
| colspan="3"|
|-
!
* iOS
| Yes
| No
| Yes
|-
!
* Android
| Yes
| No
| Yes
|-
! Streaming protocols:
| colspan="3"|
|-
!
* RTMP
| Yes
| Yes
| Yes (via playlist)
|-
!
* Adaptive HTTP
| HLS
| HLS (via plugin)
| HLS (via playlist)
|-
! Audio player
| No
| Yes
| Yes
|-
! style="border-bottom: 2px solid;" | Embedding support
| style="border-bottom: 2px solid;" | Yes (configurable)
| style="border-bottom: 2px solid;" | Yes (via addThis plugin)
| style="border-bottom: 2px solid;" | Yes (via plugin)
|-
! License
| GPL v3 (with additional terms)
| Apache 2
| GPL v3
|-
! JS library
| jQuery
| -
| jQuery
|-
! Plugins infrastructure
| No
| Yes
| Yes
|-
! Flash fallback player
| Flowplayer Flash
| video-js flash
| StobeMediaPlayback (but can be jarisplayer or some other).
|-
! API
| Yes (plus window.flowplayer object)
| Yes
| Yes
|-
|}

=== Flowplayer HTML5 ===

'''Pros:'''
* Good looking player, resembles existing flash flowplayer in Moodle (with "functional" skin)
* Extensive customisation (via CSS3 skins and configuration object)
* Streaming support (RTMP, HLS)
* Good accessibility features
* Configurable embedding functionality
* Existing flash flowplayer can be configured for fallback (the appearance of player will not be affected).

'''Cons:'''
* Require jQuery for functioning
* Flowplayer logo remains on screen

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using wrapper around <video>.
* width and height attributes in video tag are ignored, player size is configured via wrapper size only.
* RTMP server connection is configured via data-rtmp attribute in wrapper or player init config parameter, actual path the file specified in src attribute of source item.
* <source type="video/flash"... dummy MIME type to force using plash player for whatever content.

'''Missing features'''
* Plugins infrastructure
* No audio support

=== Video.JS ===

'''Pros:'''
* No logo on screen.
* Extensive API.
* No extra JS library needed.
* Many plugins.

'''Cons:'''
* RTMP requires non-standard MIME.
* Android and iOS override Video.JS with own player, when not overridden, content is not playing.
* No RTL.
* HLS support via plugin (many files to include, external contributor see https://github.com/videojs/videojs-contrib-hls).

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* RTMP server connection and path specified as single URI in src attribute of source item, '&' character is used as server connection and path divider.

'''Missing features'''
* Embedded HLS support.

=== Projekktor ===

'''Pros:'''
* No logo on screen.
* Well documented API.
* Media RSS support.
* Possibility to choose flash player for fallback (included by default are StrobeMediaPlayback and Jarisplayer, both Open Source).
* Platform preference order selection (e.g. browser, ios, android, flash, native).

'''Cons:'''
* Uses flash where it is not supposed to (e.g. mp4 in Chrome).
* Issues on ios (suggests to download file when play button is pressed).
* RTMP only work if defined via playlist rather than in <source> tags.
* Subtitles plugin is not free.

'''Technical notes (lessons learned from the prototypes)'''
* Player initialisation is done using <video> tag directly (no wrapper needed).
* Make sure <video> tag has class attribute with 'projekktor' value (even if you initialise it by ID of the element), player will not work properly otherwise.

'''Missing features'''

== Cross-browser support checks ==

=== Method ===
Compatibility checks were done manually by accessing the sample page using different browsers and platforms. Sample page contained the list of identical player instances, initialised for each <video> definition with a <source> of particular format: mp4, webm, ogg, flv. Streaming support was checked by setting up a <video> container with two sources of the same video, one was HLS (Apple HTTP Live Streaming) stream for browsers and platforms that support html5 video streaming, another one was RTMP which is played using flash engine and supposed to be used in case if HLS is not supported.

=== Sample Pages ===

* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=flowplayer Flowplayer HTML5] version 5.4.6.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=videojs Video.JS] version 4.4.1.
* [https://dev.mle.lancs.ac.uk/videotest/players.php?player=projekktor Projekktor] version 1.3.09.

=== Source ===

Source of testing page is hosted on [https://github.com/kabalin/test-html5-players/blob/master/players.php github]. The actual source of the html page can be viewed in browser.

=== Results ===

The table was populated using Flowplayer as others do not perform good enough with some formats and platforms, e.g. VideoJS allow mobile platform player to override itself, Projekktor does not always use HTML5 where browser clearly can handle it (supported in native mode and Flowplayer).

{| class="nicetable"
|-
! Browser
! mp4
! webm
! ogg
! flv
! RTMP/HLS*
|-
! Windows 7
| colspan="5"|
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
!
* Firefox 27.0.1
| html5
| html5
| html5
| flash
| flash
|-
!
* Opera 12.16
| flash
| html5
| -
| flash
| flash
|-
!
* Safari 5.1.7
| flash
| -
| -
| flash
| flash
|-
!
* Internet Explorer 11.0.9600.x
| html5
| -
| -
| flash
| flash
|-
! Linux (Debian Wheezy)
| colspan="5"|
|-
!
* Chrome 33.0.1750.115
| html5
| html5
| html5
| flash
| flash
|-
! OSX 10.9
| colspan="5"|
|-
!
* Safari 7.0 (9537.71)
| html5
| -
| -
| flash
| html5
|-
!
* Chrome 33.0.1750.117
| html5
| html5
| html5
| flash
| flash
|-
! Android 4.2.2 phone (CyanogenMod, no flash)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| -
| html5
|-
! Android 4.2.2 tablet (GalaxyTab2, flash app 11.1.115.36)
| colspan="5"|
|-
!
* Chrome 32.0.1700.99
| html5
| html5
| -
| -
| -
|-
!
* Browser 4.2.2 (com.android.browser)
| html5
| html5
| -
| flash
| html5
|-
!
* Opera 19.0.1340.x
| html5
| html5
| -
| -
| -
|-
! iPhone 4S (6.1.3)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
! iPad 4 (7.0.6)
| colspan="5"|
|-
!
* Safari
| html5
| -
| -
| -
| html5
|-
|}
* For HLS/RTMP, html5 in the table means HLS has been used, flash means player fell back and used RTMP.

== Sub Tasks ==

== Mock-Ups/Prototypes ==

== Related Tracker Issues ==
* MDL-38158

== Useful links ==
* http://praegnanz.de/html5video/
* http://html5video.org/wiki/HTML5_Video_Player_Comparison
* http://www.streamingmedia.com/Articles/Editorial/Featured-Articles/Choosing-a-Video-Player-Features-and-Specs-for-the-Top-Five-94188.aspx

[[Category:Project]]