ILIAS  trunk Revision v11.0_alpha-2662-g519ff7d528f
ILIAS\UI\Component\Player\Video Interface Reference

Interface for Video elements. More...

+ Inheritance diagram for ILIAS\UI\Component\Player\Video:
+ Collaboration diagram for ILIAS\UI\Component\Player\Video:

Public Member Functions

 withAdditionalSubtitleFile (string $lang_key, string $subtitle_file)
 Set a subtitle file path (vtt file). More...
 
 getSubtitleFiles ()
 Get subtitle files. More...
 
 withPoster (string $poster)
 Set initially shown poster image. More...
 
 getPoster ()
 
- Public Member Functions inherited from ILIAS\UI\Component\Player\Player
 getSource ()
 Get the source path/url of the media. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\Component
 getCanonicalName ()
 Get the canonical name of the component. More...
 
 reduceWith (\Closure $fn)
 The scheme starts at the leaves of the structure and applies the function to each leave and moves up the tree recursively. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\JavaScriptBindable
 withOnLoadCode (Closure $binder)
 
 withAdditionalOnLoadCode (Closure $binder)
 Add some onload-code to the component instead of replacing the existing one. More...
 
 getOnLoadCode ()
 Get the currently bound on load code. More...
 

Detailed Description

Interface for Video elements.

Author
Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 29 of file Video.php.

Member Function Documentation

◆ getPoster()

ILIAS\UI\Component\Player\Video::getPoster ( )

◆ getSubtitleFiles()

ILIAS\UI\Component\Player\Video::getSubtitleFiles ( )

Get subtitle files.

Returns
array<string,string>

◆ withAdditionalSubtitleFile()

ILIAS\UI\Component\Player\Video::withAdditionalSubtitleFile ( string  $lang_key,
string  $subtitle_file 
)

Set a subtitle file path (vtt file).

For WebVTT format, see https://en.wikipedia.org/wiki/WebVTT.

Parameters
string$lang_keytwo letter lang key, e.g. "de", "en"
string$subtitle_filerelative web root path of a vtt file

◆ withPoster()

ILIAS\UI\Component\Player\Video::withPoster ( string  $poster)

Set initially shown poster image.

Parameters
string$posterrelative web root path of an image file, URL of an external image resource (png,jpg,svg,gif)

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