Docs menu

Live Stream

The Live Stream is the panel along the bottom of the workspace that lists the events your connections receive, as they arrive. Use it to see that data is flowing, and to read what came in.

Reading it

Each entry is one event. The newest is at the top, and older ones sit below it.

  • An entry names the connection it came from, once, and the time it arrived. Click it to read its details (see A record's details).
  • An event from an API Source names that source; an error is marked as one.
  • When nothing has arrived yet, the panel says No impulses have arrived yet. and that each message from your connected data shows there, newest first, with a Read more link to connecting data. It fills in as events come. While it is still connecting, or its connection is down, it says that instead.

The Live Stream keeps the newest 500 events. When more arrive, the oldest drop off the bottom.

A record's details

Click an entry and its details open in a details panel, floating over the workspace: its title names the record and its time, and below are the line that says where it came from and its full payload. The list itself does not change when you open a record.

  • Click another entry and the same details panel shows that record instead, so you can step through the stream one record at a time.
  • Pin (the pin button in the details panel's title bar) keeps that panel's record. The next entry you click opens a new details panel, so you can keep several records open side by side. Press the pin again to unpin it.
  • A details panel is a panel like any other: drag it to dock it, stack it or tab it, and close it with its close button when you are done.

Staying on live, and getting back to it

New events are added at the top, which would push what you are reading down the screen. They don't:

  • Scrolled down: the list holds your place. The entry you were reading stays where it was while new events keep arriving above it.
  • At the top: the list follows, and you see the newest event as it lands.

Nothing is paused. Events arrive the whole time, so when you scroll back to the top they are all there.

The "N new" button

While you are away from the top, a small button under the filter row tells you how many events have arrived since you left, for example 12 new. Press it (or Tab to it and press Enter or Space) and the list jumps to the newest event and follows new events again. Your details panels stay as they are. You can also get back by scrolling to the top.

  • The button shows only while you are scrolled away, and only once something new has arrived. At the top it is never shown.
  • The Live Stream keeps the newest 500 events. If more than that arrive while you are away, the button reads 500+ new and the oldest are no longer in the list.
  • Changing the connection menu or the filter box starts the count over for the new list.
  • A screen reader is told once, politely, that new events are waiting; the button's name carries the number.
  • The button counts only while the Live Stream is on screen. A browser tab left in the background has its own count, the line under When you were away.

When you were away

When the stream was away and events arrived meanwhile, one line shows under the filter row, with the connection menu and filter box above it:

27 messages arrived while you were away (since 10:02)

It reads "1 message arrived while you were away" for one. The time is when the away began, in your own locale's short form ("10:02 AM" or "10:02"). When the away began on an earlier day, the line adds the short date, for example "(since Oct 28, 10:02 AM)" or "(since 28 Oct, 10:02)"; an away that began today shows the time only. "Today" is your own day, in your own time zone. Away means one of two things:

  • The connection dropped or went quiet and came back. The Live Stream shows the newest messages at once and counts what arrived in the gap: those messages are counted, not listed.
  • The browser tab was in the background. What arrived while it was hidden is listed, the newest 500, and counted. If more than 500 arrived, the line adds "; the newest 500 are listed".

The line says nothing when nothing arrived: a short blip, or a hidden tab with nothing coming in, shows no line.

  • Dismiss, the button beside the line, hides it. The list does not change. Counts add up across returns until you press Dismiss, and Clear resets the count as well as the list.
  • A screen reader is told once, politely, when the line appears. A count that keeps growing is not read out again.

Filter and clear

Along the top of the list:

  • the connection menu, set to All Connections, shows one connection's events only;
  • the filter box keeps the entries whose subject, details or payload contain your text. When nothing matches, the panel says No impulses match the current filters.;
  • Clear empties the list. It is greyed out while the list is empty. New events keep arriving after you clear it.

Collapse or close it

Collapse in the Live Stream's menu folds its side down to a thin strip to give the rest room; the Expand Live Stream button on the strip opens it again. While it is collapsed the list stays connected but draws nothing, and it shows the newest events when it opens.

Close Live Stream, the button at the right of its title bar, closes it; View > Live Stream brings it back, floating at the right until you dock it. See Panels and Windows.

On this page