Class MediaChannelState

constructor

• new MediaChannelState(): MediaChannelState

  Returns MediaChannelState

ActiveItemId

ReadonlyChanged$

Items

ActiveItem

• get ActiveItem(): MediaItem | null

  The active item, or null when the surface is empty / the active id is stale.

  Returns MediaItem | null

AddItem

• AddItem(item: Omit<MediaItem, "Id"> & { Id?: string }): MediaItem

  Adds a media item, makes it active, and returns it.

  Parameters

  • item: Omit<MediaItem, "Id"> & { Id?: string }

  Returns MediaItem

Clear

• Clear(): void

  Removes all media and resets the active item.

  Returns void

Highlight

• Highlight(id: string, highlight: MediaHighlight | null): boolean

  Sets (or, with null, clears) the fractional highlight on id. No-op if the item is absent.

  Parameters

  • id: string
  • highlight: MediaHighlight | null

  Returns boolean

LoadFromJSON

• LoadFromJSON(json: string): boolean

  Rehydrates a prior session's saved state IN PLACE (preserving this instance + its Changed$ subscribers). Tolerant by contract: malformed / incompatible JSON is ignored and the method returns false without throwing, leaving the current state untouched.

  Parameters

  • json: string

  Returns boolean

RemoveItem

• RemoveItem(id: string): boolean

  Removes the item with id (no-op if absent). When it was active, the last remaining item becomes active.

  Parameters

  • id: string

  Returns boolean

RequestPlay

• RequestPlay(id: string): boolean

  Activates id and stamps a play request on it (the surface consumes the stamp to start video/audio playback). No-op if the item is absent.

  Parameters

  • id: string

  Returns boolean

SetActive

• SetActive(id: string): boolean

  Makes id the active item (no-op if absent).

  Parameters

  • id: string

  Returns boolean

ToJSON

• ToJSON(): string

  Serializes the state of record to a JSON string (persisted via the channel's RequestSave).

  Returns string