Shared Legacy Message Properties

This page defines common legacy schemas and properties used in multiple messages sent by the LiSA Player to the host app / environment. These shared properties ensure consistency and reduce redundancy across different message types. Each property follows a standardized structure to make integration more predictable and efficient.

Additional Data

The additional property is used in legacy messages and contains various metadata properties that were included in different combinations across older message formats.

• The structure and content of this property vary depending on the specific message.

• It is primarily maintained for backward compatibility with legacy implementations.

• New messages should avoid using additionalData and instead rely on explicitly defined properties.

Name	Type	Description
playing	Boolean Optional.	The playing property indicates, whether the current media item is playing or paused.
showDate	Date Optional.	The showDate property represents the scheduled date and time of the show. The value is typically in ISO 8601 format YYYY-MM-DDTHH:mm:ssZ
showId	String Optional.	The showId property uniquely identifies the Media Item (live or replay) from which this message originates.
showName	String Optional.	The showName property represents the internal show resource name.
showState	Enum Optional.	The showState property indicates the current state of the show. live – The show is currently being broadcast in real time. replay – The show has ended and is now available as a recorded playback.
showTitle	String Optional.	The showTitle property represents the title of the show, localized to the visitor's preferred language.
time	Number Optional.	The time property represents the current playback position of the media item, measured in milliseconds from the start. For on-demand content (e.g., replays, stories), this value indicates the exact position the user is watching. For live streams, this value represents the current timestamp relative to the live broadcast

interface AdditionalData {
  playing?: boolean;
  showDate?: string;
  showId?: string;
  showName?: string;
  showState?: 'live' | 'replay';
  showTitle?: string;
  time?: number;
}