POST Remote Videos

POST /remotes/(sid)/videos

Uses an existing remote session to create a video from a sequence of images. The session must have been created successfully using POST /remotes and the session must have a running agent. The caller must supply the session id, the desired video content type, and the paths of source images on the remote filesystem. Because video compression may be time-consuming, a unique video session ID is returned. The client must supply the video session ID along with the remote session ID in subsequent GET /remotes/(sid)/videos/(vsid)/status and GET /remotes/(sid)/videos/(vsid) requests.

Parameters:
  • sid (string) – Unique remote session identifier.
Request Headers:
 
Request JSON Object:
 
  • content-type (string) – Content type for the final video. Currently limited to “video/mp4” or “video/webm”.
  • images (array) – List of absolute paths pointing to static images.
Status Codes:
  • 202 Accepted – Video creation has started.
  • 400 Bad Request – “Agent required” This call requires a remote agent, but the current session isn’t running an agent.
  • 400 Bad Request – Couldn’t start video creation with the current request parameters.
  • 404 Not Found – The session doesn’t exist or has timed-out.
Response Headers:
 
  • Content-Type – application/json
  • X-Slycat-Message – For errors, contains a human-readable description of the problem.
  • X-Slycat-Hint – For errors, contains an optional description of how to fix the problem.
Response JSON Object:
 
  • sid (string) – Unique video-creation session identifier.

Sample Request

POST /remotes/505d0e463d5ed4a32bb6b0fe9a000d36/videos

{
  content-type: "video/mp4",
  images: ["/home/fred/1.jpg", "/home/fred/2.jpg", "/home/fred/3.jpg", ...],
}

Sample Response

{
  "sid" : 431d0e463d5ed4a32bb6b0fe9a000a37
}