interface TranscoderFactoryInterface in Video 7.2

Interface for transcoder classes

Hierarchy

• interface \TranscoderFactoryInterface

File

includes/TranscoderFactory.inc, line 10

Transcoder Abstract Factory classes

interface TranscoderFactoryInterface {

  /**
   * Extract frames from the current video.
   *
   * The thumbnails are be saved to the given scheme. The files are not
   * be saved to the database, this will be done by the caller.
   * The uid, filesize and timestamp properties are not set by this method.
   *
   * @param $destinationScheme
   *   A valid stream wrapper scheme
   * @param $format
   *   png or jpg
   *
   * @return
   *   array of file objects, FALSE on error
   */
  public function extractFrames($destinationScheme, $format);
  public function execute();
  public function getName();
  public function getValue();
  public function isAvailable(&$errormsg);
  public function getDimensions();
  public function setInput(array $file);

  /**
   * Reset internal variables to their initial state.
   */
  public function reset($keepinput = FALSE);

  /**
   * Process postback jobs
   */
  public function processPostback();

  /**
   * Get enabled and supporting codecs by the transcoder.
   */
  public function getCodecs();

  /**
   * Get available output file formats from the transcoder.
   */
  public function getAvailableFormats($type = FALSE);

  /**
   * Returns a list of all supported pixel formats.
   *
   * Returns NULL when pixel formats are not configurable for this transcoder.
   */
  public function getPixelFormats();

  /**
   * Admin settings form for the transcoder
   */
  public function adminSettings();

  /**
   * Validate admin settings. This will call when Drupal admin settings validate.
   */
  public function adminSettingsValidate($form, &$form_state);

  /**
   * Whether the transcoder works by sending jobs to an external system.
   *
   * True for transcoders like Zencoder, false for transcoders like FFmpeg.
   */
  public function isOffSite();

}

Members

Name	Modifiers	Type	Description	Overrides
TranscoderFactoryInterface::adminSettings	public	function	Admin settings form for the transcoder	2
TranscoderFactoryInterface::adminSettingsValidate	public	function	Validate admin settings. This will call when Drupal admin settings validate.	2
TranscoderFactoryInterface::execute	public	function		2
TranscoderFactoryInterface::extractFrames	public	function	Extract frames from the current video.	2
TranscoderFactoryInterface::getAvailableFormats	public	function	Get available output file formats from the transcoder.	2
TranscoderFactoryInterface::getCodecs	public	function	Get enabled and supporting codecs by the transcoder.	2
TranscoderFactoryInterface::getDimensions	public	function
TranscoderFactoryInterface::getName	public	function		2
TranscoderFactoryInterface::getPixelFormats	public	function	Returns a list of all supported pixel formats.	2
TranscoderFactoryInterface::getValue	public	function		2
TranscoderFactoryInterface::isAvailable	public	function
TranscoderFactoryInterface::isOffSite	public	function	Whether the transcoder works by sending jobs to an external system.	2
TranscoderFactoryInterface::processPostback	public	function	Process postback jobs
TranscoderFactoryInterface::reset	public	function	Reset internal variables to their initial state.
TranscoderFactoryInterface::setInput	public	function