Source for file video.php

Documentation is available at video.php

  1. <?php
  2. // This file is part of the Sloodle project (www.sloodle.org) and is released under the GNU GPL v3.
  3.  
  4. /**
  5. * Defines the SLOODLE Presenter plugin for showing video slides.
  6. *
  7. * @package sloodle
  8. * @copyright Copyright (c) 2009 Sloodle (various contributors)
  9. * @license http://www.gnu.org/licenses/gpl-3.0.html GNU GPL v3
  10. * @since Sloodle 0.4.1
  11. *
  12. * @contributor Peter R. Bloomfield
  13. * @contributor dz questi (YouTube link conversion)
  14. *
  15. */
  16.  
  17.  
  18. /**
  19. * Presenter plugin for showing video slides.
  20. *
  21. * @package sloodle
  22. */
  23. class SloodlePluginPresenterSlideVideo extends SloodlePluginBasePresenterSlide
  24. {
  25.  
  26.     /**
  27.     * Construct an absolute URL, based on the given source data.
  28.     * Leaves existing absolute URLs alone, but converts relative URLs as necessary.
  29.     * (This allows the site to be moved without disrupting these slides.)
  30.     * @param string $source The source data from the slide.
  31.     * @return string An absolute URL.
  32.     */
  33.     function get_absolute_url($source)
  34.     {
  35.         global $CFG;
  36.         // If we have a protocol specifier, then assume this is already an absolute URL
  37.         if (strpos($source, '://') !== false) return $source;
  38.         // Assume the source URL is relative to the Moodle WWW root.
  39.         // Make sure we don't duplicate a forward slash.
  40.         if (strpos($source, '/') === 0) return $CFG->wwwroot.$source;
  41.         return $CFG->wwwroot.'/'.$source;
  42.     }
  43.  
  44.     /**
  45.     * Render the given slide for browser output -- NOTE: render to a string, and return the string.
  46.     * The title of the slide need not be included -- simply the basic iFrame or embedded player etc.
  47.     * @param SloodlePresenterSlide $slide An object containing the raw slide data.
  48.     * @return string 
  49.     */
  50.     function render_slide_for_browser($slide)
  51.     {
  52.         $url = $this->get_absolute_url($slide->source);
  53.         $framewidth = 500;
  54.         $frameheight = 500;
  55.         if (isset($this->presenter)) {
  56.             $framewidth = $this->presenter->get_frame_width();
  57.             $frameheight = $this->presenter->get_frame_height();
  58.         }
  59.         
  60.         // Check to see if we can use a proper embedded player from a video sharing site
  61.         if (strpos($url, '://www.youtube.com') !== false || strpos($url, '://youtube.com') !== false) {
  62.             // Embed a YouTube player
  63.             $index = strpos($url, 'v=');
  64.             $vidid = substr($url, $index + 2, 11);
  65.             $output = <<<XXXEODXXX
  66. <object width="{$framewidth}" height="{$frameheight}">
  67.  <param name="movie" value="http://www.youtube.com/v/{$vidid}"></param>
  68.  <param name="allowFullScreen" value="true"></param>
  69.  <param name="allowscriptaccess" value="always"></param>
  70.  <embed src="http://www.youtube.com/v/{$vidid}" type="application/x-shockwave-flash" allowscriptaccess="always" allowfullscreen="true" width="{$framewidth}" height="{$frameheight}"></embed>
  71. </object>
  72. XXXEODXXX;
  73.         } else {
  74.             // Just embed the video normally
  75.             $output = "<embed src=\"{$url}\" align=\"center\" autoplay=\"true\" controller=\"true\" width=\"{$framewidth}\" height=\"{$frameheight}\" scale=\"aspect\" />";
  76.         }
  77.  
  78.         return $output;
  79.     }
  80.  
  81.     /**
  82.     * Render the given slide for virtual-world output.
  83.     * This returns two items of data in a numeric array.
  84.     * The first is the virtual world compatible type identifier: web, image, video, or audio (or a mime type).
  85.     * The second is the absolute URL to give it.
  86.     * @param SloodlePresenterSlide $slide An object containing the raw slide data.
  87.     * @return array Numeric array containg (type, url)
  88.     */
  89.     function render_slide_for_sl($slide)
  90.     {
  91.         $url = $this->get_absolute_url($slide->source);
  92.         $type = 'video/*';
  93.         
  94.         // Check to see if we need to convert the video URL for video-sharing sites
  95.         if (strpos($url, '://www.youtube.com') !== false || strpos($url, '://youtube.com') !== false) {
  96.             $index = strpos($url, 'v=');
  97.             $vidid = substr($url, $index + 2, 11);
  98.             $url = "http://www.youtubemp4.com/video/".$vidid.".mp4";
  99.             $type = "video/mp4";
  100.         }
  101.  
  102.         return array($type, $url);
  103.     }
  104.  
  105.     /**
  106.     * Gets the human-readable name of this plugin.
  107.     * This MUST be overridden by base classes. If not, it will just return the name of the class.
  108.     * @param string $lang Optional -- can specify the language we want the plugin name in, as an identifier like "en_utf8". If unspecified, then the current Moodle language should be used.
  109.     * @access public
  110.     * @return string The human-readable name of this plugin
  111.     */
  112.     function get_plugin_name($lang = null)
  113.     {
  114.         return 'Video';
  115.     }
  116.  
  117.     /**
  118.     * Gets the internal version number of this plugin.
  119.     * This MUST be overridden.
  120.     * This should be a number like the internal version number for Moodle modules, containing the date and release number.
  121.     * Format is: YYYYMMDD##.
  122.     * For example, "2009012302" would be the 3rd release on the 23rd January 2009.
  123.     * @return int The version number of this module.
  124.     */
  125.     function get_version()
  126.     {
  127.         return 2009050600;
  128.     }
  129.  
  130.  
  131. }
  132.  
  133.  
  134. ?>

Documentation generated on Fri, 17 Jul 2009 11:02:45 +0100 by phpDocumentor 1.4.0