You are here

Home » API reference » MediaElement 7.2

mediaelement.module in MediaElement 7.2

Same filename and directory in other branches
  1. 8 mediaelement.module
  2. 6 mediaelement.module
  3. 7 mediaelement.module

Provides HTML5 video and audio elements using Mediaelement.js for HTML4 browsers.

File

mediaelement.module
View source 
<?php

/**
 * @file
 * Provides HTML5 video and audio elements using Mediaelement.js for HTML4 browsers.
 */

/**
 * Render audio and video with MediaElement.
 *
 * @param mixed $file
 *   Either a string with a path to a file or an array of paths to files.
 * @param array $options
 *   - id: Optionally set the unique ID. Otherwise the MediaElement module
 *     creates a unique one using a static count variable.
 *   - width: Width of the player in pixels or percentage.
 *   - height: Height of the player in pixels or percentage.
 *   - controls: Disable or enable the controls.
 *   - opts: MediaElement.js API options.
 *   - attributes: Override defaults for theme_mediaelement_audio().
 *   - settings: Override defaults for theme_mediaelement_audio().
 *   - type: video or audio. Otherwise MediaElement module determines it by the
 *     file extension of $file.
 *
 * @return string
 *   The html to inject into the page is returned. Apart from this, the
 *   javaScript needed to support the html is added using Drupal APIs.
 */
function mediaelement_render($file, array $options = array()) {
}

/**
 * Implements hook_menu().
 */
function mediaelement_menu() {
  return array(
    'admin/config/media/mediaelement' => array(
      'title' => 'MediaElement.js',
      'description' => 'Settings for MediaElement.js integration with Drupal',
      'page callback' => 'drupal_get_form',
      'page arguments' => array(
        'mediaelement_admin_form',
      ),
      'access arguments' => array(
        'administer site configuration',
      ),
      'file' => 'mediaelement.admin.inc',
    ),
  );
}

/**
 * Implements hook_library().
 */
function mediaelement_library() {
  $path = libraries_get_path('mediaelement');
  $libraries = array();
  $libraries['mediaelement'] = array(
    'title' => 'Media Element',
    'website' => 'http://mediaelementjs.com/',
    'version' => '2.1.6',
    'js' => array(
      // The mediaelement script detects the path to itself to call other files
      // in the same location. With preprocessing this is problematic as the
      // script is no longer in the same directory as its other assets. There
      // is an option that can be passed into the script with its location.
      // @todo Update all calls to mediaelement to pass in the assets location.
      $path . '/build/mediaelement-and-player.min.js' => array(
        'group' => JS_LIBRARY,
        'preprocess' => FALSE,
      ),
    ),
    'css' => array(
      $path . '/build/mediaelementplayer.min.css' => array(
        'group' => CSS_SYSTEM,
      ),
    ),
  );
  return $libraries;
}

/**
 * Implements hook_init().
 */
function mediaelement_init() {

  // When the media player is set to be on all pages add it to the page.
  if (variable_get('mediaelement_sitewide', FALSE)) {
    drupal_add_library('mediaelement', 'mediaelement');
    drupal_add_js(drupal_get_path('module', 'mediaelement') . '/mediaelement.js');
    drupal_add_js(array(
      'mediaelementAll' => TRUE,
    ), array(
      'type' => 'setting',
    ));
  }
}

/**
 * Implements hook_field_formatter_info().
 */
function mediaelement_field_formatter_info() {
  $formatters = array();
  $formatters['mediaelement_video'] = array(
    'label' => t('MediaElement Video'),
    'field types' => array(
      'file',
      'link_field',
    ),
    'settings' => array(
      'controls' => variable_get('mediaelement_video_default_controls', TRUE),
      'width' => variable_get('mediaelement_video_default_width', '640'),
      'height' => variable_get('mediaelement_video_default_height', '385'),
      'download_link' => variable_get('mediaelement_video_default_download_link', FALSE),
      'download_text' => variable_get('mediaelement_video_default_download_text', t('Download')),
    ),
  );
  $formatters['mediaelement_audio'] = array(
    'label' => t('MediaElement Audio'),
    'field types' => array(
      'file',
      'link_field',
    ),
    'settings' => array(
      'controls' => variable_get('mediaelement_audio_default_controls', TRUE),
      'width' => variable_get('mediaelement_audio_default_width', '300'),
      'height' => variable_get('mediaelement_audio_default_height', '30'),
      'download_link' => variable_get('mediaelement_audio_default_download_link', FALSE),
      'download_text' => variable_get('mediaelement_audio_default_download_text', t('Download')),
    ),
  );
  return $formatters;
}

/**
 * Implements hook_field_formatter_view().
 */
function mediaelement_field_formatter_view($entity_type, $entity, $field, $instance, $langcode, $items, $display) {

  // A unique caller per page for the JS specific settings to use. This may be
  // different for ever page view and should not be used for styling.
  static $id = 0;
  $element = array();
  $path = drupal_get_path('module', 'mediaelement');
  foreach ($items as $delta => $item) {

    // file and link_field keep the path/link in a different property name.
    $settings = $display['settings'];
    $js_settings = array();
    $js_settings['opts'] = array();
    $js_settings['controls'] = (bool) $settings['controls'];
    if ($display['type'] == 'mediaelement_video') {
      $js_settings['opts']['videoHeight'] = (int) $settings['height'];
      $js_settings['opts']['videoWidth'] = (int) $settings['width'];
    }
    elseif ($display['type'] == 'mediaelement_audio') {
      $js_settings['opts']['audioHeight'] = (int) $settings['height'];
      $js_settings['opts']['audioWidth'] = (int) $settings['width'];
    }
    $class = 'mediaelement-formatter-identifier-' . time() . '-' . $id++;
    $element[$delta] = array(
      '#attributes' => array(
        'src' => file_create_url($item['uri']),
        'class' => $class,
      ),
      '#settings' => $settings,
      '#attached' => array(
        'library' => array(
          array(
            'mediaelement',
            'mediaelement',
          ),
        ),
        'js' => array(
          $path . '/mediaelement.js' => array(),
          0 => array(
            'type' => 'setting',
            'data' => array(
              'mediaelement' => array(
                '.' . $class => $js_settings,
              ),
            ),
          ),
        ),
      ),
    );
    if ($settings['controls']) {
      $element[$delta]['#attributes']['controls'] = 'controls';
    }
    if ($display['type'] == 'mediaelement_video') {
      $element[$delta]['#theme'] = 'mediaelement_video';
      $element[$delta]['#attributes']['height'] = $display['settings']['height'];
      $element[$delta]['#attributes']['width'] = $display['settings']['width'];
    }
    elseif ($display['type'] == 'mediaelement_audio') {
      $element[$delta]['#theme'] = 'mediaelement_audio';
    }
  }
  return $element;
}

/**
 * Implements hook_theme().
 */
function mediaelement_theme() {
  return array(
    'mediaelement_video' => array(
      'variables' => array(
        'attributes' => array(),
        'settings' => array(),
      ),
    ),
    'mediaelement_audio' => array(
      'variables' => array(
        'attributes' => array(),
        'settings' => array(),
      ),
    ),
  );
}
function theme_mediaelement_video($variables) {
  $output = '<div class="mediaelement-video">';
  $output .= '<video ' . drupal_attributes($variables['attributes']) . ' ></video>';
  if ($variables['settings']['download_link']) {
    $output .= '<div class="mediaelement-download-link"><a href="' . $variables['attributes']['src'] . '">' . filter_xss_admin($variables['settings']['download_text']) . '</a></div>';
  }
  $output .= '</div>';
  return $output;
}
function theme_mediaelement_audio($variables) {
  $output = '<div class="mediaelement-audio">';
  $output .= '<audio ' . drupal_attributes($variables['attributes']) . ' ></audio>';
  if ($variables['settings']['download_link']) {
    $output .= '<div class="mediaelement-download-link"><a href="' . $variables['attributes']['src'] . '">' . filter_xss_admin($variables['settings']['download_text']) . '</a></div>';
  }
  $output .= '</div>';
  return $output;
}

/**
 * Implements hook_field_formatter_settings_form().
 */
function mediaelement_field_formatter_settings_form($field, $instance, $view_mode, $form, &$form_state) {
  $display = $instance['display'][$view_mode];
  $settings = $display['settings'];
  $element = array();
  $element['controls'] = array(
    '#title' => t('Controls'),
    '#type' => 'checkbox',
    '#default_value' => $settings['controls'],
  );
  $element['width'] = array(
    '#title' => t('Width'),
    '#type' => 'textfield',
    '#default_value' => $settings['width'],
  );
  $element['height'] = array(
    '#title' => t('Height'),
    '#type' => 'textfield',
    '#default_value' => $settings['height'],
  );
  $element['download_link'] = array(
    '#title' => t('Download Link'),
    '#type' => 'checkbox',
    '#default_value' => $settings['download_link'],
  );
  $element['download_text'] = array(
    '#title' => t('Download Link Text'),
    '#type' => 'textfield',
    '#default_value' => $settings['download_text'],
  );
  return $element;
}

/**
 * Implements hook_field_formatter_settings_summary().
 */
function mediaelement_field_formatter_settings_summary($field, $instance, $view_mode) {
  $display = $instance['display'][$view_mode];
  $settings = $display['settings'];
  return t('Width: @width px, Height: @height px', array(
    '@width' => $settings['width'],
    '@height' => $settings['height'],
  ));
}

Functions

Namesort descending Description
mediaelement_field_formatter_info Implements hook_field_formatter_info().
mediaelement_field_formatter_settings_form Implements hook_field_formatter_settings_form().
mediaelement_field_formatter_settings_summary Implements hook_field_formatter_settings_summary().
mediaelement_field_formatter_view Implements hook_field_formatter_view().
mediaelement_init Implements hook_init().
mediaelement_library Implements hook_library().
mediaelement_menu Implements hook_menu().
mediaelement_render Render audio and video with MediaElement.
mediaelement_theme Implements hook_theme().
theme_mediaelement_audio
theme_mediaelement_video