PlayerMessage

4min

Player messages describe specific actions in the Player domain that are received from the context that LiSA is integrated in.
These type of messages are relevant if the context, that LiSA is integrated in, requires state information on the player such as a the current playback state and time.
Note: LiSA is ready to receive player messages once it sent the ready app message.
Message definition
The message target of a player message is player.
A user player contains a the playback state and the current playback time. If the player is not available (e.g. the show being in pre-show or post-show state), the current playback time is undefined.
TypeScript
interface PlayerMessage extends Message {
  readonly action: 'heartbeat' | 'start' | 'stop' | 'time';
  /** Indicator, whether the player is playing media */
  readonly playing: boolean;
  /** The current playback time in seconds */
  readonly time?: number;
  readonly target: 'player';
}
interface PlayerMessage extends Message {
  readonly action: 'heartbeat' | 'start' | 'stop' | 'time';
  /** Indicator, whether the player is playing media */
  readonly playing: boolean;
  /** The current playback time in seconds */
  readonly time?: number;
  readonly target: 'player';
}
﻿
Message actions
LiSA accepts/exposes the following player actions:
Action
Description
Direction of communication
heartbeat
A recurring message giving an update on the player progress.
LiSA to X
start
Message on playback being started. The start message is sent upon the start of a live show, or once a user starts the playback of a show replay.
LiSA to X
stop
Message on playback being stopped. The stop message is sent upon the end of a live show, or once a user stops/pauses the playback of a show replay.
LiSA to X
time
Request for (X to LiSA) or update on (LiSA to X) on the current playback time.
LiSA to X, X to LiSA
Examples
Listed below are examples for user message payloads.
JS
// The embedding context asks for the current playback time
const requestPayload = {
  action: 'time',
  recipient: 'LiSA',
  sender: 'Someone',
  target: 'player',
};

// LiSA responding with the current playback time
const responsePayload = {
  action: 'time',
  sender: 'LiSA',
  target: 'player',
  playing: true,
  time: 234,
};
// The embedding context asks for the current playback time
const requestPayload = {
  action: 'time',
  recipient: 'LiSA',
  sender: 'Someone',
  target: 'player',
};

// LiSA responding with the current playback time
const responsePayload = {
  action: 'time',
  sender: 'LiSA',
  target: 'player',
  playing: true,
  time: 234,
};
﻿
﻿

Action	Description	Direction of communication
heartbeat	A recurring message giving an update on the player progress.	LiSA to X
start	Message on playback being started. The start message is sent upon the start of a live show, or once a user starts the playback of a show replay.	LiSA to X
stop	Message on playback being stopped. The stop message is sent upon the end of a live show, or once a user stops/pauses the playback of a show replay.	LiSA to X
time	Request for (X to LiSA) or update on (LiSA to X) on the current playback time.	LiSA to X, X to LiSA

Updated 25 Mar 2024

Did this page help you?

LinkMessage

ShowEngagementMessage