ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes
ilMediaPlayerGUI Class Reference
Services/MediaObjects

User interface for media player. More...

+ Collaboration diagram for ilMediaPlayerGUI:

Public Member Functions

 __construct ($a_id="", $a_event_callback_url="")
 
 setFile ($a_file)
 Set File. More...
 
 getFile ()
 Get File. More...
 
 setAlternativeVideoFile ($a_val)
 Set alternative video file. More...
 
 getAlternativeVideoFile ()
 Get alternative video file. More...
 
 setAlternativeVideoMimeType ($a_val)
 Set alternative video mime type. More...
 
 getAlternativeVideoMimeType ()
 Get alternative video mime type. More...
 
 setDisplayHeight ($dHeight)
 set display height More...
 
 getDisplayHeight ()
 return display height of player. More...
 
 setDisplayWidth ($a_val)
 Set display width. More...
 
 getDisplayWidth ()
 Get display width. More...
 
 setMimeType ($value)
 
 setVideoPreviewPic ($a_val, $a_alt="")
 Set video preview picture. More...
 
 getVideoPreviewPic ()
 Get video preview picture. More...
 
 setTitle ($a_val)
 Set Title. More...
 
 getTitle ()
 Get Title. More...
 
 setDescription ($a_val)
 Set description. More...
 
 getDescription ()
 Get description. More...
 
 setForceAudioPreview ($a_val)
 Set force audio preview. More...
 
 getForceAudioPreview ()
 Get force audio preview. More...
 
 setDownloadLink ($a_val)
 Set download link. More...
 
 getDownloadLink ()
 Get download link. More...
 
 getMp3PlayerHtml ($a_preview=false)
 Get Html for MP3 Player. More...
 
 getPreviewHtml ()
 Get preview html. More...
 
 getMediaPlayerHtml ()
 Get HTML (no preview) for media player integration. More...
 

Static Public Member Functions

static initJavascript ($a_tpl=null)
 Init Javascript. More...
 

Protected Attributes

 $tpl
 
 $lng
 
 $file
 
 $displayHeight = "480"
 
 $displayWidth = "640"
 
 $mimeType
 
 $current_nr
 
 $title
 
 $description
 
 $event_callback_url = ""
 
 $download_link = ""
 

Static Protected Attributes

static $nr = 1
 
static $lightbox_initialized = false
 

Detailed Description

User interface for media player.

Wraps flash mp3 player and similar tools.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 13 of file class.ilMediaPlayerGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilMediaPlayerGUI::__construct (   $a_id = "",
  $a_event_callback_url = "" 
)

Definition at line 37 of file class.ilMediaPlayerGUI.php.

References $DIC.

38  {
39  global $DIC;
40 
41  $this->tpl = $DIC["tpl"];
42  $this->lng = $DIC->language();
43  $this->id = $a_id;
44  $this->event_callback_url = $a_event_callback_url;
45  $this->current_nr = self::$nr;
46  self::$nr++;
47  }
$DIC
global $DIC
Definition: saml.php:7

Member Function Documentation

◆ getAlternativeVideoFile()

ilMediaPlayerGUI::getAlternativeVideoFile ( )

Get alternative video file.

Returns
string alternative video file

Definition at line 84 of file class.ilMediaPlayerGUI.php.

Referenced by getMp3PlayerHtml().

85  {
86  return $this->alt_video_file;
87  }
+ Here is the caller graph for this function:

◆ getAlternativeVideoMimeType()

ilMediaPlayerGUI::getAlternativeVideoMimeType ( )

Get alternative video mime type.

Returns
string alternative video mime type

Definition at line 104 of file class.ilMediaPlayerGUI.php.

Referenced by getMp3PlayerHtml().

105  {
106  return $this->alt_video_mime;
107  }
+ Here is the caller graph for this function:

◆ getDescription()

ilMediaPlayerGUI::getDescription ( )

Get description.

Returns
string description

Definition at line 210 of file class.ilMediaPlayerGUI.php.

References $description.

Referenced by getMp3PlayerHtml().

211  {
212  return $this->description;
213  }
+ Here is the caller graph for this function:

◆ getDisplayHeight()

ilMediaPlayerGUI::getDisplayHeight ( )

return display height of player.

Returns
int

Definition at line 124 of file class.ilMediaPlayerGUI.php.

References $displayHeight.

Referenced by getMp3PlayerHtml().

125  {
126  return $this->displayHeight;
127  }
+ Here is the caller graph for this function:

◆ getDisplayWidth()

ilMediaPlayerGUI::getDisplayWidth ( )

Get display width.

Returns
string display width

Definition at line 144 of file class.ilMediaPlayerGUI.php.

References $displayWidth.

Referenced by getMp3PlayerHtml().

145  {
146  return $this->displayWidth;
147  }
+ Here is the caller graph for this function:

◆ getDownloadLink()

ilMediaPlayerGUI::getDownloadLink ( )

Get download link.

Returns
string download link

Definition at line 250 of file class.ilMediaPlayerGUI.php.

References $download_link.

Referenced by getMp3PlayerHtml().

251  {
252  return $this->download_link;
253  }
+ Here is the caller graph for this function:

◆ getFile()

ilMediaPlayerGUI::getFile ( )

Get File.

Returns
string File

Definition at line 64 of file class.ilMediaPlayerGUI.php.

References $file.

Referenced by getMp3PlayerHtml().

65  {
66  return $this->file;
67  }
+ Here is the caller graph for this function:

◆ getForceAudioPreview()

ilMediaPlayerGUI::getForceAudioPreview ( )

Get force audio preview.

Returns
boolean force audio preview picture

Definition at line 230 of file class.ilMediaPlayerGUI.php.

Referenced by getMp3PlayerHtml().

231  {
232  return $this->force_audio_preview;
233  }
+ Here is the caller graph for this function:

◆ getMediaPlayerHtml()

ilMediaPlayerGUI::getMediaPlayerHtml ( )

Get HTML (no preview) for media player integration.

Returns
string html

Definition at line 559 of file class.ilMediaPlayerGUI.php.

References getMp3PlayerHtml().

560  {
561  return $this->getMp3PlayerHtml(false);
562  }
ilMediaPlayerGUI\getMp3PlayerHtml
getMp3PlayerHtml($a_preview=false)
Get Html for MP3 Player.
Definition: class.ilMediaPlayerGUI.php:282
+ Here is the call graph for this function:

◆ getMp3PlayerHtml()

ilMediaPlayerGUI::getMp3PlayerHtml (   $a_preview = false)

Get Html for MP3 Player.

Definition at line 282 of file class.ilMediaPlayerGUI.php.

References $html, $lng, $mimeType, $r, $tpl, array, ilGlyphGUI\CLOSE, ilExternalMediaAnalyzer\extractVimeoParameters(), ilExternalMediaAnalyzer\extractYouTubeParameters(), ilGlyphGUI\get(), getAlternativeVideoFile(), getAlternativeVideoMimeType(), getDescription(), getDisplayHeight(), getDisplayWidth(), getDownloadLink(), getFile(), ilPlayerUtil\getFlashVideoPlayerFilename(), getForceAudioPreview(), ilUtil\getImagePath(), ilObjMediaObject\getMimeType(), getTitle(), getVideoPreviewPic(), ilPlayerUtil\initMediaElementJs(), ilExternalMediaAnalyzer\isVimeo(), and ilExternalMediaAnalyzer\isYouTube().

Referenced by getMediaPlayerHtml(), and getPreviewHtml().

283  {
284  $tpl = $this->tpl;
285  $lng = $this->lng;
286 
287  self::initJavascript($tpl);
288 
289  if (!self::$lightbox_initialized && $a_preview) {
290  include_once("./Services/UIComponent/Lightbox/classes/class.ilLightboxGUI.php");
291  $lb = new ilLightboxGUI("media_lightbox");
292  $lb->setWidth("660px");
293  $lb->addLightbox();
294  self::$lightbox_initialized = true;
295  }
296 
297  require_once 'Services/MediaObjects/classes/class.ilObjMediaObject.php';
298  include_once("./Services/MediaObjects/classes/class.ilExternalMediaAnalyzer.php");
299 
300  // youtube
301  if (ilExternalMediaAnalyzer::isYouTube($this->getFile())) {
302  $p = ilExternalMediaAnalyzer::extractYouTubeParameters($this->getFile());
303  /*
304  $html = '<object width="320" height="240">'.
305  '<param name="movie" value="http://www.youtube.com/v/'.$p["v"].'?fs=1">'.
306  '</param><param name="allowFullScreen" value="true"></param>'.
307  '<param name="allowscriptaccess" value="always">'.
308  '</param><embed src="http://www.youtube.com/v/'.$p["v"].'?fs=1" '.
309  'type="application/x-shockwave-flash" allowscriptaccess="always" '.
310  'allowfullscreen="true" width="320" height="240"></embed></object>';
311  return $html;*/
312  $mp_tpl = new ilTemplate("tpl.flv_player.html", true, true, "Services/MediaObjects");
313  if ($a_preview) {
314  if ($this->getDownloadLink() != "") {
315  $mp_tpl->setCurrentBlock("ytdownload");
316  $mp_tpl->setVariable("TXT_DOWNLOAD", $lng->txt("download"));
317  $mp_tpl->setVariable("HREF_DOWNLOAD", $this->getDownloadLink());
318  $mp_tpl->parseCurrentBlock();
319  }
320 
321  $mp_tpl->setCurrentBlock("ytpreview");
322  if ($this->getVideoPreviewPic() != "") {
323  $mp_tpl->setVariable("IMG_SRC", $this->getVideoPreviewPic());
324  } else {
325  $mp_tpl->setVariable("IMG_SRC", ilUtil::getImagePath("mcst_preview.svg"));
326  }
327  $height = $this->getDisplayHeight();
328  $width = $this->getDisplayWidth();
329  $mp_tpl->setVariable("DISPLAY_HEIGHT", $height);
330  $mp_tpl->setVariable("DISPLAY_WIDTH", $width);
331  $mp_tpl->setVariable("IMG_ALT", $this->video_preview_pic_alt);
332  $mp_tpl->setVariable("PTITLE", $this->getTitle());
333  $mp_tpl->parseCurrentBlock();
334  }
335  $mp_tpl->setCurrentBlock("youtube");
336  if ($a_preview) {
337  $mp_tpl->setVariable("CLASS", "ilNoDisplay");
338  }
339  $mp_tpl->setVariable("PV", $p["v"]);
340  $mp_tpl->setVariable("PLAYER_NR", $this->id . "_" . $this->current_nr);
341  $mp_tpl->setVariable("TITLE", $this->getTitle());
342  $mp_tpl->setVariable("DESCRIPTION", $this->getDescription());
343  include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
344  if ($a_preview) {
345  $mp_tpl->setVariable("CLOSE", ilGlyphGUI::get(ilGlyphGUI::CLOSE));
346  }
347  $mp_tpl->parseCurrentBlock();
348  return $mp_tpl->get();
349  }
350 
351  // vimeo
352  if (ilExternalMediaAnalyzer::isVimeo($this->getFile())) {
353  $p = ilExternalMediaAnalyzer::extractVimeoParameters($this->getFile());
354  $html = '<iframe src="//player.vimeo.com/video/' . $p["id"] . '" width="320" height="240" ' .
355  'frameborder="0"></iframe>';
356 
357  return $html;
358  }
359 
360  $mimeType = $this->mimeType == "" ? ilObjMediaObject::getMimeType(basename($this->getFile())) : $this->mimeType;
361  include_once("./Services/MediaObjects/classes/class.ilPlayerUtil.php");
362 
363  // video tag
364  if (in_array($mimeType, array("video/mp4", "video/m4v", "video/rtmp",
365  "video/x-flv", "video/webm", "video/youtube", "video/vimeo", "video/ogg"))) {
366  if ($mimeType == "video/quicktime") {
367  $mimeType = "video/mov";
368  }
369 
370  $mp_tpl = new ilTemplate("tpl.flv_player.html", true, true, "Services/MediaObjects");
371 
372  // preview
373  if ($a_preview) {
374  if ($this->getDownloadLink() != "") {
375  $mp_tpl->setCurrentBlock("download");
376  $mp_tpl->setVariable("TXT_DOWNLOAD", $lng->txt("download"));
377  $mp_tpl->setVariable("HREF_DOWNLOAD", $this->getDownloadLink());
378  $mp_tpl->parseCurrentBlock();
379  }
380 
381  $mp_tpl->setCurrentBlock("preview");
382  if ($this->getVideoPreviewPic() != "") {
383  $mp_tpl->setVariable("IMG_SRC", $this->getVideoPreviewPic());
384  } else {
385  $mp_tpl->setVariable("IMG_SRC", ilUtil::getImagePath("mcst_preview.svg"));
386  }
387  $mp_tpl->setVariable("IMG_ALT", $this->video_preview_pic_alt);
388  $mp_tpl->setVariable("PTITLE", $this->getTitle());
389  $mp_tpl->parseCurrentBlock();
390  }
391 
392  // sources
393  $mp_tpl->setCurrentBlock("source");
394  $mp_tpl->setVariable("FILE", $this->getFile());
395  $mp_tpl->setVariable("MIME", $mimeType);
396  $mp_tpl->parseCurrentBlock();
397 
398  if (in_array($this->getAlternativeVideoMimeType(), array("video/mp4", "video/webm"))) {
399  $mp_tpl->setCurrentBlock("source");
400  $mp_tpl->setVariable("FILE", $this->getAlternativeVideoFile());
401  $mp_tpl->setVariable("MIME", $this->getAlternativeVideoMimeType());
402  $mp_tpl->parseCurrentBlock();
403  }
404 
405  $mp_tpl->setCurrentBlock("mejs_video");
406 
407  if ($a_preview) {
408  $mp_tpl->setVariable("CLASS", "ilNoDisplay");
409  }
410 
411  $mp_tpl->setVariable("PLAYER_NR", $this->id . "_" . $this->current_nr);
412  $mp_tpl->setVariable("EVENT_URL", $this->event_callback_url);
413  $height = $this->getDisplayHeight();
414  $width = $this->getDisplayWidth();
415  if (is_int(strpos($mimeType, "audio/mpeg"))) {
416  $height = "30";
417  }
418 
419  $mp_tpl->setVariable("DISPLAY_HEIGHT", $height);
420  $mp_tpl->setVariable("DISPLAY_WIDTH", $width);
421  $mp_tpl->setVariable("PREVIEW_PIC", $this->getVideoPreviewPic());
422  $mp_tpl->setVariable("SWF_FILE", ilPlayerUtil::getFlashVideoPlayerFilename(true));
423  $mp_tpl->setVariable("FFILE", $this->getFile());
424  $mp_tpl->setVariable("TITLE", $this->getTitle());
425  $mp_tpl->setVariable("DESCRIPTION", $this->getDescription());
426  include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
427  if ($a_preview) {
428  $mp_tpl->setVariable("CLOSE", ilGlyphGUI::get(ilGlyphGUI::CLOSE));
429  }
430  $mp_tpl->parseCurrentBlock();
431  $r = $mp_tpl->get();
432 
433  if (!$a_preview) {
434  $tpl->addOnLoadCode("new MediaElementPlayer('#player_" . $this->id . "_" . $this->current_nr . "');");
435  }
436 
437  //echo htmlentities($r); exit;
438  return $r;
439  }
440 
441  // audio/mpeg
442  if (is_int(strpos($mimeType, "audio/mpeg")) ||
443  in_array($mimeType, array("application/ogg", "audio/ogg"))) {
444  ilPlayerUtil::initMediaElementJs();
445  $mp_tpl = new ilTemplate("tpl.flv_player.html", true, true, "Services/MediaObjects");
446  $preview_output = false;
447  if ($this->getVideoPreviewPic() != "" || $this->getForceAudioPreview()) {
448  if ($this->getDownloadLink() != "") {
449  $mp_tpl->setCurrentBlock("adownload");
450  $mp_tpl->setVariable("TXT_DOWNLOAD", $lng->txt("download"));
451  $mp_tpl->setVariable("HREF_DOWNLOAD", $this->getDownloadLink());
452  $mp_tpl->parseCurrentBlock();
453  }
454 
455  $mp_tpl->setCurrentBlock("apreview");
456  if ($this->getVideoPreviewPic() != "") {
457  $mp_tpl->setVariable("IMG_SRC", $this->getVideoPreviewPic());
458  } else {
459  $mp_tpl->setVariable("IMG_SRC", ilUtil::getImagePath("mcst_preview.svg"));
460  }
461  $mp_tpl->setVariable("PTITLE", $this->getTitle());
462  $mp_tpl->parseCurrentBlock();
463  $preview_output = true;
464  }
465  $mp_tpl->setCurrentBlock("audio");
466  if ($preview_output) {
467  $mp_tpl->setVariable("ASTYLE", "margin-top:-30px");
468  }
469  $mp_tpl->setVariable("AFILE", $this->getFile());
470  $mp_tpl->setVariable("APLAYER_NR", $this->id . "_" . $this->current_nr);
471  $mp_tpl->setVariable("AEVENT_URL", $this->event_callback_url);
472  $mp_tpl->setVariable("AHEIGHT", "30");
473  $mp_tpl->setVariable("AWIDTH", "320");
474  $mp_tpl->parseCurrentBlock();
475  return $mp_tpl->get();
476  }
477 
478  // images
479  if (is_int(strpos($mimeType, "image/"))) {
480  $mp_tpl = new ilTemplate("tpl.flv_player.html", true, true, "Services/MediaObjects");
481 
482  if ($this->getDownloadLink() != "") {
483  $mp_tpl->setCurrentBlock("idownload");
484  $mp_tpl->setVariable("TXT_DOWNLOAD", $lng->txt("download"));
485  $mp_tpl->setVariable("HREF_DOWNLOAD", $this->getDownloadLink());
486  $mp_tpl->parseCurrentBlock();
487  }
488 
489  $mp_tpl->setCurrentBlock("ipreview");
490  if ($this->getVideoPreviewPic() != "") {
491  $mp_tpl->setVariable("IMG_SRC", $this->getVideoPreviewPic());
492  } else {
493  $mp_tpl->setVariable("IMG_SRC", $this->getFile());
494  }
495  $mp_tpl->setVariable("PTITLE", $this->getTitle());
496  $mp_tpl->parseCurrentBlock();
497 
498  $mp_tpl->setCurrentBlock("image");
499  $mp_tpl->setVariable("IFILE", $this->getFile());
500  $mp_tpl->setVariable("IPLAYER_NR", $this->id . "_" . $this->current_nr);
501  $mp_tpl->setVariable("ITITLE", $this->getTitle());
502  $mp_tpl->setVariable("IDESCRIPTION", $this->getDescription());
503  include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
504  $mp_tpl->setVariable("ICLOSE", ilGlyphGUI::get(ilGlyphGUI::CLOSE));
505 
506  if ($this->event_callback_url) {
507  $mp_tpl->setVariable("IMG_CALLBACK_URL", $this->event_callback_url);
508  $mp_tpl->setVariable("IMG_CALLBACK_PLAYER_NR", $this->id . "_" . $this->current_nr);
509  }
510 
511  $mp_tpl->setVariable("IHEIGHT", $this->getDisplayHeight());
512  $mp_tpl->setVariable("IWIDTH", $this->getDisplayWidth());
513  $mp_tpl->parseCurrentBlock();
514 
515  return $mp_tpl->get();
516  }
517 
518  // fallback, no preview mode
519  $mimeType = $this->mimeType == "" ? ilObjMediaObject::getMimeType(basename($this->getFile())) : $this->mimeType;
520  if (strpos($mimeType, "flv") === false
521  && strpos($mimeType, "audio/mpeg") === false
522  && strpos($mimeType, "image/png") === false
523  && strpos($mimeType, "image/gif") === false) {
524  $html = '<embed src="' . $this->getFile() . '" ' .
525  'type="' . $mimeType . '" ' .
526  'ShowControls="1" ' .
527  'autoplay="false" autostart="false" ' .
528  'width="320" height="240" scale="aspect" ></embed>';
529  return $html;
530  }
531 
532  return;
533  $tpl->addJavaScript("./Services/MediaObjects/flash_flv_player/swfobject.js");
534  $mp_tpl = new ilTemplate("tpl.flv_player.html", true, true, "Services/MediaObjects");
535  $mp_tpl->setCurrentBlock("default");
536  $mp_tpl->setVariable("FILE", urlencode($this->getFile()));
537  $mp_tpl->setVariable("PLAYER_NR", $this->current_nr);
538  $mp_tpl->setVariable("DISPLAY_HEIGHT", strpos($mimeType, "audio/mpeg") === false ? "240" : "20");
539  $mp_tpl->setVariable("DISPLAY_WIDTH", "320");
540  $mp_tpl->parseCurrentBlock();
541  return $mp_tpl->get();
542  }
ilObjMediaObject\getMimeType
static getMimeType($a_file, $a_external=null)
get mime type for file
Definition: class.ilObjMediaObject.php:1492
ilMediaPlayerGUI\getVideoPreviewPic
getVideoPreviewPic()
Get video preview picture.
Definition: class.ilMediaPlayerGUI.php:170
ilExternalMediaAnalyzer\isYouTube
static isYouTube($a_location)
Identify YouTube links.
Definition: class.ilExternalMediaAnalyzer.php:38
ilMediaPlayerGUI\getDisplayHeight
getDisplayHeight()
return display height of player.
Definition: class.ilMediaPlayerGUI.php:124
ilMediaPlayerGUI\getDescription
getDescription()
Get description.
Definition: class.ilMediaPlayerGUI.php:210
ilMediaPlayerGUI\getDownloadLink
getDownloadLink()
Get download link.
Definition: class.ilMediaPlayerGUI.php:250
ilPlayerUtil\getFlashVideoPlayerFilename
static getFlashVideoPlayerFilename($a_fullpath=false)
Get flash video player file name.
Definition: class.ilPlayerUtil.php:92
ilGlyphGUI\get
static get($a_glyph, $a_text="")
Get glyph html.
Definition: class.ilGlyphGUI.php:56
ilLightboxGUI
Lighbox handling.
Definition: class.ilLightboxGUI.php:12
ilMediaPlayerGUI\getAlternativeVideoMimeType
getAlternativeVideoMimeType()
Get alternative video mime type.
Definition: class.ilMediaPlayerGUI.php:104
$r
$r
Definition: example_031.php:79
ilMediaPlayerGUI\getAlternativeVideoFile
getAlternativeVideoFile()
Get alternative video file.
Definition: class.ilMediaPlayerGUI.php:84
ilUtil\getImagePath
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
Definition: class.ilUtil.php:79
ilTemplate
special template class to simplify handling of ITX/PEAR
Definition: class.ilTemplate.php:13
ilPlayerUtil\initMediaElementJs
static initMediaElementJs($a_tpl=null)
Init mediaelement.js scripts.
Definition: class.ilPlayerUtil.php:35
ilExternalMediaAnalyzer\extractVimeoParameters
static extractVimeoParameters($a_location)
Extract Vimeo Parameter.
Definition: class.ilExternalMediaAnalyzer.php:159
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19
ilExternalMediaAnalyzer\isVimeo
static isVimeo($a_location)
Identify Vimeo links.
Definition: class.ilExternalMediaAnalyzer.php:148
ilExternalMediaAnalyzer\extractYouTubeParameters
static extractYouTubeParameters($a_location)
Extract YouTube Parameter.
Definition: class.ilExternalMediaAnalyzer.php:50
ilMediaPlayerGUI\getDisplayWidth
getDisplayWidth()
Get display width.
Definition: class.ilMediaPlayerGUI.php:144
ilMediaPlayerGUI\getForceAudioPreview
getForceAudioPreview()
Get force audio preview.
Definition: class.ilMediaPlayerGUI.php:230
$html
$html
Definition: example_001.php:87
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getPreviewHtml()

ilMediaPlayerGUI::getPreviewHtml ( )

Get preview html.

Returns
string html

Definition at line 549 of file class.ilMediaPlayerGUI.php.

References getMp3PlayerHtml().

550  {
551  return $this->getMp3PlayerHtml(true);
552  }
ilMediaPlayerGUI\getMp3PlayerHtml
getMp3PlayerHtml($a_preview=false)
Get Html for MP3 Player.
Definition: class.ilMediaPlayerGUI.php:282
+ Here is the call graph for this function:

◆ getTitle()

ilMediaPlayerGUI::getTitle ( )

Get Title.

Returns
string title

Definition at line 190 of file class.ilMediaPlayerGUI.php.

References $title.

Referenced by getMp3PlayerHtml().

191  {
192  return $this->title;
193  }
+ Here is the caller graph for this function:

◆ getVideoPreviewPic()

ilMediaPlayerGUI::getVideoPreviewPic ( )

Get video preview picture.

Returns
string video preview picture

Definition at line 170 of file class.ilMediaPlayerGUI.php.

Referenced by getMp3PlayerHtml().

171  {
172  return $this->video_preview_pic;
173  }
+ Here is the caller graph for this function:

◆ initJavascript()

static ilMediaPlayerGUI::initJavascript (   $a_tpl = null)
static

Init Javascript.

Parameters
null$a_tpl

Definition at line 259 of file class.ilMediaPlayerGUI.php.

References $DIC, $tpl, ilYuiUtil\initConnection(), and ilPlayerUtil\initMediaElementJs().

Referenced by ilNewsTimelineGUI\show().

260  {
261  global $DIC;
262 
263  $tpl = $DIC["tpl"];
264 
265  if ($a_tpl == null) {
266  $a_tpl = $tpl;
267  }
268 
269  include_once("./Services/YUI/classes/class.ilYuiUtil.php");
270  ilYuiUtil::initConnection();
271 
272  $a_tpl->addJavascript("./Services/MediaObjects/js/MediaObjects.js");
273 
274  include_once("./Services/MediaObjects/classes/class.ilPlayerUtil.php");
275  ilPlayerUtil::initMediaElementJs($a_tpl);
276  }
$DIC
global $DIC
Definition: saml.php:7
ilYuiUtil\initConnection
static initConnection(ilTemplate $a_main_tpl=null)
Init YUI Connection module.
Definition: class.ilYuiUtil.php:18
ilPlayerUtil\initMediaElementJs
static initMediaElementJs($a_tpl=null)
Init mediaelement.js scripts.
Definition: class.ilPlayerUtil.php:35
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setAlternativeVideoFile()

ilMediaPlayerGUI::setAlternativeVideoFile (   $a_val)

Set alternative video file.

Parameters
string$a_valalternative video file

Definition at line 74 of file class.ilMediaPlayerGUI.php.

75  {
76  $this->alt_video_file = $a_val;
77  }

◆ setAlternativeVideoMimeType()

ilMediaPlayerGUI::setAlternativeVideoMimeType (   $a_val)

Set alternative video mime type.

Parameters
string$a_valalternative video mime type

Definition at line 94 of file class.ilMediaPlayerGUI.php.

95  {
96  $this->alt_video_mime = $a_val;
97  }

◆ setDescription()

ilMediaPlayerGUI::setDescription (   $a_val)

Set description.

Parameters
string$a_valdescription

Definition at line 200 of file class.ilMediaPlayerGUI.php.

201  {
202  $this->description = $a_val;
203  }

◆ setDisplayHeight()

ilMediaPlayerGUI::setDisplayHeight (   $dHeight)

set display height

Parameters
int$dHeight

Definition at line 114 of file class.ilMediaPlayerGUI.php.

115  {
116  $this->displayHeight = $dHeight;
117  }

◆ setDisplayWidth()

ilMediaPlayerGUI::setDisplayWidth (   $a_val)

Set display width.

Parameters
string$a_valdisplay width

Definition at line 134 of file class.ilMediaPlayerGUI.php.

135  {
136  $this->displayWidth = $a_val;
137  }

◆ setDownloadLink()

ilMediaPlayerGUI::setDownloadLink (   $a_val)

Set download link.

Parameters
string$a_valdownload link

Definition at line 240 of file class.ilMediaPlayerGUI.php.

241  {
242  $this->download_link = $a_val;
243  }

◆ setFile()

ilMediaPlayerGUI::setFile (   $a_file)

Set File.

Parameters
string$a_fileFile

Definition at line 54 of file class.ilMediaPlayerGUI.php.

References file.

Referenced by ilDclMobRecordRepresentation\getHTML(), and ilNewsTimelineItemGUI\render().

55  {
56  $this->file = $a_file;
57  }
file
Reload workbook from saved file
Definition: 02types-xls.php:163
+ Here is the caller graph for this function:

◆ setForceAudioPreview()

ilMediaPlayerGUI::setForceAudioPreview (   $a_val)

Set force audio preview.

Parameters
boolean$a_valforce audio preview picture

Definition at line 220 of file class.ilMediaPlayerGUI.php.

221  {
222  $this->force_audio_preview = $a_val;
223  }

◆ setMimeType()

ilMediaPlayerGUI::setMimeType (   $value)

Definition at line 149 of file class.ilMediaPlayerGUI.php.

150  {
151  $this->mimeType = $value;
152  }

◆ setTitle()

ilMediaPlayerGUI::setTitle (   $a_val)

Set Title.

Parameters
string$a_valtitle

Definition at line 180 of file class.ilMediaPlayerGUI.php.

181  {
182  $this->title = $a_val;
183  }

◆ setVideoPreviewPic()

ilMediaPlayerGUI::setVideoPreviewPic (   $a_val,
  $a_alt = "" 
)

Set video preview picture.

Parameters
string$a_valvideo preview picture

Definition at line 159 of file class.ilMediaPlayerGUI.php.

160  {
161  $this->video_preview_pic = $a_val;
162  $this->video_preview_pic_alt = $a_alt;
163  }

Field Documentation

◆ $current_nr

ilMediaPlayerGUI::$current_nr
protected

Definition at line 31 of file class.ilMediaPlayerGUI.php.

◆ $description

ilMediaPlayerGUI::$description
protected

Definition at line 33 of file class.ilMediaPlayerGUI.php.

Referenced by getDescription().

◆ $displayHeight

ilMediaPlayerGUI::$displayHeight = "480"
protected

Definition at line 26 of file class.ilMediaPlayerGUI.php.

Referenced by getDisplayHeight().

◆ $displayWidth

ilMediaPlayerGUI::$displayWidth = "640"
protected

Definition at line 27 of file class.ilMediaPlayerGUI.php.

Referenced by getDisplayWidth().

◆ $download_link

ilMediaPlayerGUI::$download_link = ""
protected

Definition at line 35 of file class.ilMediaPlayerGUI.php.

Referenced by getDownloadLink().

◆ $event_callback_url

ilMediaPlayerGUI::$event_callback_url = ""
protected

Definition at line 34 of file class.ilMediaPlayerGUI.php.

◆ $file

ilMediaPlayerGUI::$file
protected

Definition at line 25 of file class.ilMediaPlayerGUI.php.

Referenced by getFile().

◆ $lightbox_initialized

ilMediaPlayerGUI::$lightbox_initialized = false
staticprotected

Definition at line 30 of file class.ilMediaPlayerGUI.php.

◆ $lng

ilMediaPlayerGUI::$lng
protected

Definition at line 23 of file class.ilMediaPlayerGUI.php.

Referenced by getMp3PlayerHtml().

◆ $mimeType

ilMediaPlayerGUI::$mimeType
protected

Definition at line 28 of file class.ilMediaPlayerGUI.php.

Referenced by getMp3PlayerHtml().

◆ $nr

ilMediaPlayerGUI::$nr = 1
staticprotected

Definition at line 29 of file class.ilMediaPlayerGUI.php.

◆ $title

ilMediaPlayerGUI::$title
protected

Definition at line 32 of file class.ilMediaPlayerGUI.php.

Referenced by getTitle().

◆ $tpl

ilMediaPlayerGUI::$tpl
protected

Definition at line 18 of file class.ilMediaPlayerGUI.php.

Referenced by getMp3PlayerHtml(), and initJavascript().

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