ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
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.
 getFile ()
 Get File.
 setAlternativeVideoFile ($a_val)
 Set alternative video file.
 getAlternativeVideoFile ()
 Get alternative video file.
 setAlternativeVideoMimeType ($a_val)
 Set alternative video mime type.
 getAlternativeVideoMimeType ()
 Get alternative video mime type.
 setDisplayHeight ($dHeight)
 set display height
 getDisplayHeight ()
 return display height of player.
 setDisplayWidth ($a_val)
 Set display width.
 getDisplayWidth ()
 Get display width.
 setMimeType ($value)
 setVideoPreviewPic ($a_val, $a_alt="")
 Set video preview picture.
 getVideoPreviewPic ()
 Get video preview picture.
 setTitle ($a_val)
 Set Title.
 getTitle ()
 Get Title.
 setDescription ($a_val)
 Set description.
 getDescription ()
 Get description.
 setForceAudioPreview ($a_val)
 Set force audio preview.
 getForceAudioPreview ()
 Get force audio preview.
 setDownloadLink ($a_val)
 Set download link.
 getDownloadLink ()
 Get download link.
 getMp3PlayerHtml ($a_preview=false)
 Get Html for MP3 Player.
 getPreviewHtml ()
 Get preview html.
 getMediaPlayerHtml ()
 Get HTML (no preview) for media player integration.

Protected Attributes

 $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

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

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

References $nr.

{
$this->id = $a_id;
$this->event_callback_url = $a_event_callback_url;
$this->current_nr = self::$nr;
self::$nr++;
}

Member Function Documentation

ilMediaPlayerGUI::getAlternativeVideoFile ( )

Get alternative video file.

Returns
string alternative video file

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

Referenced by getMp3PlayerHtml().

{
return $this->alt_video_file;
}

+ Here is the caller graph for this function:

ilMediaPlayerGUI::getAlternativeVideoMimeType ( )

Get alternative video mime type.

Returns
string alternative video mime type

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

Referenced by getMp3PlayerHtml().

{
return $this->alt_video_mime;
}

+ Here is the caller graph for this function:

ilMediaPlayerGUI::getDescription ( )

Get description.

Returns
string description

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

References $description.

Referenced by getMp3PlayerHtml().

{
return $this->description;
}

+ Here is the caller graph for this function:

ilMediaPlayerGUI::getDisplayHeight ( )

return display height of player.

Returns
int

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

References $displayHeight.

Referenced by getMp3PlayerHtml().

{
return $this->displayHeight;
}

+ Here is the caller graph for this function:

ilMediaPlayerGUI::getDisplayWidth ( )

Get display width.

Returns
string display width

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

References $displayWidth.

Referenced by getMp3PlayerHtml().

{
return $this->displayWidth;
}

+ Here is the caller graph for this function:

ilMediaPlayerGUI::getDownloadLink ( )

Get download link.

Returns
string download link

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

References $download_link.

Referenced by getMp3PlayerHtml().

{
return $this->download_link;
}

+ Here is the caller graph for this function:

ilMediaPlayerGUI::getFile ( )

Get File.

Returns
string File

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

References $file.

Referenced by getMp3PlayerHtml().

{
return $this->file;
}

+ Here is the caller graph for this function:

ilMediaPlayerGUI::getForceAudioPreview ( )

Get force audio preview.

Returns
boolean force audio preview picture

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

Referenced by getMp3PlayerHtml().

{
return $this->force_audio_preview;
}

+ Here is the caller graph for this function:

ilMediaPlayerGUI::getMediaPlayerHtml ( )

Get HTML (no preview) for media player integration.

Returns
string html

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

References getMp3PlayerHtml().

{
return $this->getMp3PlayerHtml(false);
}

+ Here is the call graph for this function:

ilMediaPlayerGUI::getMp3PlayerHtml (   $a_preview = false)

Get Html for MP3 Player.

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

References $lng, $mimeType, $tpl, ilGlyphGUI\CLOSE, ilGlyphGUI\get(), getAlternativeVideoFile(), getAlternativeVideoMimeType(), getDescription(), getDisplayHeight(), getDisplayWidth(), getDownloadLink(), getFile(), ilPlayerUtil\getFlashVideoPlayerFilename(), getForceAudioPreview(), ilUtil\getImagePath(), ilObjMediaObject\getMimeType(), getTitle(), getVideoPreviewPic(), ilYuiUtil\initConnection(), and ilPlayerUtil\initMediaElementJs().

Referenced by getMediaPlayerHtml(), and getPreviewHtml().

{
global $tpl, $lng;
include_once("./Services/YUI/classes/class.ilYuiUtil.php");
ilYuiUtil::initConnection();
$tpl->addJavascript("./Services/MediaObjects/js/MediaObjects.js");
if (!self::$lightbox_initialized && $a_preview)
{
include_once("./Services/UIComponent/Lightbox/classes/class.ilLightboxGUI.php");
$lb = new ilLightboxGUI("media_lightbox");
$lb->setWidth("660px");
$lb->addLightbox();
self::$lightbox_initialized = true;
}
require_once 'Services/MediaObjects/classes/class.ilObjMediaObject.php';
include_once("./Services/MediaObjects/classes/class.ilExternalMediaAnalyzer.php");
// youtube
/* if (ilExternalMediaAnalyzer::isYouTube($this->getFile()))
{
$p = ilExternalMediaAnalyzer::extractYouTubeParameters($this->getFile());
$html = '<object width="320" height="240">'.
'<param name="movie" value="http://www.youtube.com/v/'.$p["v"].'?fs=1">'.
'</param><param name="allowFullScreen" value="true"></param>'.
'<param name="allowscriptaccess" value="always">'.
'</param><embed src="http://www.youtube.com/v/'.$p["v"].'?fs=1" '.
'type="application/x-shockwave-flash" allowscriptaccess="always" '.
'allowfullscreen="true" width="320" height="240"></embed></object>';
return $html;
}
// vimeo
if (ilExternalMediaAnalyzer::isVimeo($this->getFile()))
{
$p = ilExternalMediaAnalyzer::extractVimeoParameters($this->getFile());
$html = '<iframe src="http://player.vimeo.com/video/'.$p["id"].'" width="320" height="240" '.
'frameborder="0"></iframe>';
return $html;
}
*/
$mimeType = $this->mimeType == "" ? ilObjMediaObject::getMimeType(basename($this->getFile())) : $this->mimeType;
include_once("./Services/MediaObjects/classes/class.ilPlayerUtil.php");
// video tag
if (in_array($mimeType, array("video/mp4", "video/m4v", "video/rtmp",
"video/x-flv", "video/webm", "video/youtube", "video/vimeo", "video/ogg")))
{
ilPlayerUtil::initMediaElementJs();
if ($mimeType == "video/quicktime")
{
$mimeType = "video/mov";
}
$mp_tpl = new ilTemplate("tpl.flv_player.html", true, true, "Services/MediaObjects");
// preview
if ($a_preview)
{
if ($this->getDownloadLink() != "")
{
$mp_tpl->setCurrentBlock("download");
$mp_tpl->setVariable("TXT_DOWNLOAD", $lng->txt("download"));
$mp_tpl->setVariable("HREF_DOWNLOAD", $this->getDownloadLink());
$mp_tpl->parseCurrentBlock();
}
$mp_tpl->setCurrentBlock("preview");
if ($this->getVideoPreviewPic() != "")
{
$mp_tpl->setVariable("IMG_SRC", $this->getVideoPreviewPic());
}
else
{
$mp_tpl->setVariable("IMG_SRC", ilUtil::getImagePath("mcst_preview.svg"));
}
$mp_tpl->setVariable("IMG_ALT", $this->video_preview_pic_alt);
$mp_tpl->setVariable("PTITLE", $this->getTitle());
$mp_tpl->parseCurrentBlock();
}
// sources
$mp_tpl->setCurrentBlock("source");
$mp_tpl->setVariable("FILE", $this->getFile());
$mp_tpl->setVariable("MIME", $mimeType);
$mp_tpl->parseCurrentBlock();
if (in_array($this->getAlternativeVideoMimeType(), array("video/mp4", "video/webm")))
{
$mp_tpl->setCurrentBlock("source");
$mp_tpl->setVariable("FILE", $this->getAlternativeVideoFile());
$mp_tpl->setVariable("MIME", $this->getAlternativeVideoMimeType());
$mp_tpl->parseCurrentBlock();
}
$mp_tpl->setCurrentBlock("mejs_video");
if ($a_preview)
{
$mp_tpl->setVariable("CLASS", "ilNoDisplay");
}
$mp_tpl->setVariable("PLAYER_NR", $this->id."_".$this->current_nr);
$mp_tpl->setVariable("EVENT_URL", $this->event_callback_url);
$height = $this->getDisplayHeight();
$width = $this->getDisplayWidth();
if (is_int(strpos($mimeType,"audio/mpeg")))
{
$height = "30";
}
$mp_tpl->setVariable("DISPLAY_HEIGHT", $height);
$mp_tpl->setVariable("DISPLAY_WIDTH", $width);
$mp_tpl->setVariable("PREVIEW_PIC", $this->getVideoPreviewPic());
$mp_tpl->setVariable("SWF_FILE", ilPlayerUtil::getFlashVideoPlayerFilename(true));
$mp_tpl->setVariable("FFILE", $this->getFile());
$mp_tpl->setVariable("TITLE", $this->getTitle());
$mp_tpl->setVariable("DESCRIPTION", $this->getDescription());
include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
if ($a_preview)
{
$mp_tpl->setVariable("CLOSE", ilGlyphGUI::get(ilGlyphGUI::CLOSE));
}
$mp_tpl->parseCurrentBlock();
$r = $mp_tpl->get();
if (!$a_preview)
{
$tpl->addOnLoadCode("new MediaElementPlayer('#player_".$this->id."_".$this->current_nr."');");
}
//echo htmlentities($r);
return $r;
}
// audio/mpeg
if (is_int(strpos($mimeType,"audio/mpeg")) ||
in_array($mimeType, array("application/ogg", "audio/ogg")))
{
ilPlayerUtil::initMediaElementJs();
$mp_tpl = new ilTemplate("tpl.flv_player.html", true, true, "Services/MediaObjects");
$preview_output = false;
if ($this->getVideoPreviewPic() != "" || $this->getForceAudioPreview())
{
if ($this->getDownloadLink() != "")
{
$mp_tpl->setCurrentBlock("adownload");
$mp_tpl->setVariable("TXT_DOWNLOAD", $lng->txt("download"));
$mp_tpl->setVariable("HREF_DOWNLOAD", $this->getDownloadLink());
$mp_tpl->parseCurrentBlock();
}
$mp_tpl->setCurrentBlock("apreview");
if ($this->getVideoPreviewPic() != "")
{
$mp_tpl->setVariable("IMG_SRC", $this->getVideoPreviewPic());
}
else
{
$mp_tpl->setVariable("IMG_SRC", ilUtil::getImagePath("mcst_preview.svg"));
}
$mp_tpl->setVariable("PTITLE", $this->getTitle());
$mp_tpl->parseCurrentBlock();
$preview_output = true;
}
$mp_tpl->setCurrentBlock("audio");
if ($preview_output)
{
$mp_tpl->setVariable("ASTYLE", "margin-top:-30px");
}
$mp_tpl->setVariable("AFILE", $this->getFile());
$mp_tpl->setVariable("APLAYER_NR", $this->id."_".$this->current_nr);
$mp_tpl->setVariable("AEVENT_URL", $this->event_callback_url);
$mp_tpl->setVariable("AHEIGHT", "30");
$mp_tpl->setVariable("AWIDTH", "320");
$mp_tpl->parseCurrentBlock();
return $mp_tpl->get();
}
// images
if (is_int(strpos($mimeType,"image/")))
{
$mp_tpl = new ilTemplate("tpl.flv_player.html", true, true, "Services/MediaObjects");
if ($this->getDownloadLink() != "")
{
$mp_tpl->setCurrentBlock("idownload");
$mp_tpl->setVariable("TXT_DOWNLOAD", $lng->txt("download"));
$mp_tpl->setVariable("HREF_DOWNLOAD", $this->getDownloadLink());
$mp_tpl->parseCurrentBlock();
}
$mp_tpl->setCurrentBlock("ipreview");
if ($this->getVideoPreviewPic() != "")
{
$mp_tpl->setVariable("IMG_SRC", $this->getVideoPreviewPic());
}
else
{
$mp_tpl->setVariable("IMG_SRC", $this->getFile());
}
$mp_tpl->setVariable("PTITLE", $this->getTitle());
$mp_tpl->parseCurrentBlock();
$mp_tpl->setCurrentBlock("image");
$mp_tpl->setVariable("IFILE", $this->getFile());
$mp_tpl->setVariable("IPLAYER_NR", $this->id."_".$this->current_nr);
$mp_tpl->setVariable("ITITLE", $this->getTitle());
$mp_tpl->setVariable("IDESCRIPTION", $this->getDescription());
include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
$mp_tpl->setVariable("ICLOSE", ilGlyphGUI::get(ilGlyphGUI::CLOSE));
$height = $this->getDisplayHeight();
$width = $this->getDisplayWidth();
$mp_tpl->setVariable("IHEIGHT", $height);
$mp_tpl->setVariable("IWIDTH", $width);
$mp_tpl->parseCurrentBlock();
return $mp_tpl->get();
}
// fallback, no preview mode
$mimeType = $this->mimeType == "" ? ilObjMediaObject::getMimeType(basename($this->getFile())) : $this->mimeType;
if (strpos($mimeType,"flv") === false
&& strpos($mimeType,"audio/mpeg") === false
&& strpos($mimeType,"image/png") === false
&& strpos($mimeType,"image/gif") === false)
{
$html = '<embed src="'.$this->getFile().'" '.
'type="'.$mimeType.'" '.
'ShowControls="1" '.
'autoplay="false" autostart="false" '.
'width="320" height="240" scale="aspect" ></embed>';
return $html;
}
return;
$tpl->addJavaScript("./Services/MediaObjects/flash_flv_player/swfobject.js");
$mp_tpl = new ilTemplate("tpl.flv_player.html", true, true, "Services/MediaObjects");
$mp_tpl->setCurrentBlock("default");
$mp_tpl->setVariable("FILE", urlencode($this->getFile()));
$mp_tpl->setVariable("PLAYER_NR", $this->current_nr);
$mp_tpl->setVariable("DISPLAY_HEIGHT", strpos($mimeType,"audio/mpeg") === false ? "240" : "20");
$mp_tpl->setVariable("DISPLAY_WIDTH", "320");
$mp_tpl->parseCurrentBlock();
return $mp_tpl->get();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilMediaPlayerGUI::getPreviewHtml ( )

Get preview html.

Returns
string html

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

References getMp3PlayerHtml().

{
return $this->getMp3PlayerHtml(true);
}

+ Here is the call graph for this function:

ilMediaPlayerGUI::getTitle ( )

Get Title.

Returns
string title

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

References $title.

Referenced by getMp3PlayerHtml().

{
return $this->title;
}

+ Here is the caller graph for this function:

ilMediaPlayerGUI::getVideoPreviewPic ( )

Get video preview picture.

Returns
string video preview picture

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

Referenced by getMp3PlayerHtml().

{
return $this->video_preview_pic;
}

+ Here is the caller graph for this function:

ilMediaPlayerGUI::setAlternativeVideoFile (   $a_val)

Set alternative video file.

Parameters
string$a_valalternative video file

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

{
$this->alt_video_file = $a_val;
}
ilMediaPlayerGUI::setAlternativeVideoMimeType (   $a_val)

Set alternative video mime type.

Parameters
string$a_valalternative video mime type

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

{
$this->alt_video_mime = $a_val;
}
ilMediaPlayerGUI::setDescription (   $a_val)

Set description.

Parameters
string$a_valdescription

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

{
$this->description = $a_val;
}
ilMediaPlayerGUI::setDisplayHeight (   $dHeight)

set display height

Parameters
int$dHeight

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

{
$this->displayHeight = $dHeight;
}
ilMediaPlayerGUI::setDisplayWidth (   $a_val)

Set display width.

Parameters
string$a_valdisplay width

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

{
$this->displayWidth = $a_val;
}
ilMediaPlayerGUI::setDownloadLink (   $a_val)

Set download link.

Parameters
string$a_valdownload link

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

{
$this->download_link = $a_val;
}
ilMediaPlayerGUI::setFile (   $a_file)

Set File.

Parameters
string$a_fileFile

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

Referenced by ilDataCollectionDatatype\parseHTML(), and ilObjMediaCastGUI\showGallery().

{
$this->file = $a_file;
}

+ Here is the caller graph for this function:

ilMediaPlayerGUI::setForceAudioPreview (   $a_val)

Set force audio preview.

Parameters
boolean$a_valforce audio preview picture

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

{
$this->force_audio_preview = $a_val;
}
ilMediaPlayerGUI::setMimeType (   $value)

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

{
$this->mimeType = $value;
}
ilMediaPlayerGUI::setTitle (   $a_val)

Set Title.

Parameters
string$a_valtitle

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

{
$this->title = $a_val;
}
ilMediaPlayerGUI::setVideoPreviewPic (   $a_val,
  $a_alt = "" 
)

Set video preview picture.

Parameters
string$a_valvideo preview picture

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

{
$this->video_preview_pic = $a_val;
$this->video_preview_pic_alt = $a_alt;
}

Field Documentation

ilMediaPlayerGUI::$current_nr
protected

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

ilMediaPlayerGUI::$description
protected

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

Referenced by getDescription().

ilMediaPlayerGUI::$displayHeight = "480"
protected

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

Referenced by getDisplayHeight().

ilMediaPlayerGUI::$displayWidth = "640"
protected

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

Referenced by getDisplayWidth().

ilMediaPlayerGUI::$download_link = ""
protected

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

Referenced by getDownloadLink().

ilMediaPlayerGUI::$event_callback_url = ""
protected

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

ilMediaPlayerGUI::$file
protected

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

Referenced by getFile().

ilMediaPlayerGUI::$lightbox_initialized = false
staticprotected

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

ilMediaPlayerGUI::$mimeType
protected

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

Referenced by getMp3PlayerHtml().

ilMediaPlayerGUI::$nr = 1
staticprotected

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

Referenced by __construct().

ilMediaPlayerGUI::$title
protected

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

Referenced by getTitle().

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