interface video_transcoder in Video 6.5

Hierarchy

• interface \video_plugin
  • interface \video_transcoder

File

./video.lib.inc, line 40

File containing Video module interfaces and classes

interface video_transcoder extends video_plugin {
  public function preset_settings(&$form_state, video_preset $preset);
  public function preset_settings_validate($form, &$form_state);
  public function create_job(stdClass $video);
  public function update_job(stdClass $video);
  public function delete_job(stdClass $video);
  public function load_job($fid);

  /**
   * Return at most $num files that need to be transcoded.
   *
   * @param int $num
   */
  public function load_job_queue($num);
  public function load_completed_job(stdClass $video);

  /**
   * Change the rendering status of the file.
   *
   * @param $video
   *   Video instance
   * @param $status
   *   One of the VIDEO_RENDERING_* constants
   */
  public function change_status(stdClass $video, $status);
  public function generate_thumbnails(stdClass $video);

  /**
   * Convert the given video.
   *
   * Make sure to update the provided video object with any information that
   * is required by the file system module after conversion.
   *
   * @return bool
   *   TRUE if the conversion was successful, FALSE otherwise
   */
  public function convert_video(stdClass $video);
  public function requirements();

  /**
   * Return the width and height of the given file.
   *
   * @param $filepath
   *   string containing the path to the video file.
   *
   * @return
   *   array containing keys width and height or NULL when
   *   the width and height can't be determined.
   */
  public function get_dimensions($filepath);

  /**
   * Helper method for video_file_download()
   *
   * Returns the path to the original video file based on the path of the
   * converted video file.
   *
   * @param $filepath
   *   The path to the converted file, this path must have been processed by
   *   file_create_path().
   * @return
   *   Path to the original video, NULL if not found.
   */
  public function get_original_path_by_converted_path($filepath);

}

Members

Name	Modifiers	Type	Description	Overrides
video_plugin::admin_settings	public	function		4
video_plugin::admin_settings_validate	public	function		4
video_plugin::get_help	public	function		4
video_plugin::get_name	public	function		4
video_plugin::get_value	public	function		4
video_transcoder::change_status	public	function	Change the rendering status of the file.	2
video_transcoder::convert_video	public	function	Convert the given video.	2
video_transcoder::create_job	public	function		2
video_transcoder::delete_job	public	function		2
video_transcoder::generate_thumbnails	public	function		2
video_transcoder::get_dimensions	public	function	Return the width and height of the given file.	2
video_transcoder::get_original_path_by_converted_path	public	function	Helper method for video_file_download()	2
video_transcoder::load_completed_job	public	function		2
video_transcoder::load_job	public	function		2
video_transcoder::load_job_queue	public	function	Return at most $num files that need to be transcoded.	2
video_transcoder::preset_settings	public	function		2
video_transcoder::preset_settings_validate	public	function		2
video_transcoder::requirements	public	function		2
video_transcoder::update_job	public	function		2