Package com.google.genai.types

Class VideoGenerationMask

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.VideoGenerationMask

public abstract class VideoGenerationMask
extends JsonSerializable

A mask for video generation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VideoGenerationMask.Builder	Builder for VideoGenerationMask.

Constructor Summary

Constructors

Constructor	Description
VideoGenerationMask()

Method Summary

Modifier and Type	Method	Description
static VideoGenerationMask.Builder	builder()	Instantiates a builder for VideoGenerationMask.
static VideoGenerationMask	fromJson(String jsonString)	Deserializes a JSON string to a VideoGenerationMask object.
abstract Optional<Image>	image()	The image mask to use for generating videos.
abstract Optional<VideoGenerationMaskMode>	maskMode()	Describes how the mask will be used.
abstract VideoGenerationMask.Builder	toBuilder()	Creates a builder with the same values as this instance.

Methods inherited from class com.google.genai.JsonSerializable

stringToJsonNode, toJson

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VideoGenerationMask

public VideoGenerationMask()

Method Details

image

public abstract Optional<Image> image()

The image mask to use for generating videos.

maskMode

public abstract Optional<VideoGenerationMaskMode> maskMode()

Describes how the mask will be used. Inpainting masks must match the aspect ratio of the input video. Outpainting masks can be either 9:16 or 16:9.

builder

public static VideoGenerationMask.Builder builder()

Instantiates a builder for VideoGenerationMask.

toBuilder

public abstract VideoGenerationMask.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static VideoGenerationMask fromJson(String jsonString)

Deserializes a JSON string to a VideoGenerationMask object.