---
layout: page
title: "Overlay"
node_type: "nodetool.video.Overlay"
namespace: "nodetool.video"
---

**Type:** `nodetool.video.Overlay`

**Namespace:** `nodetool.video`

## Description

Overlay one video on top of another, including audio overlay when available.
    video, overlay, composite, picture-in-picture, audio

## Properties

| Property | Type | Description | Default |
|----------|------|-------------|---------|
| main_video | `video` | The main (background) video. | `{"type":"video","uri":"","asset_id":null,"data"...` |
| overlay_video | `video` | The video to overlay on top. | `{"type":"video","uri":"","asset_id":null,"data"...` |
| x | `int` | X-coordinate for overlay placement. | `0` |
| y | `int` | Y-coordinate for overlay placement. | `0` |
| scale | `float` | Scale factor for the overlay video. | `1` |
| overlay_audio_volume | `float` | Volume of the overlay audio relative to the main audio. | `0.5` |

## Outputs

| Output | Type | Description |
|--------|------|-------------|
| output | `video` |  |

## Related Nodes

Browse other nodes in the [nodetool.video](../) namespace.
