www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/video/src/ProviderPluginInterface.php

   1 <?php
   2
   3 /**
   4  * @file
   5  * Contains Drupal\video\ProviderInterface.
   6  */
   7
   8 namespace Drupal\video;
   9
  10 /**
  11  * Providers an interface for embed providers.
  12  */
  13 interface ProviderPluginInterface {
  14
  15   /**
  16    * Render embed code.
  17    *
  18    * @param string $settings
  19    *   The settings of the video player.
  20    *
  21    * @return mixed
  22    *   A renderable array of the embed code.
  23    */
  24   public function renderEmbedCode($settings);
  25
  26   /**
  27    * Get the URL of the remote thumbnail.
  28    *
  29    * This is used to download the remote thumbnail and place it on the local
  30    * file system so that it can be rendered with image styles. This is only
  31    * called if no existing file is found for the thumbnail and should not be
  32    * called unnecessarily, as it might query APIs for video thumbnail
  33    * information.
  34    *
  35    * @return string
  36    *   The URL to the remote thumbnail file.
  37    */
  38   public function getRemoteThumbnailUrl();
  39
  40 }