Media — Resume

The Resume message can be both sent by the host app to control playback and sent by the player to reflect playback state changes,

Properties

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

Name
Type
Description

messageType

Literal

Required.

lsc:media:resume

Legacy Properties

Name
Type
Description

action

Literal

Required.

pause ⚠️ Please use messageType instead.

target

Literal

Required.

player ⚠️ Please use messageType instead.


Type Definition

interface MediaResumeMessage extends Omit<MediaMessage, 'messageType'> {
  messageType: 'lsc:media:resume';
}

Examples

Player Notifies Media Playback Has Been Resumed

{
  "clockDriftInMs": 0,
  "mediaItemId": "9f333331-45cb-4289-8bcd-9023c1871111",
  "mediaItemType": "live",
  "messageType": "lsc:media:resume",
  "progress": {
    "bufferedTimeInMs": 648036,
    "currentTimeInMs": 628008,
    "durationInMs": 4616000,
    "elapsedTimeInMs": 28784,
    "skipTimeInMs": 600000,
    "isLive": true,
    "visitorDwellTimeInMs": 29135,
    "isPlaying": true
  },
  "sender": "LiSA",
  
  "action": "resume",
  "target": "player"
}

Host App Triggers Media Playback Resumption

{
  "messageType": "lsc:media:pause",
  "recipient": "LiSA",
  
  "action": "resume",
  "target": "player"
}

Last updated