# 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.

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

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.hello-lisa.com/developers/guides/player-communication/message-api-reference/shared-legacy-message-properties.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
