Video Schema · Unhead

[Unhead Home](https://unhead.unjs.io/ "Home")

- [Docs](https://unhead.unjs.io/docs/typescript/head/guides/get-started/overview)
- [Tools](https://unhead.unjs.io/tools)
- [Learn](https://unhead.unjs.io/learn/guides/what-is-capo)

[Releases](https://unhead.unjs.io/releases)

Search…```k`` /`

[Unhead on GitHub](https://github.com/unjs/unhead)

[User Guides](https://unhead.unjs.io/docs/typescript/head/guides/get-started/overview)

[API](https://unhead.unjs.io/docs/typescript/head/api/get-started/overview)

[Releases](https://unhead.unjs.io/docs/typescript/releases/v3)

TypeScript

- [Switch to TypeScript](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/video)
- [Switch to Vue](https://unhead.unjs.io/docs/vue/schema-org/api/schema/video)
- [Switch to React](https://unhead.unjs.io/docs/react/schema-org/api/schema/video)
- [Switch to Svelte](https://unhead.unjs.io/docs/svelte/schema-org/api/schema/video)
- [Switch to Solid.js](https://unhead.unjs.io/docs/solid-js/schema-org/api/schema/video)
- [Switch to Angular](https://unhead.unjs.io/docs/angular/schema-org/api/schema/video)
- [Switch to Nuxt](https://unhead.unjs.io/docs/nuxt/schema-org/api/schema/video)

v3 (stable)

Schema.org

- [Discord Support](https://discord.com/invite/275MBUBvgP)
- [TypeScript Playground](https://stackblitz.com/edit/github-hhxywsb5)

- Composables
  - [`useSchemaOrg()`](https://unhead.unjs.io/docs/typescript/schema-org/api/composables/use-schema-org)
- Nodes
  - [Article](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/article)
  - [Book Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/book)
  - [Breadcrumb Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/breadcrumb)
  - [Comment Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/comment)
  - [Course Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/course)
  - [Dataset Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/dataset)
  - [Event Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/event)
  - [Food Establishment Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/food-establishment)
  - [HowTo](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/how-to)
  - [Image Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/image)
  - [ItemList](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/item-list)
  - [JobPosting](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/job-posting)
  - [LocalBusiness](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/local-business)
  - [Movie Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/movie)
  - [Music Album Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/music-album)
  - [Music Group Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/music-group)
  - [Music Playlist Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/music-playlist)
  - [Music Recording Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/music-recording)
  - [Organization](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/organization)
  - [Person Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/person)
  - [Podcast Episode Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/podcast-episode)
  - [Podcast Season Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/podcast-season)
  - [Podcast Series Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/podcast-series)
  - [Product Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/product)
  - [Question Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/question)
  - [Recipe Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/recipe)
  - [Service Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/service)
  - [SoftwareApplication](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/software-app)
  - [TV Episode Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/tv-episode)
  - [TV Season Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/tv-season)
  - [TV Series Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/tv-series)
  - [Video Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/video)
  - [WebPage Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/webpage)
  - [WebSite Schema](https://unhead.unjs.io/docs/typescript/schema-org/api/schema/website)

Schema

# Video Schema

[Copy for LLMs](https://raw.githubusercontent.com/unjs/unhead/refs/heads/main/docs/schema-org/5.api/9.schema/video.md)

Last updated Jan 19, 2026 by [Harlan Wilton](https://github.com/harlan-zw) in [docs: sync](https://github.com/unjs/unhead/commit/d2f86454774aa60706628b46a850653e1e4d56d9).

On this page

- [Schema.org Video](#schemaorg-video)
- [Useful Links](#useful-links)
- [Required properties](#required-properties)
- [Defaults](#defaults)
- [Resolves](#resolves)
- [Example](#example)
- [Types](#types)

## [Schema.org Video](#schemaorg-video)

- **Type**: `defineVideo(input?: Video)`Describes an individual video (usually in the context of an embedded media object).

## [Useful Links](#useful-links)

- [VideoObject - Schema.org](https://schema.org/VideoObject)
- [Video - Yoast](https://developer.yoast.com/features/schema/pieces/video)

## [Required properties](#required-properties)

- **name** `string`The title of the video.Can be provided using route meta on the `title` key, see [defaults](#defaults).
- **description** `string`A description of the video (falling back to the caption, then to 'No description').Can be provided using route meta on the `description` key, see [defaults](#defaults).
- **thumbnail** `ImageObject`An image of the video thumbnail.Can be provided using route meta on the `image` key, see [defaults](#defaults).
- **thumbnailUrl** `string | string[]`A URL pointing to the video thumbnail image file. Follow the [thumbnail image guidelines](https://developers.google.com/search/docs/appearance/video#provide-a-high-quality-thumbnail).
- **uploadDate** `string`The date the video was published, in ISO 8601 formatCan be provided using route meta on the `datePublished` key, see [defaults](#defaults).

## [Defaults](#defaults)

- **@type**: `VideoObject`
- **@id**: `${canonicalUrl}#/schema/video/${hash(image.url)}`
- **inLanguage**: `options.defaultLanguage` (only when caption is provided) _(see: [user Config](https://unhead.unjs.io/docs/schema-org/guides/core-concepts/params))_
- **contentUrl**: is set to `url`

## [Resolves](#resolves)

See [Global Resolves](https://unhead.unjs.io/docs/schema-org/guides/get-started/overview#site-page-level-config) for full context.

- `width` and `height` must be provided for either to be included

## [Example](#example)

```
defineVideo({
  name: 'My cool video',
  uploadDate: new Date(Date.UTC(2020, 10, 10)),
  url: '/image.png',
})
```

## [Types](#types)

```
export interface VideoSimple extends Thing {
  /**
   * The title of the video.
   */
  name?: string
  /**
   * A description of the video (falling back to the caption, then to 'No description').
   */
  description?: string
  /**
   * A reference-by-ID to an imageObject.
   */
  thumbnail?: NodeRelation<ImageObject>
  /**
   * A URL pointing to the video thumbnail image file. Follow the [thumbnail image guidelines](https://developers.google.com/search/docs/appearance/video#provide-a-high-quality-thumbnail).
   */
  thumbnailUrl?: Arrayable<string>
  /**
   * The date the video was published, in ISO 8601 format (e.g., 2020-01-20).
   */
  uploadDate?: ResolvableDate
  /**
   * Whether the video should be considered 'family friendly'
   */
  isFamilyFriendly?: boolean
  /**
   * The URL of the image file (e.g., /images/cat.jpg).
   */
  url: string
  /**
   * The fully-qualified, absolute URL of the image file (e.g., https://www.example.com/images/cat.jpg).
   * Note: The contentUrl and url properties are intentionally duplicated.
   */
  contentUrl?: string
  /**
   * A text string describing the image.
   * - Fall back to the image alt attribute if no specific caption field exists or is defined.
   */
  caption?: string
  /**
   * The height of the image in pixels.
   * - Must be used with width.
   */
  height?: number
  /**
   * The width of the image in pixels.
   * - Must be used with height.
   */
  width?: number
  /**
   * The language code for the textual content; e.g., en-GB.
   * - Only needed when providing a caption.
   */
  inLanguage?: string
  /**
   * The duration of the video in ISO 8601 format.
   */
  duration?: string
  /**
   * A URL pointing to a player for the video.
   */
  embedUrl?: string
  /**
   * The encoding format of the video.
   */
  encodingFormat?: string
  /**
   * A transcript of the video.
   */
  transcript?: string
}
```

[Edit this page](https://github.com/unjs/unhead/edit/main/docs/schema-org/5.api/9.schema/video.md)

[Markdown For LLMs](https://raw.githubusercontent.com/unjs/unhead/refs/heads/main/docs/schema-org/5.api/9.schema/video.md)

Did this page help you?

[TV Series Schema Use defineTVSeries() to add TVSeries structured data. Enable rich results for TV shows with cast, creator, ratings, and season info.](https://unhead.unjs.io/docs/schema-org/api/schema/tv-series) [WebPage Schema Use defineWebPage() to add WebPage structured data. Connect page content to your site hierarchy with automatic page type detection.](https://unhead.unjs.io/docs/schema-org/api/schema/webpage)

On this page

- [Schema.org Video](#schemaorg-video)
- [Useful Links](#useful-links)
- [Required properties](#required-properties)
- [Defaults](#defaults)
- [Resolves](#resolves)
- [Example](#example)
- [Types](#types)

[GitHub](https://github.com/unjs/unhead) [ Discord](https://discord.com/invite/275MBUBvgP)

[ /llms.txt](https://unhead.unjs.io/llms.txt)

[Part of the UnJS ecosystem](https://unjs.io/)

### Head Management

- [Getting Started](https://unhead.unjs.io/docs/typescript/head/guides/get-started/overview)
- [useHead](https://unhead.unjs.io/docs/typescript/head/api/composables/use-head)
- [useSeoMeta](https://unhead.unjs.io/docs/typescript/head/api/composables/use-seo-meta)
- [useHeadSafe](https://unhead.unjs.io/docs/typescript/head/api/composables/use-head-safe)
- [useScript](https://unhead.unjs.io/docs/typescript/head/api/composables/use-script)

### Schema.org

- [Getting Started](https://unhead.unjs.io/docs/typescript/schema-org/guides/get-started/overview)
- [useSchemaOrg](https://unhead.unjs.io/docs/typescript/schema-org/api/composables/use-schema-org)
- [Nodes](https://unhead.unjs.io/docs/typescript/schema-org/guides/core-concepts/nodes)
- [Recipes](https://unhead.unjs.io/docs/typescript/schema-org/guides/recipes/identity)

### Guides

- [Titles](https://unhead.unjs.io/docs/typescript/head/guides/core-concepts/titles)
- [Streaming SSR](https://unhead.unjs.io/docs/typescript/head/guides/core-concepts/streaming)
- [DOM Events](https://unhead.unjs.io/docs/typescript/head/guides/core-concepts/dom-event-handling)
- [Plugins](https://unhead.unjs.io/docs/typescript/head/guides/plugins/template-params)

### Tools

- [Meta Tag Generator](https://unhead.unjs.io/tools/meta-tag-generator)
- [OG Image Generator](https://unhead.unjs.io/tools/og-image-generator)
- [Schema.org Generator](https://unhead.unjs.io/tools/schema-generator)
- [Capo.js Analyzer](https://unhead.unjs.io/tools/capo-analyzer)

### Articles

- [What is Capo.js?](https://unhead.unjs.io/learn/guides/what-is-capo)

### Research

- [State of <head> in 2026](https://unhead.unjs.io/learn/research/state-of-head-2026)
- [Streaming Head Performance](https://unhead.unjs.io/learn/research/streaming-head-performance)
- [Capo.js Performance Research](https://unhead.unjs.io/learn/research/capo-performance-research)

Copyright © 2025-2026 Harlan Wilton - [MIT License](https://github.com/unjs/unhead/blob/main/license)