# social.colibri.beta.embed.defs

> Published by [colibri.social](https://lexicon.garden/identity/did:plc:mprdjqjluoswa7awzggaggj3)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.embed.defs)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.embed.defs/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.embed.defs/examples)

## Definitions

### `social.colibri.beta.embed.defs#gifView`

**Type**: `object`

A GIF from the picker.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `id` | `string` | Yes | Provider identifier, stable enough to save as a favourite. |
| `url` | `string` (uri) | Yes | Full-size GIF URL. |
| `title` | `string` | No | Human-readable title. |
| `width` | `integer` | Yes | Intrinsic pixel width. |
| `height` | `integer` | Yes | Intrinsic pixel height. |
| `previewUrl` | `string` (uri) | Yes | Smaller preview URL for the picker grid. |

### `social.colibri.beta.embed.defs#linkEmbed`

**Type**: `object`

A link preview.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `uri` | `string` (uri) | Yes | The URL previewed. |
| `image` | `ref` → `#embedImage` | No | Preview image. |
| `title` | `string` | No | Page title. |
| `video` | `ref` → `#embedVideo` | No | Playable video. |
| `siteName` | `string` | No | Publisher name. |
| `description` | `string` | No | Page description. |

### `social.colibri.beta.embed.defs#embedImage`

**Type**: `object`

A preview image.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `alt` | `string` | No | Alternative text. |
| `url` | `string` (uri) | Yes | URL served by this AppView's image proxy. |
| `width` | `integer` | No | Intrinsic pixel width. |
| `height` | `integer` | No | Intrinsic pixel height. |

### `social.colibri.beta.embed.defs#embedVideo`

**Type**: `object`

A playable video.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `url` | `string` (uri) | Yes | URL served by this AppView's video proxy. |
| `width` | `integer` | No | Intrinsic pixel width. |
| `height` | `integer` | No | Intrinsic pixel height. |
| `duration` | `integer` | No | Duration in seconds. |
| `mimeType` | `string` | Yes | Content type. |

### `social.colibri.beta.embed.defs#gifCategory`

**Type**: `object`

A category in the GIF picker.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes | Category name. |
| `previewUrl` | `string` (uri) | No | Representative image for the category. |

## Raw Schema

```json
{
  "id": "social.colibri.beta.embed.defs",
  "defs": {
    "gifView": {
      "type": "object",
      "required": [
        "id",
        "url",
        "previewUrl",
        "width",
        "height"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Provider identifier, stable enough to save as a favourite."
        },
        "url": {
          "type": "string",
          "format": "uri",
          "description": "Full-size GIF URL."
        },
        "title": {
          "type": "string",
          "description": "Human-readable title."
        },
        "width": {
          "type": "integer",
          "description": "Intrinsic pixel width."
        },
        "height": {
          "type": "integer",
          "description": "Intrinsic pixel height."
        },
        "previewUrl": {
          "type": "string",
          "format": "uri",
          "description": "Smaller preview URL for the picker grid."
        }
      },
      "description": "A GIF from the picker."
    },
    "linkEmbed": {
      "type": "object",
      "required": [
        "uri"
      ],
      "properties": {
        "uri": {
          "type": "string",
          "format": "uri",
          "description": "The URL previewed."
        },
        "image": {
          "ref": "#embedImage",
          "type": "ref",
          "description": "Preview image."
        },
        "title": {
          "type": "string",
          "description": "Page title."
        },
        "video": {
          "ref": "#embedVideo",
          "type": "ref",
          "description": "Playable video."
        },
        "siteName": {
          "type": "string",
          "description": "Publisher name."
        },
        "description": {
          "type": "string",
          "description": "Page description."
        }
      },
      "description": "A link preview."
    },
    "embedImage": {
      "type": "object",
      "required": [
        "url"
      ],
      "properties": {
        "alt": {
          "type": "string",
          "description": "Alternative text."
        },
        "url": {
          "type": "string",
          "format": "uri",
          "description": "URL served by this AppView's image proxy."
        },
        "width": {
          "type": "integer",
          "description": "Intrinsic pixel width."
        },
        "height": {
          "type": "integer",
          "description": "Intrinsic pixel height."
        }
      },
      "description": "A preview image."
    },
    "embedVideo": {
      "type": "object",
      "required": [
        "url",
        "mimeType"
      ],
      "properties": {
        "url": {
          "type": "string",
          "format": "uri",
          "description": "URL served by this AppView's video proxy."
        },
        "width": {
          "type": "integer",
          "description": "Intrinsic pixel width."
        },
        "height": {
          "type": "integer",
          "description": "Intrinsic pixel height."
        },
        "duration": {
          "type": "integer",
          "description": "Duration in seconds."
        },
        "mimeType": {
          "type": "string",
          "description": "Content type.",
          "knownValues": [
            "video/mp4",
            "video/webm"
          ]
        }
      },
      "description": "A playable video."
    },
    "gifCategory": {
      "type": "object",
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "Category name."
        },
        "previewUrl": {
          "type": "string",
          "format": "uri",
          "description": "Representative image for the category."
        }
      },
      "description": "A category in the GIF picker."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```