ShowMessage

3min

Show messages describe specific actions in the live stream domain.
Message definition
The message target of a show message is show.
TypeScript
interface ShowMessage extends Message {
  readonly action: 'ready' | 'start' | 'stop';
  readonly additional: {
    /** The date of the current show in ISO 8601 format */
    showDate?: 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;
  };
  /** 
   * A map of key-value pairs with key being the product origin ID and
   * value being the LiSA internal product ID.
   */
  readonly products?: {
    [key: string]: UUID;
  };
  readonly target: 'show';
}
interface ShowMessage extends Message {
  readonly action: 'ready' | 'start' | 'stop';
  readonly additional: {
    /** The date of the current show in ISO 8601 format */
    showDate?: 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;
  };
  /** 
   * A map of key-value pairs with key being the product origin ID and
   * value being the LiSA internal product ID.
   */
  readonly products?: {
    [key: string]: UUID;
  };
  readonly target: 'show';
}
﻿
Message actions
LiSA accepts/exposes the following show actions:
Action
Description
Direction of communication
ready
The show view is initialized.
LiSA to X
start
The live stream started.
LiSA to X
stop
The live stream stopped.
LiSA to X
Examples
Listed below are examples for show message payloads.
JS
// LiSA notifies about a the current show being initialized.
const payload = {
  action: 'ready',
  additional: {
    showDate: '2013-06-21T06:30:00.000Z',
    showId: '8f6f7cc3-fc71-4d79-b131-add88c0233a7',
    showState: 'live',
    showTitle: 'Show title',
  },
  products: {
    'r2jf030': '63d0eed2-5751-4e4e-bfbc-af85bb48c7f1',
  }
  sender: 'LiSA',
  target: 'show',
};
// LiSA notifies about a the current show being initialized.
const payload = {
  action: 'ready',
  additional: {
    showDate: '2013-06-21T06:30:00.000Z',
    showId: '8f6f7cc3-fc71-4d79-b131-add88c0233a7',
    showState: 'live',
    showTitle: 'Show title',
  },
  products: {
    'r2jf030': '63d0eed2-5751-4e4e-bfbc-af85bb48c7f1',
  }
  sender: 'LiSA',
  target: 'show',
};
﻿
﻿

Action	Description	Direction of communication
ready	The show view is initialized.	LiSA to X
start	The live stream started.	LiSA to X
stop	The live stream stopped.	LiSA to X

Updated 25 Mar 2024

Did this page help you?

ShowHostMessage

UserMessage