Format Resource
The Format resource defines the complete encoding profile. You must give its ID for each job you create. You can use the GUI to create a new format here.
Get all the formats
GET /format.(xml|json)
With the cURL command:
curl -u username:passwd https://heywatch.com/format.json
[
{
"name": "Flash Video H264",
"sample_rate": 44100,
"category": "formats",
"audio_channels": 2,
"container": "mp4",
"video_bitrate": 800.0,
"audio_bitrate": 96.0,
"id": 1086,
"audio_codec": "aac",
"height": 240,
"two_pass": false,
"video_codec": "h264",
"fps": 25.0,
"width": 320,
"owner": false
},
{
"name": "MP4 - 3000kbps - 2pass",
"sample_rate": 0,
"category": "formats",
"audio_channels": 0,
"container": "mp4",
"video_bitrate": 3000.0,
"audio_bitrate": 64.0,
"id": 1975,
"audio_codec": "",
"height": 240,
"two_pass": true,
"video_codec": "mpeg4",
"fps": 23.98,
"width": 320,
"owner": true
}
]
Get information about a specific Format
GET /format/ID.(xml|json)
With the cURL command:
curl -u username:passwd https://heywatch.com/format/1086.json
{
"name": "Flash Video H264",
"sample_rate": 44100,
"category": "formats",
"audio_channels": 2,
"container": "mp4",
"video_bitrate": 800.0,
"audio_bitrate": 96.0,
"id": 1086,
"audio_codec": "aac",
"height": 240,
"two_pass": false,
"video_codec": "h264",
"fps": 25.0,
"width": 320,
"owner": false
}
Create a format
POST /format.(xml|json)
Parameters
- category: format category; can be formats, devices
- name: format name
- category: format category; can be formats, devices –Default is ‘formats’
- container: video format; can be avi, mp4, 3gp, psp, mpeg, mpegts, dvd, flv, svcd, vcd, vob, asf, mov, rm, mjpeg, mpeg2video, 3g2, mp3, ogg
- video_codec: video codec; can be mpeg4, xvid, flv, h263, mjpeg, mpeg1video, mpeg2video, qtrle, svq3, wmv1, wmv2, huffyuv, rv20, h264
- video_bitrate: video bitrate in kbit/s, value must be between 50 and 10000
- fps: Frame per Second; can be 7.5, 10.0, 14.985, 15.0, 23.98, 25.0, 29.97, 30.0
- width: width in pixel of the image, must be between 50 and 1920
- height: height in pixel of the image, must be between 50 and 1280. If 0, it will be calculated automatically
- audio_channels: Audio channel, can be 0 to disable audio, 1 for mono and 2 for stereo
- audio_codec: Audio codec; can be mp3, mp2, aac, pcm, amr_nb, ac3, vorbis, flac, pcm_u8 –Not necessary if audio_channel is 0
- audio_bitrate: Audio bitrate in kbit/s, up to 512kbits –Not necessary if audio_channel is 0
- sample_rate: Sample rate; can be 8000, 11025, 16000, 22000, 22050, 24000, 32000, 44000, 44100, 48000 –Not necessary if audio_channel is 0
- two_pass: 2-pass encoding option; can be true or false
With the cURL command:
curl -u username:passwd -X POST \
-d "category=devices" \
-d "name=iPad" \
-d "container=mp4" \
-d "video_codec=h264" \
-d "video_bitrate=1500" \
-d "fps=30" \
-d "width=1280" \
-d "height=720" \
-d "audio_channels=2" \
-d "audio_codec=aac" \
-d "audio_bitrate=128" \
-d "sample_rate=44000" \
-d "two_pass=false" \
https://heywatch.com/format.json
{
"name": "iPad",
"sample_rate": 44000,
"category": "devices",
"audio_channels": 2,
"container": "mp4",
"video_bitrate": 1500.0,
"audio_bitrate": 128.0,
"id": 7147,
"audio_codec": "aac",
"height": 720,
"two_pass": false,
"video_codec": "h264",
"fps": 30.0,
"width": 1280,
"owner": true
}
Update a format
PUT /format.(xml|json)
Parameters
Same as POST parameters.
With the cURL command:
curl -i -u username:passwd -X PUT \
-d "name=iPad 720p" \
https://heywatch.com/format/7147.json
HTTP/1.1 204 No Content
Server: nginx/0.5.32
Date: Wed, 08 Jun 2011 12:48:58 GMT
Connection: close
Status: 204
X-Powered-By: Phusion Passenger (mod_rails/mod_rack) 3.0.0
X-UA-Compatible: IE=Edge,chrome=1
X-Runtime: 0.018841
Set-Cookie: _session_id=xxxxxxxxxxxxxxxxxxxxxxxxxxxx; path=/; expires=Fri, 10-Jun-2011 13:28:48 GMT
Cache-Control: no-cache
Delete a format
DELETE /format/ID.(json|xml)
You can only delete the formats you’ve created (owner=true).
curl -i -u username:passwd -X DELETE "http://heywatch.com/format/1975.json"
HTTP/1.1 204 No Content
Server: nginx/0.5.32
Date: Thu, 10 Feb 2011 11:10:46 GMT
Connection: close
Status: 204
X-Powered-By: Phusion Passenger (mod_rails/mod_rack) 3.0.0
X-UA-Compatible: IE=Edge,chrome=1
X-Runtime: 0.015292
Set-Cookie: _session_id=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx; path=/; expires=Sat, 12-Feb-2011 11:31:11 GMT
Cache-Control: no-cache