Class Stream

Cast a kind 30311 event to a Stream (NIP-53)

Hierarchy (View Summary)

EventCast<KnownEvent<Helpers.kinds.LiveEvent>>
- Stream

Index

Constructors

Properties

Methods

Constructors

constructor

new Stream(event: NostrEvent, store: CastRefEventStore): Casts.Stream
Parameters
- event: NostrEvent
- store: CastRefEventStore
Returns Casts.Stream
Overrides EventCast.constructor
- Defined in common/src/casts/stream.ts:44

Properties

`Readonly`event

event: KnownEvent

`Readonly`store

store: CastRefEventStore

Accessors

author

get author(): User
Get the User that authored this event

Returns User
Inherited from EventCast.author
- Defined in common/src/casts/cast.ts:59

chat$

get chat$(): ChainableObservable<Casts.StreamChatMessage[]>
An observable of all chat messages for this stream

Returns ChainableObservable<Casts.StreamChatMessage[]>
- Defined in common/src/casts/stream.ts:111

createdAt

get createdAt(): Date
Returns Date
Inherited from EventCast.createdAt
- Defined in common/src/casts/cast.ts:54

endTime

get endTime(): number | undefined
Returns number | undefined
- Defined in common/src/casts/stream.ts:87

goal$

get goal$(): ChainableObservable<NostrEvent | undefined>
An observable of the goal event if this stream has a goal

Returns ChainableObservable<NostrEvent | undefined>
- Defined in common/src/casts/stream.ts:118

goalPointer

get goalPointer(): EventPointer | undefined
Returns EventPointer | undefined
- Defined in common/src/casts/stream.ts:66

hashtags

get hashtags(): string[]
Returns string[]
- Defined in common/src/casts/stream.ts:96

host

get host(): User
Returns User
- Defined in common/src/casts/stream.ts:60

id

get id(): string
Returns string
Inherited from EventCast.id
- Defined in common/src/casts/cast.ts:47

image

get image(): string | undefined
Returns string | undefined
- Defined in common/src/casts/stream.ts:54

maxViewers

get maxViewers(): number | undefined
Returns number | undefined
- Defined in common/src/casts/stream.ts:93

participants

get participants(): User[]
Returns User[]
- Defined in common/src/casts/stream.ts:63

recording

get recording(): string | undefined
Returns string | undefined
- Defined in common/src/casts/stream.ts:78

relays

get relays(): string[] | undefined
Returns string[] | undefined
- Defined in common/src/casts/stream.ts:81

seen

get seen(): Set<string> | undefined
Return the set of relays this event was seen on

Returns Set<string> | undefined
Inherited from EventCast.seen
- Defined in common/src/casts/cast.ts:64

shares$

get shares$(): ChainableObservable<Share[]>
Returns ChainableObservable<Share[]>
- Defined in common/src/casts/stream.ts:104

startTime

get startTime(): number | undefined
Returns number | undefined
- Defined in common/src/casts/stream.ts:84

status

get status(): StreamStatus
Returns StreamStatus
- Defined in common/src/casts/stream.ts:57

streamingAudio

get streamingAudio(): string[]
Returns string[]
- Defined in common/src/casts/stream.ts:75

streamingURLs

get streamingURLs(): string[]
Returns string[]
- Defined in common/src/casts/stream.ts:69

streamingVideos

get streamingVideos(): string[]
Returns string[]
- Defined in common/src/casts/stream.ts:72

summary

get summary(): string | undefined
Returns string | undefined
- Defined in common/src/casts/stream.ts:51

title

get title(): string | undefined
Returns string | undefined
- Defined in common/src/casts/stream.ts:48

uid

get uid(): string
Returns string
Inherited from EventCast.uid
- Defined in common/src/casts/cast.ts:50

viewers

get viewers(): number | undefined
Returns number | undefined
- Defined in common/src/casts/stream.ts:90

zaps$

get zaps$(): ChainableObservable<Casts.Zap[]>
An observable of all zaps on this stream

Returns ChainableObservable<Casts.Zap[]>
- Defined in common/src/casts/stream.ts:101

Methods

`Protected`$$ref

$$ref<Return extends unknown>(
key: string,
builder: (store: CastRefEventStore) => Observable<Return>,
): ChainableObservable<Return>
Internal method for creating a reference
Type Parameters
- Return extends unknown
Parameters
- key: string
- builder: (store: CastRefEventStore) => Observable<Return>
Returns ChainableObservable<Return>
Inherited from EventCast.$$ref
- Defined in common/src/casts/cast.ts:78