voicethread.inc in Embedded Media Field 6.3

File

contrib/emvideo/providers/voicethread.inc

<?php

define('EMVIDEO_VOICETHREAD_MAIN_URL', 'http://www.voicethread.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_voicethread_info() {
  $name = t('VoiceThread');
  $features = array(
    array(
      t('Autoplay'),
      t('Yes'),
      '',
    ),
    array(
      t('RSS Attachment'),
      t('No'),
      '',
    ),
    array(
      t('Thumbnails'),
      t('No'),
      t(''),
    ),
    array(
      t('Custom player colors'),
      t('No'),
      t(''),
    ),
  );
  return array(
    'provider' => 'voicethread',
    'name' => $name,
    'url' => EMVIDEO_VOICETHREAD_MAIN_URL,
    // 'settings_description' => '[settings description]',
    'settings_description' => t('These settings specifically affect videos displayed from !voicethread.', array(
      '!voicethread' => l($name, EMVIDEO_VOICETHREAD_MAIN_URL, array(
        'target' => '_blank',
      )),
    )),
    '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['youtube'])
 * so if you want specific provider settings within that field, you can add the elements to that form field.
 */
function emvideo_voicethread_settings() {
  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_voicethread_extract($embed = '') {
  return array(
    '@voicethread\\.com/book.swf\\?b=(\\d+)@i',
    '@voicethread\\.com/share/(\\d+)@i',
  );
}

/**
 * hook emvideo_PROVIDER_embedded_link($book_id)
 * returns a link to view the video at the provider's site
 *  @param $book_id
 *    the id of the VoiceThread
 *  @return
 *    a string containing the URL to view the video at the original provider's site
 */
function emvideo_voicethread_embedded_link($book_id) {
  return 'http://www.voicethread.com/share/' . $book_id;
}

/**
 * the embedded flash displaying the voicethread
 */
function theme_emvideo_voicethread_flash($embed, $width, $height, $autoplay) {
  if ($embed) {
    if ($autoplay) {
      $autoplay_value = '&autoplay=1';
    }
    $output = "    <object type=\"application/x-shockwave-flash\" height=\"{$height}\" width=\"{$width}\" data=\"http://www.voicethread.com/book.swf?b={$embed}" . $autoplay_value . "\" id=\"VideoPlayback\" >\n      <param name=\"movie\" value=\"http://www.voicethread.com/book.swf?b={$embed}" . $autoplay_value . "\" wmode=\"transparent\" />\n    </object>\n";
  }
  return $output;
}

/**
 * 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_voicethread_video($embed, $width, $height, $field, $item, $autoplay) {
  $output = theme('emvideo_voicethread_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_voicethread_preview($embed, $width, $height, $field, $item, $autoplay) {
  $output = theme('emvideo_voicethread_flash', $embed, $width, $height, $autoplay);
  return $output;
}
function emvideo_voicethread_emfield_subtheme() {
  return array(
    'emvideo_voicethread_flash' => array(
      'arguments' => array(
        'embed' => NULL,
        'width' => NULL,
        'height' => NULL,
        'autoplay' => NULL,
      ),
      'file' => 'providers/voicethread.inc',
    ),
  );
}

Functions

Name	Description
emvideo_voicethread_embedded_link	hook emvideo_PROVIDER_embedded_link($book_id) returns a link to view the video at the provider's site
emvideo_voicethread_emfield_subtheme
emvideo_voicethread_extract	hook emvideo_PROVIDER_extract this is called to extract the video code from a pasted URL or embed code.
emvideo_voicethread_info	hook emvideo_PROVIDER_info this returns information relevant to a specific 3rd party video provider
emvideo_voicethread_preview	hook emvideo_PROVIDER_video this actually displays the preview-sized video we want, commonly for the teaser
emvideo_voicethread_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['youtube']) so if you want…
emvideo_voicethread_video	hook emvideo_PROVIDER_video this actually displays the full/normal-sized video we want, usually on the default page view
theme_emvideo_voicethread_flash	the embedded flash displaying the voicethread

Constants

Name	Description
EMVIDEO_VOICETHREAD_MAIN_URL