Api

Version

mediamosa-30

Class

mediamosa_rest_call_job_create_still

Code

File: /sites/all/modules/mediamosa/modules/job/mediamosa_job.rest.class.inc
<?php

/**
 * URI: /asset/$asset_id/still/create
 * Method: POST
 *
 * Create a still job.
 */
class mediamosa_rest_call_job_create_still extends mediamosa_rest_call_job_create {
  // ------------------------------------------------------------------- Consts.
  // The asset ID.
  const ASSET_ID = 'asset_id';

  // Only used here, converted to size.
  const WIDTH = 'width';
  const HEIGHT = 'height';

  // ------------------------------------------------------------ Get Var Setup.
  public function get_var_setup() {
    $var_setup = parent::get_var_setup();

    unset($var_setup[self::VARS][parent::JOB_TYPE]);

    // Although its required, its not used(!).
    // note: mediamosa_rest_call_job_create_still_for_mediafile() depends on
    // this non-requirement and non-usage.
    $var_setup[self::VARS][self::ASSET_ID] = array(
      self::VAR_TYPE => mediamosa_sdk::TYPE_ASSET_ID,
      self::VAR_DESCRIPTION => 'The asset ID of the medafile.',
      self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_YES,
    );

    $var_setup[self::VARS][self::WIDTH] = array(
      self::VAR_TYPE => mediamosa_sdk::TYPE_INT,
      self::VAR_DESCRIPTION => 'Still width. Deprecated, use size instead.',
    );
    $var_setup[self::VARS][self::HEIGHT] = array(
      self::VAR_TYPE => mediamosa_sdk::TYPE_INT,
      self::VAR_DESCRIPTION => 'Still height. Deprecated, use size instead.',
    );

    return $var_setup;
  }

  // ------------------------------------------------------- Progress Rest Args.
  /**
   * Process the supplied parameters.
   *
   * @param array $var_setup
   */
  protected function process_rest_args(array $var_setup) {

    // Set job type and give it fixed value.
    $var_setup[self::VARS][self::JOB_TYPE] = array(
      self::VAR_TYPE => mediamosa_sdk::TYPE_JOB,
      self::VAR_DESCRIPTION => 'The job type.',
      self::VAR_IS_REQUIRED => self::VAR_IS_REQUIRED_YES,
      self::VAR_OVERRIDE_VALUE => mediamosa_job_db::JOB_TYPE_STILL,
    );

    // GET / POST to array.
    $var_setup = parent::process_rest_args($var_setup);

    // Fix problems with usage of obsolete FRAMETIME, WIDTH and HEIGHT.
    $frametime = $this->get_param_value(self::FRAMETIME);
    $start_frame = $this->get_param_value(self::START_FRAME);
    $end_frame = $this->get_param_value(self::END_FRAME);
    if (!$start_frame && $frametime) {
      $this->set_param_value(self::START_FRAME, $frametime);
    }

    $width = $this->get_param_value(self::WIDTH);
    $height = $this->get_param_value(self::HEIGHT);

    if (!$start_frame && $frametime) {
      $this->set_param_value(self::START_FRAME, $frametime);
    }

    // Start/end time replaces start/end frame.
    $start_time = $this->get_param_value(self::START_TIME);
    if (!$start_frame && $start_time) {
      $this->set_param_value(self::START_FRAME, $start_time);
    }

    $end_time = $this->get_param_value(self::END_TIME);
    if (!$end_frame && $end_time) {
      $this->set_param_value(self::END_FRAME, $end_time);
    }

    // If size is not given, but width and height are, use width, height.
    if (!$this->isset_given_param(self::SIZE) && $width && $height) {
      $this->set_param_value(self::SIZE, $width . 'x' . $height);
    }
    // If there isn't size, we get the still default size of application.
    if (!$this->isset_given_param(self::SIZE)) {
      $a_app_ids = $this->get_param_value_app();
      $app_id = reset($a_app_ids);
      $this->set_param_value(self::SIZE, mediamosa_app::get_still_default_value($app_id));
    }

    unset($var_setup[self::VARS][self::FRAMETIME]);
    unset($var_setup[self::VARS][self::WIDTH]);
    unset($var_setup[self::VARS][self::HEIGHT]);

    return $var_setup;
  }

  // ------------------------------------------------------------------ Do Call.
  public function do_call() {
    parent::do_call();
  }
}