Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
media_videojs_plugin Class Reference

Player that creates HTML5 <video> tag. More...

Inheritance diagram for media_videojs_plugin:
core_media_player_native core_media_player

Public Member Functions

 embed ($urls, $name, $width, $height, $options)
 Generates code required to embed the player.
 
 get_embeddable_markers ()
 Lists keywords that must be included in a url that can be embedded with this player.
 
 get_rank ()
 Default rank.
 
 get_supported_extensions ()
 Gets the list of file extensions supported by this media player.
 
 is_enabled ()
 
 list_supported_urls (array $urls, array $options=array())
 Given a list of URLs, returns a reduced array containing only those URLs which are supported by this player.
 
 setup ($page)
 Setup page requirements.
 
 supports ($usedextensions=[])
 Returns human-readable string of supported file/link types for the "Manage media players" page.
 

Static Public Member Functions

static add_attributes ($tag, $attributes)
 Adds attributes to the media tags.
 
static compare_by_rank ()
 
static get_attribute ($tag, $attrname, $type=PARAM_RAW)
 Extracts a value for an attribute.
 
static get_language_content (string $lang)
 Returns the requested language pack in the json format.
 
static remove_attributes ($tag, $attrname)
 Removes an attribute from the media tags.
 
static replace_sources ($tag, $sources)
 Replaces all embedded <source> tags and src attribute.
 

Public Attributes

const LINKPLACEHOLDER = '<!--LINKFALLBACK-->'
 Placeholder text used to indicate where the link fallback is placed.
 
const PLACEHOLDER = '<!--FALLBACK-->'
 Placeholder text used to indicate where the fallback content is placed within a result.
 

Protected Member Functions

 find_language ()
 Tries to match the current language to existing language files.
 
 get_name ($name, $urls)
 Obtains suitable name for media.
 
 get_regex_youtube ()
 Returns regular expression used to match URLs for single youtube video.
 

Static Protected Member Functions

static get_start_time (string $timestr)
 Method to convert Youtube time parameter string, which can contain human readable time intervals such as '1h5m', '1m10s', etc or a numeric seconds value.
 
static pick_video_size (&$width, &$height)
 Utility function that sets width and height to defaults if not specified as a parameter to the function (will be specified either if, (a) the calling code passed it, or (b) the URL included it).
 

Protected Attributes

array $extensions = null
 caches supported extensions
 
string $language = 'en'
 language file to use
 
array $loadedonpage = []
 caches last moodle_page used to include AMD modules
 
array $ogvsupportedextensions
 Ogv.JS supported extensions.
 
bool $ogvtech = false
 Need to use Ogv.JS Tech plugin or not.
 
bool $youtube = false
 is this a youtube link
 

Detailed Description

Player that creates HTML5 <video> tag.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ add_attributes()

static core_media_player_native::add_attributes ( $tag,
$attributes )
staticinherited

Adds attributes to the media tags.

Parameters
string$taghtml tag which properties are extracted, for example "<video ...>....</video>"
array$attributeskey-value pairs of attributes to be added
Return values
string

◆ compare_by_rank()

static core_media_player::compare_by_rank ( )
staticinherited
Deprecated
since Moodle 3.2

◆ embed()

media_videojs_plugin::embed ( $urls,
$name,
$width,
$height,
$options )

Generates code required to embed the player.

Parameters
moodle_url[]$urls
string$name
int$width
int$height
array$options
Return values
string

Reimplemented from core_media_player.

◆ find_language()

media_videojs_plugin::find_language ( )
protected

Tries to match the current language to existing language files.

Matched language is stored in $this->language

Return values
stringJS code with a setting

◆ get_attribute()

static core_media_player_native::get_attribute ( $tag,
$attrname,
$type = PARAM_RAW )
staticinherited

Extracts a value for an attribute.

Parameters
string$taghtml tag which properties are extracted, for example "<video ...>....</video>"
string$attrnamename of the attribute we are looking for
string$typeone of PARAM_* constants to clean the attribute value
Return values
string|null

◆ get_embeddable_markers()

media_videojs_plugin::get_embeddable_markers ( )

Lists keywords that must be included in a url that can be embedded with this player.

Any such keywords should be added to the array.

For example if this player supports FLV and F4V files then it should add '.flv' and '.f4v' to the array. (The check is not case-sensitive.)

Default handling calls the get_supported_extensions function, so players only need to override this if they don't implement get_supported_extensions.

This is used to improve performance when matching links in the media filter.

Return values
arrayArray of keywords to add to the embeddable markers list

Reimplemented from core_media_player.

◆ get_language_content()

static media_videojs_plugin::get_language_content ( string $lang)
static

Returns the requested language pack in the json format.

Parameters
string$langThe language code
Return values
false|stringThe read data or false on failure

◆ get_name()

core_media_player::get_name ( $name,
$urls )
protectedinherited

Obtains suitable name for media.

Uses specified name if there is one, otherwise makes one up.

Parameters
string$nameUser-specified name ('' if none)
array$urlsArray of moodle_url used to make up name
Return values
stringName

◆ get_rank()

media_videojs_plugin::get_rank ( )

Default rank.

Return values
int

Reimplemented from core_media_player.

◆ get_regex_youtube()

media_videojs_plugin::get_regex_youtube ( )
protected

Returns regular expression used to match URLs for single youtube video.

Return values
stringPHP regular expression e.g. '~^https?://example.org/~'

◆ get_start_time()

static media_videojs_plugin::get_start_time ( string $timestr)
staticprotected

Method to convert Youtube time parameter string, which can contain human readable time intervals such as '1h5m', '1m10s', etc or a numeric seconds value.

Parameters
string$timestr
Return values
int

◆ get_supported_extensions()

media_videojs_plugin::get_supported_extensions ( )

Gets the list of file extensions supported by this media player.

Note: This is only required for the default implementations of list_supported_urls(), get_embeddable_markers() and supports(). If you override these functions to determine supported URLs in some way other than by extension, then this function is not necessary.

Return values
arrayArray of strings (extension not including dot e.g. '.mp3')

Reimplemented from core_media_player_native.

◆ is_enabled()

core_media_player::is_enabled ( )
inherited
Deprecated
since Moodle 3.2

◆ list_supported_urls()

media_videojs_plugin::list_supported_urls ( array $urls,
array $options = array() )

Given a list of URLs, returns a reduced array containing only those URLs which are supported by this player.

(Empty if none.)

Parameters
array$urlsArray of moodle_url
array$optionsOptions (same as will be passed to embed)
Return values
arrayArray of supported moodle_url

Reimplemented from core_media_player_native.

◆ pick_video_size()

static media_videojs_plugin::pick_video_size ( & $width,
& $height )
staticprotected

Utility function that sets width and height to defaults if not specified as a parameter to the function (will be specified either if, (a) the calling code passed it, or (b) the URL included it).

Parameters
int$widthWidth passed to function (updated with final value)
int$heightHeight passed to function (updated with final value)

Reimplemented from core_media_player.

◆ remove_attributes()

static core_media_player_native::remove_attributes ( $tag,
$attrname )
staticinherited

Removes an attribute from the media tags.

Parameters
string$taghtml tag which properties are extracted, for example "<video ...>....</video>"
string | array$attrname
Return values
string

◆ replace_sources()

static core_media_player_native::replace_sources ( $tag,
$sources )
staticinherited

Replaces all embedded <source> tags and src attribute.

Parameters
string$taghtml tag which properties are extracted, for example "<video ...>....</video>"
string$sourcesreplacement string (expected to contain <source> tags)
Return values
string

◆ setup()

media_videojs_plugin::setup ( $page)

Setup page requirements.

Parameters
moodle_page$pageThe page we are going to add requirements to.

Reimplemented from core_media_player.

◆ supports()

media_videojs_plugin::supports ( $usedextensions = [])

Returns human-readable string of supported file/link types for the "Manage media players" page.

Parameters
array$usedextensionsextensions that should NOT be highlighted
Return values
string

Reimplemented from core_media_player.

Member Data Documentation

◆ $ogvsupportedextensions

array media_videojs_plugin::$ogvsupportedextensions
protected
Initial value:
= [
'.ogv',
'.webm',
'.oga',
'.ogg'
]

Ogv.JS supported extensions.

◆ LINKPLACEHOLDER

const core_media_player::LINKPLACEHOLDER = '<!--LINKFALLBACK-->'
inherited

Placeholder text used to indicate where the link fallback is placed.

No other players will apply to it but it will be converted to the link in the end (unless prevented by OPTION_NO_LINK).


The documentation for this class was generated from the following file: