mediafile/$mediafile_id/still/create

02Nov2009 Posted by forgacs

Still generation with mediafile

This call implements a still generation based on the source file using the specified parameters. The URL contains the mediafile_id. In response, the job id is returned, it can be used to request that status later. Till version 1.7.

Request URL

/mediafile/{mediafile_id}/still/create [POST]

Request parameters

Parameter	Type	Description	Method	Obligatory/Optional
mediafile_id	alphanumeric	mediafile id	URL	obligatory
user_id	string	user id	POST	obligatory
frametime	integer	Time in seconds * Don't use it. Just for backward compatibility.	POST	optioneel
width	integer	width of image * Don't use it. Just for backward compatibility.	POST	optional
height	integer	height of image * Don't use it. Just for backward compatibility.	POST	optional
Other: See Still creation parameters (POST)

Example request URL (POST)

/mediafile/SOGsCn8yIYAYlf9LAoP058pr/still/create
POST:
user_id=entree004

frametime=12

Response fields

Field	Description
job_id	job id

Example response

<items>
  <item id="1">
    <job_id>7596</job_id>
  </item>
</items>

Still creation parameters (POST)

Parameter	Type	Description	Method	Obligatory/Optional
still_type	string	The type of the still: none: original behaviour, 1 still / mediafile. In this case the application tries to avoid making black still. Therefore the application takes 5 samples. First is from the given start_time, and the others from the start_time +- 1 and 3 seconds (eg. 10, 11, 9, 13, 7). The image with the most colours is chosen as a still. normal: x still per mediafile, second: one still for every x second, scene: one still for each scene,	POST	optional
still_per_mediafile	integer	For 'normal' type. The number of the still / mediafile	POST	optional (If omitted when still_type = normal, still_type will default to 'none')
still_every_second	integer	For 'second' type. The distance between two stills in second.	POST	optional (If omitted when still_type = second, still_type will default to 'none')
start_time	integer	Start time.	POST	optional
end_time	integer	End time.	POST	optional
size	string	Still size. E.g. “176x144”, or “qcif”	POST	optional
h_padding	integer	Horizontal padding.	POST	optional
v_padding	integer	Vertical padding.	POST	optional