Player — Request Visual Viewport

In certain situations, the LiSA Player sends a message to request the visual viewport from the host app or environment. This typically occurs during UI transitions, such as entering floating player mode or when the virtual keyboard appears.

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

Properties

Along with all standard Message properties, a Request Visual Viewport 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:viewport:request
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.

---

Type Definition

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

---

Examples

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