Skip to content
ForgeCastDocs

Past streams

The streams recorded on this PC and the week's numbers.

Functions

history.streams(query)

The streams recorded on this PC, newest first (without their curves).

Returns PastStream[]

history.stream(id)

One stream, with its viewers and chat curves (nil when there is no such stream).

  • id: string

Returns PastStream|nil

history.week()

The last 7 days added up, and the 7 days before (nil before any stream was recorded).

history.on(event, handler)

Listen for Event.StreamRecorded: a stream ended and was recorded.

  • event: string
  • handler: fun(s: PastStream)

Returns integer id

history.off(id)

Stop a handler made with history.on.

  • id: integer

Returns boolean found

Types

Open a type to see its fields; type names above link here.

On this page