Result shapes

What the services of PlayerVox OverCrow answer: the shape of each result and of each subscription update. The SDK exports a TypeScript type of the same name for each shape, so the logic never describes them by hand.

declare module "@overcrow/sdk" {
  interface WidgetState {
    /** The latest state, or `null` while it is unknown. */
    stopwatch: Stopwatch | null;
    /** The buttons take input only in Interactive mode. */
    interactive: boolean;
  }
}

The Stopwatch widget keeps the latest Stopwatch value in its state, and the view reads its members:

      <elapsed class="value" base={state.stopwatch.elapsedMs} at={state.stopwatch.at} running={state.stopwatch.running} format="hh:mm:ss.cc"/>

How to read a shape

• A shape is an exact record: every member is present, and a member without a value is null, never absent.
• "text or null" means that the member may be null: test it before you show it.
• An integer is below 2^53, so it is exact in JavaScript. Times are in milliseconds: "Unix milliseconds" count from 1970 in UTC, as Date.now() does.
• A member that goes with offsetMinutes is a timestamp to format with that UTC offset; see time, dates and numbers.
• An asset: handle is an image that PlayerVox OverCrow holds for the widget: bind it to the src of an image or an avatar, or draw it on a canvas. It is not a URL and cannot be read as bytes.
• A subscription whose shape is "… or null" delivers null when there is nothing to show: no active game, no media player.

Which service gives which shape is in the service reference.

Shapes

HttpResponse

Answer of http.fetch. { status, contentType } or { status, asset }

GameEvent

One game event. { event, at }

Session

Duration of the active game session. { elapsedMs, at }

Telemetry

Resource use of the active game. { cpu, ram, cpuTemperature, gpuTemperature, sources }

Fps

Frame rate of the active game. { fps, stale, status }

Stopwatch

The manual stopwatch. { running, elapsedMs, at, shortcuts }

Media

The current media player. { player, title, artists, playing, canPrevious, canPlayPause, canNext, cover }

NoteItem

One checklist item. { id, text, checked }

Note

One note. { id, title, body, items }

Notes

The user's notes document. { active, notes }

CreatedNote

Answer of notes.create. { note }

Score

PlayerVox score of the active game. { state, name, score, grade, ratingsCount, criteria }

Rating

The user's PlayerVox rating of the active game. { gameplay, art, tech, review, publishedAt, offsetMinutes }

RatingState

The user's own rating of the active game, with its state. { state, name, offline, rating }

Review

One player review. { id, author, grade, score, text, original, hidden, publishedAt, offsetMinutes }

ReviewsState

The player reviews of the active game: what to read, not the reviews. { state, revision, offline }

ReviewsPage

A page of player reviews. { gameName, items, page, totalPages, count }

JournalSession

One journal session. { id, startedAt, offsetMinutes, durationMs, source }

JournalState

The journal of the active game. { revision, notice }

JournalPage

A page of the game journal. { gameName, items, page, next, previous }

ChatFragment

A text run or an emote of a chat message. { text } or { emote, alt }

ChatMessage

One chat message. { id, author, color, badges, fragments, reply, deleted, receivedAt }

TwitchChat

Twitch chat state. { account, channel, joinState, failure, favorites, canSend, generation, reset, messages, removed, skipped }