Images
Thumbnail Image
When a video is encoded in VP Player, a default thumbnail image is generated and saved in storage. You can access this image by using the default path:
https://cdn.vpplayer.tech/{projecId}/encode/{videoId}/thumbnails/retina.jpg
Note that for a particular video, the default thumbnail path would be: https://cdn.vpplayer.tech/agmipoaa/encode/vjsnkiko/thumbnails/retina.jpg
Thumbnail is generated by default, but can be changed with an image from video or upload a new image.
Filmstrip Image
For every video in VP Player, a filmstrip is generated. The filmstrip is an image created by taking 100 screenshots for every 1% of the video. You can find the filmstrip using the default path:
https://cdn.vpplayer.tech/{projecId}/encode/{videoId}/thumbnails/filmstrip0.jpg
Note that for a particular video, the default filmstrip path would be: https://cdn.vpplayer.tech/agmipoaa/encode/vjsnkiko/thumbnails/filmstrip0.jpg
You can also access filmstrips for each quartile of the video:
- 1st quartile:
filmstrip1.jpg - 2nd quartile:
filmstrip2.jpg - 3rd quartile:
filmstrip3.jpg - 4th quartile:
filmstrip4.jpg
Video Image
You can generate an image from a video in VP Player using the following endpoint:
https://cdn.vpplayer.tech/{projectId}/images/{videoId}/thumbnail.jpg
| Parameter | Defaults | Description | Restrictions |
|---|---|---|---|
fileFormat | none | The file format you want the image in. It can be jpg, png, or webp. | The file format is specified in the fileName parameter as thumbnail.{jpg, png, webp}. |
time | 0 | The time in seconds from which you want a screenshot from the video. | The parameter should be between 0 and the length of the video. |
width | 1280 | The width in pixels for the image output. | If you do not provide width to the API, it will default to 1,280px. |
height | 720 | The height in pixels for the image output. | If you do not provide height to the API, it will default to 720px. |
Note that if you use both the width and height parameters, the image can be deformed. If you provide only one parameter, the image will maintain its aspect ratio.
For example, to get an image from the 5th second of a video in webp format, use:
https://cdn.vpplayer.tech/{projectId}/images/{videoId}/thumbnail.webp?time=5
Animated Image
You can generate an animation from a video in VP Player using the following endpoint:
https://cdn.vpplayer.tech/{projectId}/images/{videoId}/animated.gif
| Parameter | Defaults | Description | Restrictions |
|---|---|---|---|
fileFormat | none | The file format you want the animation in. It can be gif or webp. | The file format is specified in the fileName parameter as animated.{gif, webp}. |
start | 0 | The time in seconds from which you want the animation to start from the video. | The parameter should be between 0 and the length of the video minus 1. |
end | 5 or start + 5 | The time in seconds at which you want the animation to end from the video. | The parameter should be a maximum of 10 seconds longer than the start of the video. |
fps | 5 | The frames per second (fps) of the animation. | fps multiplied by duration gives us the number of frames per animation, which cannot be higher than 256. |
width | 1280 | The width in pixels for the image output. | If you do not provide width to the API, it will default to 1,280px. |
- Duration of the animation can't be longer than 10 seconds.
- Frames per second can be any value from 1 to 30
- End can't be lower than start, in this case: start = start, end = start + 5
For example, to get an animation to start at the 7th second and to end on the 14th second with 5 frames per second on a video in webp format, use:
https://cdn.vpplayer.tech/{projectId}/images/{videoId}/animated.webp?start=7&end=14&fps=5
