ShowEngagementMessage

3min

Show engagement messages describe specific actions in the live stream domain related to user interactions.
Message definition
The message target of a show message is show.engage.
TypeScript
interface ShowEngagementMessage extends Message {
  readonly action:
    | 'chat-join'
    | 'chat-message'
    | 'add-to-calender'
    | 'social-share'
    | 'show-reaction';
  readonly additional: {
    /** The show asset URL */
    showAsset?: string;
    /** The date of the current show in ISO 8601 format */
    showDate?: string;
    /**
     * The description of the current show. The description value reflects either
     * the show's pre-show view teaser, if available, or the action show description.
     */
    showDescription?: string;
    /** The identifier of the current show */
    showId?: UUID;
    /** The current state of the current show */
    showState?: ShowState;
    /** The title of the current show */
    showTitle?: string;
    /** The URL of the current show */
    showUrl?: string;
    /** Indicator whether media is playing */
    playing?: boolean;
    /** The current player time of a live stream or replay */
    time?: number;
  };
  readonly target: 'show.engage';
  /** The current audience user */
  readonly user: {
    id: UUID;
    name: string;
    type: 'viewer';
  };
}
interface ShowEngagementMessage extends Message {
  readonly action:
    | 'chat-join'
    | 'chat-message'
    | 'add-to-calender'
    | 'social-share'
    | 'show-reaction';
  readonly additional: {
    /** The show asset URL */
    showAsset?: string;
    /** The date of the current show in ISO 8601 format */
    showDate?: string;
    /**
     * The description of the current show. The description value reflects either
     * the show's pre-show view teaser, if available, or the action show description.
     */
    showDescription?: string;
    /** The identifier of the current show */
    showId?: UUID;
    /** The current state of the current show */
    showState?: ShowState;
    /** The title of the current show */
    showTitle?: string;
    /** The URL of the current show */
    showUrl?: string;
    /** Indicator whether media is playing */
    playing?: boolean;
    /** The current player time of a live stream or replay */
    time?: number;
  };
  readonly target: 'show.engage';
  /** The current audience user */
  readonly user: {
    id: UUID;
    name: string;
    type: 'viewer';
  };
}
﻿
Message actions
LiSA accepts/exposes the following show actions:
Action
Description
Direction of communication
chat-join
The user clicked the social sharing CTA.
LiSA to X
The user joined the chat.
LiSA to X
chat-message
The user clicked the social sharing CTA.
LiSA to X
The user sent a chat message.
LiSA to X
add-to-calendar
The user clicked the "add to calendar" CTA.
LiSA to X
social-sharing
The user clicked the social sharing CTA.
LiSA to X
show-reaction
The user clicked the social sharing CTA.
LiSA to X
The user clicked the show reaction CTA.
LiSA to X
Examples
Listed below are examples for show message payloads.
JS
// LiSA notifies about a user interaction to add a show to calendar.
const payload = {
  action: 'add-to-calendar',
  additional: {
    showAsset: 'https://static.lisa-cdn.net/...',
    showDate: '2013-06-21T06:30:00.000Z',
    showDescription: '',
    showId: '8f6f7cc3-fc71-4d79-b131-add88c0233a7',
    showState: 'preShow',
    showTitle: 'Show title',
    showUrl: 
      'https://hello-lisa.com?lisa_autopplay=8f6f7cc3-fc71-4d79-b131-add88c0233a7',
  },
  sender: 'LiSA',
  target: 'show.engage',
};
// LiSA notifies about a user interaction to add a show to calendar.
const payload = {
  action: 'add-to-calendar',
  additional: {
    showAsset: 'https://static.lisa-cdn.net/...',
    showDate: '2013-06-21T06:30:00.000Z',
    showDescription: '',
    showId: '8f6f7cc3-fc71-4d79-b131-add88c0233a7',
    showState: 'preShow',
    showTitle: 'Show title',
    showUrl: 
      'https://hello-lisa.com?lisa_autopplay=8f6f7cc3-fc71-4d79-b131-add88c0233a7',
  },
  sender: 'LiSA',
  target: 'show.engage',
};
﻿
﻿

Action	Description	Direction of communication
chat-join The user clicked the social sharing CTA. LiSA to X	The user joined the chat.	LiSA to X
chat-message The user clicked the social sharing CTA. LiSA to X	The user sent a chat message.	LiSA to X
add-to-calendar	The user clicked the "add to calendar" CTA.	LiSA to X
social-sharing	The user clicked the social sharing CTA.	LiSA to X
show-reaction The user clicked the social sharing CTA. LiSA to X	The user clicked the show reaction CTA.	LiSA to X

Updated 25 Mar 2024

Did this page help you?

PlayerMessage

ShowHostMessage