How to Use Video Face Detection API¶
In this section:
Video face detection API requests are to be sent to
http://<findface-video-manager IP address>:18810/. API requests are executed by the
Video face detection API operates on a
job object which represents a video processing task that the
findface-video-manager component issues to
job object has the following attributes:
id: job id specified by a user.
stream_url: URL/address of video stream/file to process.
labels: tag(s) that will be used by the
findface-faceroutercomponent to find processing directives for faces detected in this stream.
single_pass: if true, disable restarting video processing upon error (by default, false).
router_url: IP address and port of the
findface-faceroutercomponent to receive detected faces from the
findface-video-workercomponent for processing.
status: job status.
status_msg: additional job status info.
statistic: job progress statistics (progress duration, number of posted faces).
worker_id: id of the
findface-video-workerinstance executing the job.
If a method fails, it always returns a response with a HTTP code other than 200, and a JSON body containing the error description. The error body always includes at least two fields:
codeis a short string in
CAPS_AND_UNDERSCORES, usable for automatic decoding.
descis a human-readable description of the error and should not be interpreted automatically.
Common Error Codes
|Error code||Description||HTTP code|
||Error with unknown origin.||500|
||The request cannot be read, or some method parameters are invalid.||400|
||Job not found.||404|
||The previously requested job removal is in progress.||423|