App — Listen

The LiSA Player dispatches a Listen message upon initialization to indicate its readiness for communication with the host app or environment.

The host app or environment must wait for the Listen message before sending any messages to the LiSA Player. Otherwise, the player may not receive them.

This message is sent by the LiSA Player to the host app / environment.

Properties

Along with all standard Message properties, a Listen message includes the following additional properties:

Name	Type	Description
messageType	Literal Required.	lsc:app:listen

Legacy Properties

If your integration uses LiSA Player Version 1, none of the properties described above will be available.

For LiSA Player Version 2, legacy properties can be ignored.

Name	Type	Description
action	Literal Required.	ready ⚠️ Please use messageType instead.
target	Literal Required.	app ⚠️ Please use messageType instead.

---

Type Definition

interface AppListenMessage extends Omit<
  Message,
  'messageType' | 'sender'
> {
  messageType: 'lsc:app:listen';
  sender: 'LiSA';
}

---

Examples

{
  "clockDriftInMs": 0,
  "messageType": "lsc:app:listen",
  "sender": "LiSA",
  
  "action": "ready",
  "target": "app"
}