Job Resource

Get all the jobs

GET /job.(xml|json)

With the cURL command:

curl -u username:passwd https://heywatch.com/job.json

[
  {
    "ping_url_after_encode": "http://site.com/heywatch/encode?post_id=1234454321",
    "created_at": "2011-06-08T15:41:58+02:00",
    "error_msg": null,
    "cf_directive": null,
    "video_id": 9554134,
    "updated_at": "2011-06-08T15:41:16+02:00",
    "progress": 100,
    "id": 4888504,
    "format_id": 3458,
    "s3_directive": null,
    "ping_url_if_error": "http://site.com/heywatch/error?post_id=1234454321",
    "error_code": null,
    "encoding_options": {
      "keep_video_size": true
    },
    "encoded_video_id": 9554145,
    "ftp_directive": null,
    "status": "finished",
    "http_upload_directive": null
  },
  {
    "ping_url_after_encode": "http://site.com/heywatch/encode?post_id=1234454322",
    "created_at": "2011-06-08T15:41:03+02:00",
    "error_msg": null,
    "cf_directive": null,
    "video_id": 9554141,
    "updated_at": "2011-06-08T15:42:26+02:00",
    "progress": 100,
    "id": 4888509,
    "format_id": 2365,
    "s3_directive": null,
    "ping_url_if_error": "http://site.com/heywatch/error?post_id=1234454322",
    "error_code": null,
    "encoding_options": {
      "watermark_position": "topleft",
      "keep_fps": false,
      "watermark_image_url": "http://site.com/images/watermark.png"
    },
    "encoded_video_id": 9554151,
    "ftp_directive": null,
    "status": "finished",
    "http_upload_directive": "http://site.com/heywatch/upload?post_id=1234454322"
  }
]

Get information about a specific Job

GET /job/ID.(xml|json)

With the cURL command:

curl -u username:passwd https://heywatch.com/job/4888551.json

{
  "ping_url_after_encode": "http://site.com/heywatch/encode?post_id=1234454323",
  "created_at": "2011-06-08T15:50:23+02:00",
  "error_msg": null,
  "cf_directive": null,
  "video_id": 9554225,
  "updated_at": "2011-06-08T15:49:18+02:00",
  "progress": 10,
  "id": 4888551,
  "format_id": 3458,
  "s3_directive": "s3://accesskey:secretkey@videos.site.com/web/1234454323.mp4",
  "ping_url_if_error": "http://site.com/heywatch/error?post_id=1234454323",
  "error_code": null,
  "encoding_options": {
    "keep_video_size": true
  },
  "encoded_video_id": 0,
  "ftp_directive": null,
  "status": "working",
  "http_upload_directive": null
}

Create a job

POST /job.(xml|json)

Parameters

• 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

Optional Ping URLs and external storages 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. You can add special headers like this: s3://access_key:secret_key@bucket/object_key?x-amz-storage-class=REDUCED_REDUNDANCY&x-amz-meta-testheader=ok | s3://access_key:secret_key@bucket?x-amz-storage-class=REDUCED_REDUNDANCY
• cf_directive : upload the new encoded video to your RackSpace Cloud Files account. Must be: cf://username:api_key@container/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

Optional Encoding options parameters

• keep_video_size : if “true”, will not resize the video (ignore width and height values of the selected format)
• keep_aspect_ratio : if “false”, will not respect the original video aspect (no black bar added). Default is true
• 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
• keep_video_bitrate : if “true”, will keep the original video bitrate
• max_video_bitrate : can be “format_video_bitrate” (=your format video bitrate) or any number > 0. Must be used with “keep_video_bitrate”. The encoder will not use a video bitrate > max_video_bitrate. This is useful if you don’t want to set too high video bitrate while using the keep_video_bitrate option.
• keep_sample_rate : if “true”, keep the original sample rate
• keep_channels : if “true”, keep the original audio channels.
• keep_audio_bitrate : if “true”, will keep the original audio bitrate
• deinterlace : if “true”, will deinterlace the video
• transpose : will rotate the video. Value can be 0 (90CounterCLockwise and Vertical Flip (default)), 1 (90Clockwise), 2 (90CounterClockwise), 3 (90Clockwise and Vertical Flip). Note that we automatically use transpose for iPhone videos taken in portrait mode.
• 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.
• duration : max duration in second of the video. if =10, the encoded video length will be 10 seconds.
• watermark_position : can be “topleft”, “topright”, “bottomleft” or “bottomright”, default is “topleft”
• x264_options : See the x264 Options and x264 Presets for details. Only for h264 video codec

With the cURL command:

curl -u username:passwd -X POST \
-d "video_id=9554271" \
-d "format_id=1086" \
-d "s3_directive=s3://accesskey:secretkey@videos.site.com/1234345422.mp4" \
-d "keep_video_size=true" \
-d "ping_url_after_encode=http://site.com/heywatch/encode?post_id=1234345422" \
-d "ping_url_if_error=http://site.com/heywatch/error?post_id=1234345422" \
https://heywatch.com/job.json

{
  "ping_url_after_encode": "http://site.com/heywatch/encode?post_id=1234345422",
  "created_at": "2011-06-08T15:57:50+02:00",
  "error_msg": null,
  "cf_directive": null,
  "video_id": 9554271,
  "updated_at": "2011-06-08T15:57:50+02:00",
  "progress": 0,
  "id": 4888589,
  "format_id": 1086,
  "s3_directive": "s3://accesskey:secretkey@videos.site.com/1234345422.mp4",
  "ping_url_if_error": "http://site.com/heywatch/error?post_id=1234345422",
  "error_code": null,
  "encoding_options": {
    "keep_video_size": true
  },
  "encoded_video_id": 0,
  "ftp_directive": null,
  "status": "pending",
  "http_upload_directive": null
}