place.stream.livestream

#main

Properties

Record announcing a livestream is happening

Use com.atproto.repo.createRecord to create a record.

Property	Type	Known Values	Required	Description
url	string (uri)	-	❌	The URL where this stream can be found. This is primarily a hint for other Streamplace nodes to locate and replicate the stream.
post	com.atproto.repo.strongRef	-	❌	-
tags	array of string	-	❌	Freeform tags for this stream. Each tag must be alphanumeric (a-z, A-Z, 0-9) plus colon. Tags with colons indicate a specific tag group (e.g. 'lang:en' indicates the stream's primary language).
agent	string	-	❌	The source of the livestream, if available, in a User Agent format: <product> / <product-version> <comment> e.g. Streamplace/0.7.5 iOS
thumb	blob	-	❌	-
title	string	-	✅	The title of the livestream, as it will be announced to followers.
endedAt	string (datetime)	-	❌	Client-declared timestamp when this livestream ended. Ended livestreams are not supposed to start up again.
activity	union of place.stream.defs#activityGame place.stream.defs#activityLabel	-	❌	-
createdAt	string (datetime)	-	✅	Client-declared timestamp when this livestream started.
lastSeenAt	string (datetime)	-	❌	Client-declared timestamp when this livestream was last seen by the Streamplace station.
canonicalUrl	string (uri)	-	❌	The primary URL where this livestream can be viewed, if available.
idleTimeoutSeconds	integer	-	❌	Time in seconds after which this livestream should be automatically ended if idle. Zero means no timeout.
notificationSettings	place.stream.livestream#notificationSettings	-	❌	-

Output

Property	Type	Known Values	Required	Description
ref	com.atproto.repo.strongRef	-	✅	-

#viewerCount

Property	Type	Known Values	Required	Description
count	integer	-	✅	-

#livestreamView

Property	Type	Known Values	Required	Description
cid	string (cid)	-	✅	-
uri	string (at-uri)	-	✅	-
author	app.bsky.actor.defs#profileViewBasic	-	✅	-
record	unknown	-	✅	-
indexedAt	string (datetime)	-	✅	-
viewerCount	#viewerCount	-	❌	-

#teleportArrival

Property	Type	Known Values	Required	Description
source	app.bsky.actor.defs#profileViewBasic	-	✅	-
startsAt	string (datetime)	-	✅	When this teleport started
chatProfile	place.stream.chat.profile	-	❌	-
teleportUri	string (at-uri)	-	✅	The URI of the teleport record
viewerCount	integer	-	✅	How many viewers are arriving from this teleport

#teleportCanceled

Property	Type	Known Values	Required	Description
reason	string	-	✅	Why this teleport was canceled
teleportUri	string (at-uri)	-	✅	The URI of the teleport record that was canceled

#streamplaceAnything

Property	Type	Known Values	Required	Description
livestream	union of #livestreamView #viewerCount #teleportArrival #teleportCanceled place.stream.defs#blockView place.stream.defs#renditions place.stream.defs#rendition place.stream.chat.defs#messageView place.stream.chat.defs#pinnedRecordView	-	✅	-

#notificationSettings

Property	Type	Known Values	Required	Description
pushNotification	boolean	-	❌	Whether this livestream should trigger a push notification to followers.