Media — Progress
The LiSA Player regularly sends a media progress message to report the current playback status and track visitor dwell time.
Properties
Along with all standard Media Message properties, a Progress message includes the following additional properties:
messageType
Literal
Required.
lsc:media:progress
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.
action
Literal
Required.
time
⚠️ Please use messageType
instead.
playing
Boolean
Required.
The playing
property indicates, whether the current media item is playing or paused.
⚠️ Please use progress.isPlaying
instead.
target
Literal
Required.
player
⚠️ Please use messageType
instead.
time
Number
Optional.
The time
property represents the current playback position of the media item, measured in seconds from the start.
For live streams, this value represents the current timestamp relative to the live broadcast
For on-demand content (e.g., replays, stories), this value indicates the exact position the user is watching.
⚠️ Please use progress.currentTimeInMs
instead.
Type Definition
interface MediaProgressMessage extends Omit<MediaMessage, 'messageType'> {
messageType: 'lsc:media:progress';
}
Examples
{
"clockDriftInMs": 0,
"mediaItemId": "9f333331-45cb-4289-8bcd-9023c1871111",
"mediaItemType": "live",
"messageType": "lsc:media:progress",
"progress": {
"bufferedTimeInMs": 648036,
"currentTimeInMs": 628008,
"durationInMs": 4616000,
"elapsedTimeInMs": 28784,
"skipTimeInMs": 600000,
"isLive": true,
"visitorDwellTimeInMs": 29135,
"isPlaying": true
},
"sender": "LiSA",
"action": "time",
"playing": true,
"target": "player",
"time": 628
}
Last updated