---
title: li-video-reference
description: "A reference to a video (and a poster image)."
---
## Supported Features

| Feature | Supported |
| ------- | :-------: |
| Document | ✔ |
| Media | ✔ |
| Include | ✔ |
| Document Creation Flow | ✗ |
| Push Message | ✗ |
| Usage Log | ✗ |
| Table Dashboard | ✗ |
| Display Filter | ✗ |
| Search Indexing | ✔ |
| System Metadata | ✗ |
| Planning System | ✗ |
| Webhook Conditions | ✗ |

## Description

A `li-video-reference` metadata field shows a list of video references where one entry can be selected. Optionally a customer poster image can be defined. `li-video-reference` is only supported property in includes.


## Default UI

Video & Poster Image Upload/Media Library Selection

![image](../images/li-video-reference-ui.png)

## Storage Format

```js
{
  $ref: 'video',
  reference: {
    id: <String>,
    posterImageId: <String>
  }
}

```

## Content Type Config

```js
{
  handle: 'myContentType',
  // ...
  metadata: [
    {
      handle: 'myHandle',
      type: 'li-video-reference',
      config: {
        // common
        hideFromForm: false,                     // optional, default: false
        required: true,                          // optional, default: false
        requiredErrorMessage: 'Provide a value', // optional
        index: true,                             // optional, default: false. Added in release-2023-07
        // specific
        translatable: true,                      // optional, default: false, translations are only supported for data-record and mediaLibrary
      },
      ui: {
        config: {
          posterImageUploadMediaType: 'posterImage',  // optional, default: 'image'
          posterImageUseDashboard: 'posterImagesDashboard',  // optional
        }
      }
    }
    // ...
  ]
}
```