API Documentation Format

Comparing version 3 and version 2 back

URL: http://heywatch.com/format

h2. Actions


    * [GET] http://heywatch.com/format/ : get the list of all formats
    * [GET] http://heywatch.com/format/ID : retrieve information about the format ID
    * [POST] http://heywatch.com/format : create a format
    * [PUT] http://heywatch.com/format/ID : modify the format ID
    * [DELETE] http://heywatch.com/format/ID : Destroy the format ID

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


  h263
  Mobile 3GP
  3gp
  160
  8000
  1
  32
  1
  amr_nb
  144
  15.0
  176




h2. Valid parameters for POST and PUT


    * name**name ::** format name
    * category**category ::** format category; can be formats, devices --Default is 'formats'
    * container**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 ::** video codec; can be mpeg4, xvid, flv, h263, mjpeg, mpeg1video, mpeg2video, qtrle, svq3, wmv1, wmv2, huffyuv, rv20, h264
    * video_bitrate**video_bitrate ::** video bitrate in kbit/s, value must be between 50 and 200010000
    * fps**fps ::** Frame per Second; can be 7.5, 10.0, 14.985, 15.0, 23.98, 25.0, 29.97, 30.0
    * width**width ::** width in pixel of the image, must be between 50 and 7201920
    * height**height ::** height in pixel of the image, must be between 50 and 576.1280. If 0, it will be calculated automatically
    * audio_channel**audio_channel ::** Audio channel, can be 0 to disable audio, 1 for mono and 2 for stereo
    * audio_codec**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 ::** Audio bitrate in kbit/skbit/s, up to 512kbits --Not necessary if audio_channel is 0
    * sample_rate**sample_rate ::** Sample rate; can be 8000, 11025, 16000, 22000, 22050, 24000, 32000, 44000, 44100, 48000 --Not necessary if audio_channel is 0