Media — Pause

The Pause message can be sent by the LiSA Player to indicate that playback has been paused or sent by the host app / environment to trigger a pause.

Properties

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

Name
Type
Description

messageType

Literal

Required.

lsc:media:pause

Legacy Properties

Name
Type
Description

action

Literal

Required.

pause ⚠️ Please use messageType instead.

target

Literal

Required.

player ⚠️ Please use messageType instead.


Type Definition

interface MediaPauseMessage extends Omit<MediaMessage, 'messageType'> {
  messageType: 'lsc:media:pause';
}

Examples

Player Notifies Media Playback Has Been Paused

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

Host App Triggers Media Playback Pause

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

Last updated