# to.atpota.poe.scene

> Published by [atpota.to](https://lexicon.garden/identity/did:plc:qntsxa2i4sb24noi45fx4np2)

✓ This is the authoritative definition for this NSID.

## Description

One of the full-screen screens of Poe's stream overlay (atpota.to/overlay?scene=<record key>): a countdown before a stream, a be-right-back screen, an end screen, or a frame for sharing a screen with a camera. A streamer can keep as many as they like, one record each; the record key is the screen's id in its URL (lowercase letters, digits and dashes). The ones a streamer starts with are keyed by their kind: "starting", "brb", "ending", "screenshare", "loading" and "clock". The overlay reads it from your repo and follows changes live.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:qntsxa2i4sb24noi45fx4np2/to.atpota.poe.scene)
- [Documentation](https://lexicon.garden/lexicon/did:plc:qntsxa2i4sb24noi45fx4np2/to.atpota.poe.scene/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:qntsxa2i4sb24noi45fx4np2/to.atpota.poe.scene/examples)

## Definitions

### `to.atpota.poe.scene#camera`

**Type**: `object`

The screen share's camera window.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `shape` | `string` | Yes |  |
| `side` | `string` | Yes |  |

### `to.atpota.poe.scene#countdown`

**Type**: `object`

The starting screen's countdown: to a time, or a timer that starts when the scene is shown.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `at` | `string` (datetime) | No | For a clock: when the stream starts. |
| `minutes` | `integer` | No | For a timer. |
| `mode` | `string` | Yes |  |

### `to.atpota.poe.scene`

**Type**: `record`

**Key**: `any`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `background` | `string` | No | The sky behind it all (the screen share's frame colour). |
| `camera` | `ref` → `#camera` | No |  |
| `countdown` | `ref` → `#countdown` | No |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `ground` | `string` | No | What's along the bottom: a meadow hill with flowers, a strip of grass, soil with sprouts, or nothing. |
| `kind` | `string` | No | Which sort of screen it is (loading: Anisota's loading screen, its brand mark with the moon running through its phases, on black; clock: a waiting screen with the time ticking as an atproto TID). Without it, the record key's kind, or starting. |
| `links` | `array` | No | Where to find the streamer, on the end screen ("bsky.app/profile/dame.is"). |
| `name` | `string` | No | What the streamer calls this screen ("coding brb"), on the setup page only. |
| `showPoe` | `boolean` | No |  |
| `showWidgets` | `boolean` | No | Whether the weather widgets from the overlay's settings show on this scene too. |
| `subtitle` | `string` | No | A line under them: what the stream is about. |
| `title` | `string` | No | The big words ("starting soon"). |
| `updatedAt` | `string` (datetime) | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "camera": {
      "description": "The screen share's camera window.",
      "properties": {
        "shape": {
          "knownValues": [
            "rounded",
            "circle",
            "wide"
          ],
          "type": "string"
        },
        "side": {
          "knownValues": [
            "right",
            "left",
            "none"
          ],
          "type": "string"
        }
      },
      "required": [
        "side",
        "shape"
      ],
      "type": "object"
    },
    "countdown": {
      "description": "The starting screen's countdown: to a time, or a timer that starts when the scene is shown.",
      "properties": {
        "at": {
          "description": "For a clock: when the stream starts.",
          "format": "datetime",
          "type": "string"
        },
        "minutes": {
          "description": "For a timer.",
          "maximum": 120,
          "minimum": 1,
          "type": "integer"
        },
        "mode": {
          "knownValues": [
            "timer",
            "clock",
            "none"
          ],
          "type": "string"
        }
      },
      "required": [
        "mode"
      ],
      "type": "object"
    },
    "main": {
      "key": "any",
      "record": {
        "properties": {
          "background": {
            "description": "The sky behind it all (the screen share's frame colour).",
            "knownValues": [
              "day",
              "night",
              "garden",
              "butter"
            ],
            "type": "string"
          },
          "camera": {
            "ref": "#camera",
            "type": "ref"
          },
          "countdown": {
            "ref": "#countdown",
            "type": "ref"
          },
          "createdAt": {
            "format": "datetime",
            "type": "string"
          },
          "ground": {
            "description": "What's along the bottom: a meadow hill with flowers, a strip of grass, soil with sprouts, or nothing.",
            "knownValues": [
              "meadow",
              "grass",
              "soil",
              "none"
            ],
            "type": "string"
          },
          "kind": {
            "description": "Which sort of screen it is (loading: Anisota's loading screen, its brand mark with the moon running through its phases, on black; clock: a waiting screen with the time ticking as an atproto TID). Without it, the record key's kind, or starting.",
            "knownValues": [
              "starting",
              "brb",
              "ending",
              "screenshare",
              "loading",
              "clock"
            ],
            "type": "string"
          },
          "links": {
            "description": "Where to find the streamer, on the end screen (\"bsky.app/profile/dame.is\").",
            "items": {
              "maxGraphemes": 60,
              "maxLength": 300,
              "type": "string"
            },
            "maxLength": 4,
            "type": "array"
          },
          "name": {
            "description": "What the streamer calls this screen (\"coding brb\"), on the setup page only.",
            "maxGraphemes": 40,
            "maxLength": 200,
            "type": "string"
          },
          "showPoe": {
            "type": "boolean"
          },
          "showWidgets": {
            "description": "Whether the weather widgets from the overlay's settings show on this scene too.",
            "type": "boolean"
          },
          "subtitle": {
            "description": "A line under them: what the stream is about.",
            "maxGraphemes": 200,
            "maxLength": 1000,
            "type": "string"
          },
          "title": {
            "description": "The big words (\"starting soon\").",
            "maxGraphemes": 80,
            "maxLength": 400,
            "type": "string"
          },
          "updatedAt": {
            "format": "datetime",
            "type": "string"
          }
        },
        "required": [
          "createdAt",
          "updatedAt"
        ],
        "type": "object"
      },
      "type": "record"
    }
  },
  "description": "One of the full-screen screens of Poe's stream overlay (atpota.to/overlay?scene=<record key>): a countdown before a stream, a be-right-back screen, an end screen, or a frame for sharing a screen with a camera. A streamer can keep as many as they like, one record each; the record key is the screen's id in its URL (lowercase letters, digits and dashes). The ones a streamer starts with are keyed by their kind: \"starting\", \"brb\", \"ending\", \"screenshare\", \"loading\" and \"clock\". The overlay reads it from your repo and follows changes live.",
  "id": "to.atpota.poe.scene",
  "lexicon": 1
}
```