# live.streamface.custommodule

> Published by [streamface.live](https://lexicon.garden/identity/did:plc:j66wyknizjxecbnrenjzj7l3)

✓ This is the authoritative definition for this NSID.

## Description

Declarative Custom Module overlay. Source is untrusted and must be sanitized and sandboxed.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:j66wyknizjxecbnrenjzj7l3/live.streamface.custommodule)
- [Documentation](https://lexicon.garden/lexicon/did:plc:j66wyknizjxecbnrenjzj7l3/live.streamface.custommodule/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:j66wyknizjxecbnrenjzj7l3/live.streamface.custommodule/examples)

## Definitions

### `live.streamface.custommodule`

**Type**: `record`

**Key**: `any`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `createdAt` | `string` (datetime) | Yes |  |
| `css` | `string` | Yes |  |
| `enabled` | `boolean` | Yes |  |
| `html` | `string` | Yes |  |
| `media` | `array` | No |  |
| `name` | `string` | Yes |  |
| `updatedAt` | `string` (datetime) | Yes |  |

### `live.streamface.custommodule#media`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `blob` | `blob` | Yes |  |
| `id` | `string` | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "key": "any",
      "record": {
        "properties": {
          "createdAt": {
            "format": "datetime",
            "type": "string"
          },
          "css": {
            "maxLength": 50000,
            "type": "string"
          },
          "enabled": {
            "type": "boolean"
          },
          "html": {
            "maxLength": 50000,
            "type": "string"
          },
          "media": {
            "items": {
              "ref": "#media",
              "type": "ref"
            },
            "maxLength": 100,
            "type": "array"
          },
          "name": {
            "maxLength": 200,
            "minLength": 1,
            "type": "string"
          },
          "updatedAt": {
            "format": "datetime",
            "type": "string"
          }
        },
        "required": [
          "name",
          "enabled",
          "html",
          "css",
          "createdAt",
          "updatedAt"
        ],
        "type": "object"
      },
      "type": "record"
    },
    "media": {
      "properties": {
        "blob": {
          "accept": [
            "image/png",
            "image/jpeg",
            "image/gif",
            "image/webp",
            "image/avif",
            "video/mp4",
            "video/webm",
            "video/quicktime"
          ],
          "maxSize": 10000000,
          "type": "blob"
        },
        "id": {
          "maxLength": 128,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "id",
        "blob"
      ],
      "type": "object"
    }
  },
  "description": "Declarative Custom Module overlay. Source is untrusted and must be sanitized and sandboxed.",
  "id": "live.streamface.custommodule",
  "lexicon": 1
}
```
