CTA

When a Call-to-Action (CTA) is clicked in the LiSA Player, a message is sent containing detailed information about the CTA intent and any relevant auxiliary data.

The player distinguishes different types of CTAs.

• calendar — Add to Calendar

• comment — Link in Comments

• countdown — Live Stream Countdown View

• feedback — Live Stream Feedback View

• poll — Poll

• share — Social Sharing

• sponsor — Sponsor Badge

This message is sent by the LiSA Player to the host app / environment.

Properties

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

Name	Type	Description
auxiliaryData	AuxiliaryData Required.	The auxiliaryData property is an object that holds additional metadata related to a Call-to-Action. The structure and contents of this object vary depending on the specific type of CTA being used. Please refer to AuxiliaryData for detailed information.
ctaType	CtaType Required.	The ctaType property specifies the distinct type of a CTA. Refer to CtaType for detailed information.
mediaItemId	string Required.	The mediaItemId property uniquely identifies the Media Item from which this message originates.
mediaItemType	MediaItemType Required.	The mediaItemType property specifies the type of Media Item from which this message originates. Refer to MediaItemType for detailed information.
messageType	Literal Required.	lsc:cta:click
progress	MediaProgress Required.	The progress property is an object that holds additional metadata related to the media playback progress of the current media item. Please refer to MediaProgress for detailed information.

---

Type Definition

interface CtaMessage extends Omit<
  Message,
  'messageType' | 'sender'
> {
  auxiliaryData: AuxiliaryData;
  ctaType: CtaType;
  mediaItemId: string;
  mediaItemType: MediaItemType;
  messageType: 'lsc:cta:click';
  progress: MediaProgress;
  sender: 'LiSA';
}

---

AuxiliaryData

interface AuxiliaryData {
  [key: string]: unknown; // Properties vary based on CTA type
}

CtaType

type CtaType = 
  | 'calendar'
  | 'comment'
  | 'countdown'
  | 'feedback'
  | 'poll'
  | 'share'
  | 'sponsor';