API Documentation Job

Comparing version 10 and version 9 back

URL: http://heywatch.com/job

h2. Actions


    * [GET] http://heywatch.com/job/ : get the list of all your jobs
    * [GET] http://heywatch.com/job/ID : retrieve information about the job ID
    * [POST] http://heywatch.com/job : create a job
    * [DELETE] http://heywatch.com/job/ID : cancel the job ID (must be in pending status)

Example response in XML: http://heywatch.com/job.xml [GET]


  
    working
    Fri Oct 27 14:28:46 CEST 2006
    524
    179
    12
    42
    Fri Oct 27 14:28:46 CEST 2006
  




h2. Valid parameters for POST


    * **format_id :** Format ID to use, if you set your default format and want to use it, use default_format=true
    * **video_id :** raw video ID to convert

h3. Optional parameters

    * **ftp_directive :** upload the new encoded video to the FTP. Override the global option FTP. Must be: ftp://login:password@host:port/path
    * **s3_directive :**  upload the new encoded video to your S3 account. Must be: s3://access_key:secret_key@bucket/object_key. Note that object_key is optional. This parameter will override the global option.
    * **http_upload_directive :** Upload the new encoded video to the specified HTTP address (multipart form POST). The parameter name containing the file object is "encoded_video". You also receive the encoded_video_id, video_id, job_id and custom fields if any. Override the global option.
    * **ping_url_after_encode :** Ping the specified URL after the encode. Override the global option
    * **ping_url_if_error :** Ping the specified URL if the job failed. Override the global option

Note that custom fields don't work here. To have them, you need to customize the ping urls like http://myhost.com/heywatch/ping/success?myid=1546

h3. Encoding options

    * **keep_video_size :** if "true", will not resize the video (ignore width and height values of the selected format)
    * **keep_fps :** if "true", will keep the original FPS (ignore FPS value of the selected format)
    * **keep_quality :** if "true", keep the video/audio bitrates, size, FPS, sample rate and channels
    * **deinterlace :** if "true", will deinterlace the video
    * **watermark_image_url :** this is the URL of the image, must be png. The image will be incrusted in the video at the position you want like a logo you can see on TV. Note that transparent and semi-transparent images are compatible.
    * **watermark_position :** can be "topleft" or "bottomright", default is "topleft"