Comments — Join

The LiSA Player generates a message whenever a visitor joins the chat in a live stream.

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

Properties

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

Name	Type	Description
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:comments:audience:join
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.
visitorAvatarUrl	String Optional.	The visitorAvatarUrl property is used to provide a URL pointing to an image that represents the visitor's avatar.
visitorExternalId	String Optional.	The visitorExternalId property specifies the visitor's ID as provided in the Pass User Context message.
visitorName	String Required.	The visitorName property represents the visitor's display name. If provided in the Pass User Context message, it reflects the name assigned by the host app. If not included, it contains the username the visitor chose when joining the chat.

Legacy Properties

If your integration uses LiSA Player Version 1, none of the properties described above will be available.

For LiSA Player Version 2, legacy properties can be ignored.

Name	Type	Description
action	String Required.	chat-join ⚠️ Please use messageType instead.
target	Literal Required.	show.engage ⚠️ Please use messageType instead.
user	User Required.	The user property specifies the essential user properties. Please refer to User for detailed information. ⚠️ Please use visitor* properties instead.

---

Type Definition

interface CommentsJoinMessage extends Omit<
  Message,
  'messageType' | 'sender'
> {
  mediaItemId: string;
  mediaItemType: MediaItemType;
  messageType: 'lsc:cart:view';
  progress: MediaProgress;
  visitorAvatarUrl?: string;
  visitorExternalId?: string;
  visitorName: string;
}

User

Name	Type	Description
id	String Required.	The visitorExternalId property specifies the visitor's ID as provided in the Pass User Context message.
name	Literal Required.	The visitorName property represents the visitor's display name. If provided in the Pass User Context message, it reflects the name assigned by the host app. If not included, it contains the username the visitor chose when joining the chat.
type	Literal Required.	viewer

interface User {
  id: string;
  name: string;
  type: 'viewer';
}

---

Examples

{
  "clockDriftInMs": 0,
  "mediaItemId": "9f333331-45cb-4289-8bcd-9023c1871111",
  "mediaItemType": "live",
  "messageType": "lsc:comments:audience:join",
  "progress": {
    "bufferedTimeInMs": 636036,
    "currentTimeInMs": 619609,
    "durationInMs": 4616000,
    "elapsedTimeInMs": 22761,
    "isLive": true,
    "isPlaying": true,
    "skipTimeInMs": 600000,
    "visitorDwellTimeInMs": 23882
  },
  "sender": "LiSA",
  "visitorAvatarUrl": "https://my-cdn.com/path/to/image.jpg",
  "visitorExternalId": "65cf573a-8c51-4b89-b2da-3d79b35fcf1b",
  "visitorName": "Jane Doe",
  
  "action": "chat-join",
  "target": "show.engage",
  "user": {
    "id": "65cf573a-8c51-4b89-b2da-3d79b35fcf1b",
    "name": "Jane Doe"
    "type": "viewer"
  }
}