GET Live Animated Image
Overview
The table below provides information about the GET method for retrieving a live animated image from a live video by its ID.
| GET Live Animated Image | |
|---|---|
| Method | GET |
| URL or Endpoint | https://cdn.vpplayer.tech/projectId/images/videoId/live-animated.fileFormat |
| Parameters | projectId, videoId, fileFormat, duration, fps, width |
| Body | Not Applicable |
The description of the URL and query parameters is as follows:
| Parameter Name | Location | Mandatory | Type | Description |
|---|---|---|---|---|
projectId | Path | Yes | string | Unique ID of the project. |
videoId | Path | Yes | string | Unique ID of the video. |
fileFormat | Path | Yes | string | Image format (webp and gif are supported). |
duration | Query | No | integer | Duration in seconds of the animation to be generated. |
fps | Query | No | integer | Frames per second for the animation. |
width | Query | No | integer | Width of the output image. |
Request Body
The GET method does not require a request body.
Response
If the image generation is successful, a 200 OK response will return the animated image in the requested format.
If the image is still being processed, the response may return a 202 Accepted status with a plain text message:
The image generation request is still being processed! Please try again!
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed