Gemini.Types.Generation.Video (GeminiEx v0.8.4)

View Source

Type definitions for video generation using Google's Veo models.

Veo is Google's advanced text-to-video generation model that creates high-quality videos from text descriptions. Video generation is a long-running operation that requires polling to check completion status.

Supported Models

  • veo-2.0-generate-001 - Veo 2.0 video generation model

Example

config = %VideoGenerationConfig{
  number_of_videos: 1,
  duration_seconds: 8,
  aspect_ratio: "16:9"
}

{:ok, operation} = Gemini.APIs.Videos.generate(
  "A cat playing piano in a cozy living room",
  config
)

# Wait for completion
{:ok, completed} = Gemini.APIs.Operations.wait(operation.name)

# Get video URLs
videos = completed.response["generatedVideos"]

See Gemini.APIs.Videos for API functions.

Summary

Types

aspect_ratio()

Aspect ratio for generated videos.

compression_format()

Video compression format.

t()

Functions

build_generation_params(prompt, config)

Builds parameters map for video generation API request.

complete?(video_operation)

Checks if a video operation is complete.

extract_videos(operation)

Extracts generated videos from a completed operation.

failed?(video_operation)

Checks if a video operation failed.

format_compression_format(atom)

Converts compression format to API format.

format_person_generation(atom)

Converts person generation policy to API format.

format_safety_filter_level(atom)

Converts safety filter level to API format.

parse_generated_video(data)

Parses a generated video from API response.

succeeded?(video_operation)

Checks if a video operation succeeded.

wrap_operation(operation)

Wraps an Operation with video-specific metadata.

Types

aspect_ratio()

@type aspect_ratio() :: String.t()

Aspect ratio for generated videos.

Common aspect ratios:

  • "9:16" - Vertical/mobile (e.g., 720x1280)
  • "16:9" - Horizontal/desktop (e.g., 1280x720)
  • "1:1" - Square (e.g., 1024x1024)

compression_format()

@type compression_format() :: :h264 | :h265

Video compression format.

  • :h264 - H.264/AVC compression (default, widely compatible)
  • :h265 - H.265/HEVC compression (better quality, smaller size)

t()

@type t() :: Gemini.Types.Generation.Video.VideoGenerationConfig.t()

Functions

build_generation_params(prompt, config)

@spec build_generation_params(
  String.t(),
  Gemini.Types.Generation.Video.VideoGenerationConfig.t()
) ::
  map()

Builds parameters map for video generation API request.

complete?(video_operation)

@spec complete?(Gemini.Types.Generation.Video.VideoOperation.t()) :: boolean()

Checks if a video operation is complete.

extract_videos(operation)

@spec extract_videos(Gemini.Types.Operation.t()) ::
  {:ok, [Gemini.Types.Generation.Video.GeneratedVideo.t()]} | {:error, term()}

Extracts generated videos from a completed operation.

failed?(video_operation)

@spec failed?(Gemini.Types.Generation.Video.VideoOperation.t()) :: boolean()

Checks if a video operation failed.

format_compression_format(atom)

@spec format_compression_format(compression_format()) :: String.t()

Converts compression format to API format.

Examples

iex> format_compression_format(:h264)
"h264"

format_person_generation(atom)

@spec format_person_generation(atom()) :: String.t()

Converts person generation policy to API format.

format_safety_filter_level(atom)

@spec format_safety_filter_level(atom()) :: String.t()

Converts safety filter level to API format.

parse_generated_video(data)

@spec parse_generated_video(map()) :: Gemini.Types.Generation.Video.GeneratedVideo.t()

Parses a generated video from API response.

succeeded?(video_operation)

@spec succeeded?(Gemini.Types.Generation.Video.VideoOperation.t()) :: boolean()

Checks if a video operation succeeded.

wrap_operation(operation)

@spec wrap_operation(Gemini.Types.Operation.t()) ::
  Gemini.Types.Generation.Video.VideoOperation.t()

Wraps an Operation with video-specific metadata.