google-genai/com.google.genai.types/GenerateVideosConfig

GenerateVideosConfig

public abstract class GenerateVideosConfig extends JsonSerializable

Configuration for generating videos.

Constructors

Link copied to clipboard
public void GenerateVideosConfig()

Types

Link copied to clipboard
public abstract class Builder
Builder for GenerateVideosConfig.

Properties

Link copied to clipboard
public final static String MAX_READ_LENGTH_PROPERTY
System property to override the default max JSON string length (20MB) in read constraints.

Functions

Link copied to clipboard
public abstract Optional<String> aspectRatio()
The aspect ratio for the generated video.
Link copied to clipboard
public static GenerateVideosConfig.Builder builder()
Instantiates a builder for GenerateVideosConfig.
Link copied to clipboard
public abstract Optional<VideoCompressionQuality> compressionQuality()
Compression quality of the generated videos.
Link copied to clipboard
public abstract Optional<Integer> durationSeconds()
Duration of the clip for video generation in seconds.
Link copied to clipboard
public abstract Optional<Boolean> enhancePrompt()
Whether to use the prompt rewriting logic.
Link copied to clipboard
public abstract Optional<Integer> fps()
Frames per second for video generation.
Link copied to clipboard
public static GenerateVideosConfig fromJson(String jsonString)
Deserializes a JSON string to a GenerateVideosConfig object.
Link copied to clipboard
@InternalApi()
public static T fromJsonNode<T extends JsonSerializable>(JsonNode jsonNode, Class<T> clazz)
Deserializes a JsonNode to an object of the given type.
Link copied to clipboard
@InternalApi()
public static T fromJsonString<T extends JsonSerializable>(String jsonString, Class<T> clazz)
Deserializes a Json string to an object of the given type.
Link copied to clipboard
public abstract Optional<Boolean> generateAudio()
Whether to generate audio along with the video.
Link copied to clipboard
public abstract Optional<HttpOptions> httpOptions()
Used to override HTTP request options.
Link copied to clipboard
public abstract Optional<Map<String, String>> labels()
User specified labels to track billing usage.
Link copied to clipboard
public abstract Optional<Image> lastFrame()
Image to use as the last frame of generated videos.
Link copied to clipboard
public abstract Optional<VideoGenerationMask> mask()
The mask to use for generating videos.
Link copied to clipboard
public abstract Optional<String> negativePrompt()
Explicitly state what should not be included in the generated videos.
Link copied to clipboard
public abstract Optional<Integer> numberOfVideos()
Number of output videos.
Link copied to clipboard
public static ObjectMapper objectMapper()
Link copied to clipboard
public abstract Optional<String> outputGcsUri()
The gcs bucket where to save the generated videos.
Link copied to clipboard
public abstract Optional<String> personGeneration()
Whether allow to generate person videos, and restrict to specific ages.
Link copied to clipboard
public abstract Optional<String> pubsubTopic()
The pubsub topic where to publish the video generation progress.
Link copied to clipboard
public abstract Optional<List<VideoGenerationReferenceImage>> referenceImages()
The images to use as the references to generate the videos.
Link copied to clipboard
public abstract Optional<ImageResizeMode> resizeMode()
Resize mode of the image input for video generation.
Link copied to clipboard
public abstract Optional<String> resolution()
The resolution for the generated video.
Link copied to clipboard
public abstract Optional<Integer> seed()
The RNG seed.
Link copied to clipboard
public static void setMaxReadLength(int maxReadLength)
Overrides the default maximum JSON string length (20MB) for the JSON parser.
Link copied to clipboard
public static JsonNode stringToJsonNode(String string)
Converts a Json string to a JsonNode.
Link copied to clipboard
public abstract GenerateVideosConfig.Builder toBuilder()
Creates a builder with the same values as this instance.
Link copied to clipboard
public String toJson()
Serializes the instance to a Json string.
Link copied to clipboard
public static JsonNode toJsonNode(Object object)
Serializes an object to a JsonNode.
Link copied to clipboard
public static String toJsonString(Object object)
Serializes an object to a Json string.
Link copied to clipboard
public abstract Optional<WebhookConfig> webhookConfig()
Webhook configuration for receiving notifications when the video generation operation completes.