# com.luminframe.visualizer

> Published by [luminframe.com](https://lexicon.garden/identity/did:plc:5mo4amsmatgfmzpeqqsuetot)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:5mo4amsmatgfmzpeqqsuetot/com.luminframe.visualizer)
- [Documentation](https://lexicon.garden/lexicon/did:plc:5mo4amsmatgfmzpeqqsuetot/com.luminframe.visualizer/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:5mo4amsmatgfmzpeqqsuetot/com.luminframe.visualizer/examples)

## Definitions

### `com.luminframe.visualizer`

**Type**: `record`

An image-free Luminframe visualizer: a song reference and the effect palette that responds to it.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `artist` | `string` | Yes | Song artist from plyr.fm. |
| `createdAt` | `string` (datetime) | Yes | When the composition was published. |
| `name` | `string` | Yes | The composition name. |
| `palette` | `string` | Yes | JSON-encoded image-free MusicSession containing the effect palette and sound mappings. |
| `settings` | `string` | Yes | JSON-encoded listening settings. |
| `title` | `string` | Yes | Song title from plyr.fm. |
| `trackId` | `string` | No | The plyr.fm track identifier. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "An image-free Luminframe visualizer: a song reference and the effect palette that responds to it.",
      "key": "tid",
      "record": {
        "properties": {
          "artist": {
            "description": "Song artist from plyr.fm.",
            "maxGraphemes": 300,
            "maxLength": 3000,
            "type": "string"
          },
          "createdAt": {
            "description": "When the composition was published.",
            "format": "datetime",
            "type": "string"
          },
          "name": {
            "description": "The composition name.",
            "maxGraphemes": 300,
            "maxLength": 3000,
            "type": "string"
          },
          "palette": {
            "description": "JSON-encoded image-free MusicSession containing the effect palette and sound mappings.",
            "maxLength": 500000,
            "type": "string"
          },
          "settings": {
            "description": "JSON-encoded listening settings.",
            "maxLength": 10000,
            "type": "string"
          },
          "title": {
            "description": "Song title from plyr.fm.",
            "maxGraphemes": 300,
            "maxLength": 3000,
            "type": "string"
          },
          "trackId": {
            "description": "The plyr.fm track identifier.",
            "maxLength": 20,
            "type": "string"
          }
        },
        "required": [
          "name",
          "title",
          "artist",
          "settings",
          "palette",
          "createdAt"
        ],
        "type": "object"
      },
      "type": "record"
    }
  },
  "id": "com.luminframe.visualizer",
  "lexicon": 1
}
```