Player — Dismiss

The LiSA Player sends a message when the dismiss CTA is clicked.

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

Properties

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

Name	Type	Description
mediaItemId	String Required.	The mediaItemId property uniquely identifies the Media Item from which this message originates.
mediaItemType	MediaItemType Required.	The mediaItemType property specifies the type of Media Item from which this message originates. Refer to MediaItemType for detailed information.
messageType	Literal Required.	lsc:player:dismiss
progress	MediaProgress Optional.	The progress property is an object that holds additional metadata related to the media playback progress of the current media item. Please refer to MediaProgress for detailed information.

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.	close ⚠️ Please use messageType instead.
target	Literal Required.	app ⚠️ Please use messageType instead.

---

Type Definition

interface PlayerDismissMessage extends Omit<
  Message,
  'messageType' | 'sender'
> {
  mediaItemId: string;
  mediaItemType: MediaItemType;
  messageType: 'lsc:player:dismiss';
  progress: MediaProgress;
  sender: 'LiSA';
}

---

Examples

{
  "clockDriftInMs": 0,
  "mediaItemId": "9f333331-45cb-4289-8bcd-9023c1871111",
  "mediaItemType": "live",
  "messageType": "lsc:player:dismiss",
  "progress": {
    "bufferedTimeInMs": 636036,
    "currentTimeInMs": 619609,
    "durationInMs": 4616000,
    "elapsedTimeInMs": 22761,
    "isLive": true,
    "isPlaying": true,
    "skipTimeInMs": 600000,
    "visitorDwellTimeInMs": 23882
  },
  "sender": "LiSA",
  
  "action": "close",
  "target": "app"
}