You are here

interface ProviderPluginInterface in Video 8

Same name and namespace in other branches
  1. 8.2 src/ProviderPluginInterface.php \Drupal\video\ProviderPluginInterface

Providers an interface for embed providers.

Hierarchy

Expanded class hierarchy of ProviderPluginInterface

All classes that implement ProviderPluginInterface

File

src/ProviderPluginInterface.php, line 8

Namespace

Drupal\video
View source
interface ProviderPluginInterface {

  /**
   * Render embed code.
   *
   * @param string $settings
   *   The settings of the video player.
   *
   * @return mixed
   *   A renderable array of the embed code.
   */
  public function renderEmbedCode($settings);

  /**
   * Get the URL of the remote thumbnail.
   *
   * This is used to download the remote thumbnail and place it on the local
   * file system so that it can be rendered with image styles. This is only
   * called if no existing file is found for the thumbnail and should not be
   * called unnecessarily, as it might query APIs for video thumbnail
   * information.
   *
   * @return string
   *   The URL to the remote thumbnail file.
   */
  public function getRemoteThumbnailUrl();

}

Members

Namesort descending Modifiers Type Description Overrides
ProviderPluginInterface::getRemoteThumbnailUrl public function Get the URL of the remote thumbnail. 6
ProviderPluginInterface::renderEmbedCode public function Render embed code. 6