Player — Native Picture-in-Picture (PiP)
The LiSA Player sends a message when the native Picture-in-Picture window is entered or left.
This message is sent by the LiSA Player to the host app / environment.
Properties
Along with all standard Message properties, a Native PiP message includes the following additional properties:
isEnabled
Boolean
Required.
The isEnabled
property indicates, whether the native Picture-in-Picture window is engaged.
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:native-pip
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 PlayerDismissMessage extends Omit<
Message,
'messageType' | 'sender'
> {
isEnabled: boolean;
mediaItemId: string;
mediaItemType: MediaItemType;
messageType: 'lsc:player:native-pip';
progress: MediaProgress;
sender: 'LiSA';
}
Examples
{
"clockDriftInMs": 0,
"isEnabled": true,
"mediaItemId": "9f333331-45cb-4289-8bcd-9023c1871111",
"mediaItemType": "live",
"messageType": "lsc:player:native-pip",
"progress": {
"bufferedTimeInMs": 636036,
"currentTimeInMs": 619609,
"durationInMs": 4616000,
"elapsedTimeInMs": 22761,
"isLive": true,
"isPlaying": true,
"skipTimeInMs": 600000,
"visitorDwellTimeInMs": 23882
},
"sender": "LiSA"
}
Last updated