place.stream.live.teleport

moderation.stream.place View official

Documentation

Record defining a 'teleport', that is active during a certain time.

main record

Record defining a 'teleport', that is active during a certain time.

Record Key tid Timestamp-based ID

Properties

durationSeconds integer Optional

The time limit in seconds for the teleport. If not set, the teleport is permanent. Must be at least 60 seconds, and no more than 32,400 seconds (9 hours).

minimum: 60maximum: 32400
livestream ref com.atproto.repo.strongRef Optional

The source livestream this teleport is sending viewers away from. When the teleport fires, this is the livestream that gets ended (the same update place.stream.live.stopLivestream performs), so the source streamer returns to pre-live. Teleports without an origin livestream are treated as a no-op.

startsAt string datetime Required

The time the teleport becomes active.

streamer string did Required

The DID of the streamer to teleport to.

View raw schema
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "streamer",
      "startsAt"
    ],
    "properties": {
      "startsAt": {
        "type": "string",
        "format": "datetime",
        "description": "The time the teleport becomes active."
      },
      "streamer": {
        "type": "string",
        "format": "did",
        "description": "The DID of the streamer to teleport to."
      },
      "livestream": {
        "ref": "com.atproto.repo.strongRef",
        "type": "ref",
        "description": "The source livestream this teleport is sending viewers away from. When the teleport fires, this is the livestream that gets ended (the same update place.stream.live.stopLivestream performs), so the source streamer returns to pre-live. Teleports without an origin livestream are treated as a no-op."
      },
      "durationSeconds": {
        "type": "integer",
        "maximum": 32400,
        "minimum": 60,
        "description": "The time limit in seconds for the teleport. If not set, the teleport is permanent. Must be at least 60 seconds, and no more than 32,400 seconds (9 hours)."
      }
    }
  },
  "description": "Record defining a 'teleport', that is active during a certain time."
}

Lexicon Garden

@