---
title: li-poster-image
description: "Set a poster image for a video."
---
## 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

Set a poster image for a video.


## Default UI

Poster Image selection, has some special UI within Video Media Library Entries

## Storage Format

```js
{
  originalUrl: <String>,
  url: <String>,
  mediaId: <String>,
  height: <Integer>,
  width: <Integer>,
  mimeType: <String>,
  imageService: <String>,
  crops: [
    {
      name: <String>,
      x: <Integer>,
      y: <Integer>,
      width: <Integer>,
      height: <Integer>,
      isAutomatic: <Boolean>
    }
  ]
}

```

## Content Type Config

```js
{
  handle: 'myContentType',
  // ...
  metadata: [
    {
      handle: 'myHandle',
      type: 'li-poster-image'
      config: {
        required: true,                          // optional, default: false
        requiredErrorMessage: 'Provide a value', // optional
      },
      ui: {
        label: 'Poster Image',                   // optional
        config: {
          uploadMediaType: 'posterImage',        // optional, default: 'image'
          useDashboard: 'posterImagesDashboard', // optional
        }
      }
    }
    // ...
  ]
}
```