Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
REST Resource: projects.locations.videoThumbnails
Stay organized with collections
Save and categorize content based on your preferences.
Resource: VideoThumbnail
Information about a video thumbnail.
| Fields |
name |
string
The resource name representing the video thumbnail, of the form "projects/*/videoThumbnails/**" (e.g. "projects/earthengine-legacy/videoThumbnails/").
|
expression |
object (Expression)
The expression to compute. Must evaluate to an ImageCollection.
|
videoOptions |
object (VideoOptions)
Options for the animation.
|
fileFormat |
enum (VideoFileFormat)
The output encoding in which to generate the resulting video thumbnail. Currently only GIF is supported.
|
grid |
object (PixelGrid)
An optional pixel grid describing how the images computed by expression are reprojected and clipped.
|
VideoOptions
Basic options for generating videos.
| JSON representation |
{
"framesPerSecond": number,
"maxFrames": integer,
"maxPixelsPerFrame": string
} |
| Fields |
framesPerSecond |
number
The frame rate of the exported video. Must be a value between 0.1 and 120. Defaults to 5.0.
|
maxFrames |
integer
The maximum number of video frames to compute and export. This is a safety guard to prevent you from accidentally starting a larger export than you had intended. The default value is 1000 frames, but you can set the value explicitly to raise or lower this limit.
|
maxPixelsPerFrame |
string (Int64Value format)
The maximum number of pixels to compute and export per frame. This is a safety guard to prevent you from accidentally starting a larger export than you had intended. The default value is 1e8 pixels, but you can set the value explicitly to raise or lower this limit.
|
Methods |
|
|
Creates an ID that can be used to render an image containing an animation of multiple images from a collection. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-06 UTC.
[null,null,["Last updated 2025-03-06 UTC."],[[["\u003cp\u003eVideoThumbnail resource provides information about a video thumbnail, enabling the creation of animations from Earth Engine image collections.\u003c/p\u003e\n"],["\u003cp\u003eIt utilizes an expression that evaluates to an ImageCollection, along with options for frame rate, maximum frames, and pixel count per frame to customize the animation.\u003c/p\u003e\n"],["\u003cp\u003eUsers can choose from several video file formats, including GIF, MP4, and VP9, to encode the video thumbnail.\u003c/p\u003e\n"],["\u003cp\u003eA pixel grid can optionally be defined for reprojection and clipping of images during the animation process.\u003c/p\u003e\n"]]],["This document details the structure for creating video thumbnails from image collections. Key components include: defining a `name` for the thumbnail, specifying an `expression` to compute an `ImageCollection`, setting `videoOptions` like `framesPerSecond`, `maxFrames`, and `maxPixelsPerFrame`, and selecting a `fileFormat` (currently GIF supported). An optional `grid` can control image reprojection and clipping. The `create` method generates a resource ID for rendering these animated thumbnails.\n"],null,["# REST Resource: projects.locations.videoThumbnails\n\nResource: VideoThumbnail\n------------------------\n\nInformation about a video thumbnail.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"expression\": { object (/earth-engine/reference/rest/v1beta/Expression) }, \"videoOptions\": { object (/earth-engine/reference/rest/v1beta/projects.locations.videoThumbnails#VideoThumbnail.VideoOptions) }, \"fileFormat\": enum (/earth-engine/reference/rest/v1beta/projects.locations.videoThumbnails#VideoThumbnail.VideoFileFormat), \"grid\": { object (/earth-engine/reference/rest/v1beta/PixelGrid) } } ``` |\n\n| Fields ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The resource name representing the video thumbnail, of the form \"projects/\\*/videoThumbnails/\\*\\*\" (e.g. \"projects/earthengine-legacy/videoThumbnails/\"). |\n| `expression` | `object (`[Expression](/earth-engine/reference/rest/v1beta/Expression)`)` The expression to compute. Must evaluate to an ImageCollection. |\n| `videoOptions` | `object (`[VideoOptions](/earth-engine/reference/rest/v1beta/projects.locations.videoThumbnails#VideoThumbnail.VideoOptions)`)` Options for the animation. |\n| `fileFormat` | `enum (`[VideoFileFormat](/earth-engine/reference/rest/v1beta/projects.locations.videoThumbnails#VideoThumbnail.VideoFileFormat)`)` The output encoding in which to generate the resulting video thumbnail. Currently only GIF is supported. |\n| `grid` | `object (`[PixelGrid](/earth-engine/reference/rest/v1beta/PixelGrid)`)` An optional pixel grid describing how the images computed by `expression` are reprojected and clipped. |\n\n### VideoOptions\n\nBasic options for generating videos.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------|\n| ``` { \"framesPerSecond\": number, \"maxFrames\": integer, \"maxPixelsPerFrame\": string } ``` |\n\n| Fields ||\n|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `framesPerSecond` | `number` The frame rate of the exported video. Must be a value between 0.1 and 120. Defaults to 5.0. |\n| `maxFrames` | `integer` The maximum number of video frames to compute and export. This is a safety guard to prevent you from accidentally starting a larger export than you had intended. The default value is 1000 frames, but you can set the value explicitly to raise or lower this limit. |\n| `maxPixelsPerFrame` | `string (`[Int64Value](https://developers.google.com/discovery/v1/type-format)` format)` The maximum number of pixels to compute and export per frame. This is a safety guard to prevent you from accidentally starting a larger export than you had intended. The default value is 1e8 pixels, but you can set the value explicitly to raise or lower this limit. |\n\n### VideoFileFormat\n\nSelects a video file format in which to encode a sequence of images.\n\n| Enums ||\n|---------------------------------|------------------------|\n| `VIDEO_FILE_FORMAT_UNSPECIFIED` | Unspecified. |\n| `MP4` | MPEG-4 Part 14 format. |\n| `GIF` | Animated GIF. |\n| `VP9` | WEBM/VP9 |\n\n| Methods ------- ||\n|---------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|\n| ### [create](/earth-engine/reference/rest/v1beta/projects.locations.videoThumbnails/create) | Creates an ID that can be used to render an image containing an animation of multiple images from a collection. |"]]