place.stream.livestream
Record announcing a livestream is happening
- class atproto_client.models.place.stream.livestream.ViewerCount
Bases:
ModelBaseDefinition model for
place.stream.livestream.- field count: int [Required]
Count.
- class atproto_client.models.place.stream.livestream.LivestreamView
Bases:
ModelBaseDefinition model for
place.stream.livestream.- field author: models.AppBskyActorDefs.ProfileViewBasic [Required]
Author.
- field cid: Cid [Required]
Cid.
- field indexed_at: DateTime [Required]
Indexed at.
- field record: UnknownType [Required]
Record.
- Constraints:
__module__ = atproto_client.models.unknown_union
__firstlineno__ = 72
__doc__ = Annotation for lexicon
unknownfields: any registered record type, elseDotDict. Record types are looked up in the runtime registry rather than in a union fixed at import time, so a record defined by a package generated from custom lexicons is decoded to its own model.__get_pydantic_core_schema__ = <bound method UnknownRecordFallback.__get_pydantic_core_schema__ of <class ‘atproto_client.models.unknown_union.UnknownRecordFallback’>>
__static_attributes__ = ()
__dict__ = {‘__module__’: ‘atproto_client.models.unknown_union’, ‘__firstlineno__’: 72, ‘__doc__’: ‘Annotation for lexicon
unknownfields: any registered record type, elseDotDict.nnRecord types are looked up in the runtime registry rather than in a union fixed at import time,nso a record defined by a package generated from custom lexicons is decoded to its own model.n’, ‘__get_pydantic_core_schema__’: <classmethod(<function UnknownRecordFallback.__get_pydantic_core_schema__ at 0x7bc6f7b3ce00>)>, ‘__static_attributes__’: (), ‘__dict__’: <attribute ‘__dict__’ of ‘UnknownRecordFallback’ objects>, ‘__weakref__’: <attribute ‘__weakref__’ of ‘UnknownRecordFallback’ objects>}__weakref__ = <attribute ‘__weakref__’ of ‘UnknownRecordFallback’ objects>
- field uri: AtUri [Required]
Uri.
- field viewer_count: models.PlaceStreamLivestream.ViewerCount | None = None
- class atproto_client.models.place.stream.livestream.TeleportArrival
Bases:
ModelBaseDefinition model for
place.stream.livestream.- field chat_profile: models.PlaceStreamChatProfile.Record | None = None
The chat profile of the source streamer.
- field source: models.AppBskyActorDefs.ProfileViewBasic [Required]
The streamer who is teleporting their viewers here.
- field starts_at: DateTime [Required]
When this teleport started.
- field teleport_uri: AtUri [Required]
The URI of the teleport record.
- field viewer_count: int [Required]
How many viewers are arriving from this teleport.
- class atproto_client.models.place.stream.livestream.TeleportCanceled
Bases:
ModelBaseDefinition model for
place.stream.livestream.- field reason: Literal['deleted', 'denied', 'expired'] [Required]
Why this teleport was canceled.
- field teleport_uri: AtUri [Required]
The URI of the teleport record that was canceled.
- class atproto_client.models.place.stream.livestream.StreamplaceAnything
Bases:
ModelBaseDefinition model for
place.stream.livestream.- field livestream: models.PlaceStreamLivestream.LivestreamView | models.PlaceStreamLivestream.ViewerCount | models.PlaceStreamLivestream.TeleportArrival | models.PlaceStreamLivestream.TeleportCanceled | models.PlaceStreamDefs.BlockView | models.PlaceStreamDefs.Renditions | models.PlaceStreamDefs.Rendition | models.PlaceStreamChatDefs.MessageView | models.PlaceStreamChatDefs.PinnedRecordView | DotDict [Required]
Livestream.
- Constraints:
__module__ = atproto_client.models.unknown_union
__firstlineno__ = 17
__doc__ = Annotation for open ref unions: an unrecognized
$typefalls back toDotDict. Applied tot.Union[<known members>, 'dot_dict.DotDictType']. Members are discriminated bypy_typeas usual, so a known type that fails validation still raises. Only a$typethat matches no member, or a missing one, degrades to aDotDict.__get_pydantic_core_schema__ = <bound method UnknownUnionFallback.__get_pydantic_core_schema__ of <class ‘atproto_client.models.unknown_union.UnknownUnionFallback’>>
__static_attributes__ = ()
__dict__ = {‘__module__’: ‘atproto_client.models.unknown_union’, ‘__firstlineno__’: 17, ‘__doc__’: “Annotation for open ref unions: an unrecognized
$typefalls back toDotDict.nnApplied tot.Union[<known members>, 'dot_dict.DotDictType']. Members are discriminated byn``py_type`` as usual, so a known type that fails validation still raises. Only a$typethatnmatches no member, or a missing one, degrades to aDotDict.n”, ‘__get_pydantic_core_schema__’: <classmethod(<function UnknownUnionFallback.__get_pydantic_core_schema__ at 0x7bc6f7b3ccc0>)>, ‘__static_attributes__’: (), ‘__dict__’: <attribute ‘__dict__’ of ‘UnknownUnionFallback’ objects>, ‘__weakref__’: <attribute ‘__weakref__’ of ‘UnknownUnionFallback’ objects>}__weakref__ = <attribute ‘__weakref__’ of ‘UnknownUnionFallback’ objects>
- class atproto_client.models.place.stream.livestream.NotificationSettings
Bases:
ModelBaseDefinition model for
place.stream.livestream.
- class atproto_client.models.place.stream.livestream.Record
Bases:
RecordModelBaseRecord model for
place.stream.livestream.- field activity: models.PlaceStreamDefs.ActivityGame | models.PlaceStreamDefs.ActivityLabel | DotDict | None = None
The game or activity being streamed.
- field created_at: DateTime [Required]
Client-declared timestamp when this livestream started.
- field notification_settings: models.PlaceStreamLivestream.NotificationSettings | None = None
- field post: models.ComAtprotoRepoStrongRef.Main | None = None
The post that announced this livestream.
- field title: str [Required]
The title of the livestream, as it will be announced to followers.
- Constraints:
max_length = 1400
- class atproto_client.models.place.stream.livestream.GetRecordResponse
Bases:
SugarResponseModelBaseGet record response for
models.PlaceStreamLivestream.Record.- field uri: str [Required]
The URI of the record.
- field value: models.PlaceStreamLivestream.Record [Required]
The record.
- class atproto_client.models.place.stream.livestream.ListRecordsResponse
Bases:
SugarResponseModelBaseList records response for
models.PlaceStreamLivestream.Record.- field records: Dict[str, models.PlaceStreamLivestream.Record] [Required]
Map of URIs to records.
- class atproto_client.models.place.stream.livestream.CreateRecordResponse
Bases:
SugarResponseModelBaseCreate record response for
models.PlaceStreamLivestream.Record.- field cid: str [Required]
The CID of the record.
- field uri: str [Required]
The URI of the record.