You are here

tudou.inc in Embedded Media Field 6

Same filename and directory in other branches
  1. 6.3 contrib/emvideo/providers/tudou.inc

Provide support for the Tudou provider to the emfield.module.

File

contrib/emvideo/providers/tudou.inc
View source
<?php

/**
 * @file
 *   Provide support for the Tudou provider to the emfield.module.
 */
define('EMVIDEO_TUDOU_MAIN_URL', 'http://www.tudou.com/');

/**
 * hook emvideo_PROVIDER_info
 * this returns information relevant to a specific 3rd party video provider
 * @return
 *   an array of strings requested by various admin and other forms
 *   'name' => the translated name of the provider
 *   'url' => the url to the main page for the provider
 *   'settings_description' => a description of the provider that will be posted in the admin settings form
 *   'supported_features' => an array of rows describing the state of certain supported features by the provider.
 *      These will be rendered in a table, with the columns being 'Feature', 'Supported', 'Notes'.
 */
function emvideo_tudou_info() {
  $features = array(
    array(
      t('Autoplay'),
      t('No'),
      '',
    ),
    array(
      t('RSS Attachment'),
      t('No'),
      '',
    ),
    array(
      t('Thumbnails'),
      t('No'),
      t(''),
    ),
  );
  return array(
    'provider' => 'tudou',
    'name' => t('Tudou'),
    'url' => EMVIDEO_TUDOU_MAIN_URL,
    'settings_description' => t('These settings specifically affect videos displayed from <a href="@tudou" target="_blank">Tudou</a>.', array(
      '@tudou' => EMVIDEO_TUDOU_MAIN_URL,
    )),
    'supported_features' => $features,
  );
}

/**
 * hook emvideo_PROVIDER_settings
 * this should return a subform to be added to the emvideo_settings() admin settings page.
 * note that a form field will already be provided, at $form['PROVIDER'] (such as $form['tudou'])
 * so if you want specific provider settings within that field, you can add the elements to that form field.
 */
function emvideo_tudou_settings() {
  $form = array();
  return $form;
}

/**
 * hook emvideo_PROVIDER_extract
 * this is called to extract the video code from a pasted URL or embed code.
 * @param $embed
 *   an optional string with the pasted URL or embed code
 * @return
 *   either an array of regex expressions to be tested, or a string with the video code to be used
 *   if the hook tests the code itself, it should return either the string of the video code (if matched), or an empty array.
 *   otherwise, the calling function will handle testing the embed code against each regex string in the returned array.
 */
function emvideo_tudou_extract($embed = '') {

  // http://www.tudou.com/programs/view/uprLNXyEGpc/
  // <object width="400" height="300"><param name="movie" value="http://www.tudou.com/v/uprLNXyEGpc"></param><param name="allowScriptAccess" value="always"></param><param name="wmode" value="transparent"></param><embed src="http://www.tudou.com/v/uprLNXyEGpc" type="application/x-shockwave-flash" width="400" height="300" allowFullScreen="true" wmode="transparent" allowScriptAccess="always"></embed></object>
  return array(
    '@tudou\\.com/programs/view/([^"\\&/]+)@i',
    '@tudou\\.com/v/([^"\\&/]+)@i',
  );
}

/**
 * hook emvideo_PROVIDER_embedded_link($video_code)
 * returns a link to view the video at the provider's site
 *  @param $video_code
 *    the string containing the video to watch
 *  @return
 *    a string containing the URL to view the video at the original provider's site
 */
function emvideo_tudou_embedded_link($video_code) {
  return 'http://www.tudou.com/programs/view/' . $video_code;
}

/**
 * the embedded flash displaying the tudou video
 */
function theme_emvideo_tudou_flash($embed, $width, $height, $autoplay) {
  if ($embed) {
    $output .= "\n      <object width=\"{$width}\" height=\"{$height}\">\n        <param name=\"movie\" value=\"http://www.tudou.com/v/{$embed}\"></param>\n        <param name=\"allowScriptAccess\" value=\"always\"></param>\n        <param name=\"wmode\" value=\"transparent\"></param>\n        <embed src=\"http://www.tudou.com/v/{$embed}\" type=\"application/x-shockwave-flash\" width=\"{$width}\" height=\"{$height}\" allowFullScreen=\"true\" wmode=\"transparent\" allowScriptAccess=\"always\"></embed>\n        </object>\n    ";
  }
  return $output;
}

/**
 * hook emvideo_PROVIDER_thumbnail
 * returns the external url for a thumbnail of a specific video
 * TODO: make the args: ($embed, $field, $item), with $field/$item provided if we need it, but otherwise simplifying things
 *  @param $field
 *    the field of the requesting node
 *  @param $item
 *    the actual content of the field from the requesting node
 *  @return
 *    a URL pointing to the thumbnail
 */
function emvideo_tudou_thumbnail($field, $item, $formatter, $node, $width, $height) {
}

/**
 * hook emvideo_PROVIDER_video
 * this actually displays the full/normal-sized video we want, usually on the default page view
 *  @param $embed
 *    the video code for the video to embed
 *  @param $width
 *    the width to display the video
 *  @param $height
 *    the height to display the video
 *  @param $field
 *    the field info from the requesting node
 *  @param $item
 *    the actual content from the field
 *  @return
 *    the html of the embedded video
 */
function emvideo_tudou_video($embed, $width, $height, $field, $item, $node, $autoplay) {
  $output = theme('emvideo_tudou_flash', $embed, $width, $height, $autoplay);
  return $output;
}

/**
 * hook emvideo_PROVIDER_video
 * this actually displays the preview-sized video we want, commonly for the teaser
 *  @param $embed
 *    the video code for the video to embed
 *  @param $width
 *    the width to display the video
 *  @param $height
 *    the height to display the video
 *  @param $field
 *    the field info from the requesting node
 *  @param $item
 *    the actual content from the field
 *  @return
 *    the html of the embedded video
 */
function emvideo_tudou_preview($embed, $width, $height, $field, $item, $node, $autoplay) {
  $output = theme('emvideo_tudou_flash', $embed, $width, $height, $autoplay);
  return $output;
}
function emvideo_tudou_emfield_subtheme() {
  return array(
    'emvideo_tudou_flash' => array(
      'arguments' => array(
        'embed' => NULL,
        'width' => NULL,
        'height' => NULL,
        'autoplay' => NULL,
      ),
      'file' => 'providers/tudou.inc',
    ),
  );
}

Functions

Namesort descending Description
emvideo_tudou_embedded_link hook emvideo_PROVIDER_embedded_link($video_code) returns a link to view the video at the provider's site
emvideo_tudou_emfield_subtheme
emvideo_tudou_extract hook emvideo_PROVIDER_extract this is called to extract the video code from a pasted URL or embed code.
emvideo_tudou_info hook emvideo_PROVIDER_info this returns information relevant to a specific 3rd party video provider
emvideo_tudou_preview hook emvideo_PROVIDER_video this actually displays the preview-sized video we want, commonly for the teaser
emvideo_tudou_settings hook emvideo_PROVIDER_settings this should return a subform to be added to the emvideo_settings() admin settings page. note that a form field will already be provided, at $form['PROVIDER'] (such as $form['tudou']) so if you want…
emvideo_tudou_thumbnail hook emvideo_PROVIDER_thumbnail returns the external url for a thumbnail of a specific video TODO: make the args: ($embed, $field, $item), with $field/$item provided if we need it, but otherwise simplifying things
emvideo_tudou_video hook emvideo_PROVIDER_video this actually displays the full/normal-sized video we want, usually on the default page view
theme_emvideo_tudou_flash the embedded flash displaying the tudou video

Constants

Namesort descending Description
EMVIDEO_TUDOU_MAIN_URL @file Provide support for the Tudou provider to the emfield.module.