Media Player Events

10min
To improve simplicity and readability, the subsequent examples of specific event types exclude the foundational properties inherited from the analytics and widget event.
All media player events extend the foundational properties inherited from the analytics event by including a mediaProgress property. This property provides contextual information inherent to the media playback of the current media item.
Name
Description
mediaProgress
Contextual information inherent to the media playback of the current media item.
Schema
Example
TypeScript
export type MediaPlayerEvent = AnalyticsEvent & {
  mediaProgress: {
    /**
     * Total duration of the media item, represented in milliseconds.
     *
     * `-1` for ongoing live media items.
     */
    durationInMs: number;
    /**
     * Elapsed time since start of the media item,
     * represented in milliseconds.
     */
    elapsedTimeInMs: number;
    /**
     * Indicator, whether the media item is streamed live.
     */
    isLive: boolean;
    /**
     * The total duration of time the visitor spent on the current
     * media items, including any paused segments.
     */
    visitorDwellTimeInMs: number;

    // Properties, specific to live shows.

    /**
     * Total duration of a segment in a multi-stream event.
     * `-1` for ongoing live segments.
     */
    segmentDurationInMs?: number;
    /**
     * Elapsed time since start of the segment,
     * represented in milliseconds.
     */
    segmentElapsedTimeInMs?: number;
    /**
     * The distinct identifier associated with the current segment's
     * stream.
     */
    streamId?: string;
    /**
     * The date when the current stream's segment started, represented
     * in ISO 8601 date-time format.
     */
    streamStartedAt: string;
  };
};
export type MediaPlayerEvent = AnalyticsEvent & {
  mediaProgress: {
    /**
     * Total duration of the media item, represented in milliseconds.
     *
     * `-1` for ongoing live media items.
     */
    durationInMs: number;
    /**
     * Elapsed time since start of the media item,
     * represented in milliseconds.
     */
    elapsedTimeInMs: number;
    /**
     * Indicator, whether the media item is streamed live.
     */
    isLive: boolean;
    /**
     * The total duration of time the visitor spent on the current
     * media items, including any paused segments.
     */
    visitorDwellTimeInMs: number;

    // Properties, specific to live shows.

    /**
     * Total duration of a segment in a multi-stream event.
     * `-1` for ongoing live segments.
     */
    segmentDurationInMs?: number;
    /**
     * Elapsed time since start of the segment,
     * represented in milliseconds.
     */
    segmentElapsedTimeInMs?: number;
    /**
     * The distinct identifier associated with the current segment's
     * stream.
     */
    streamId?: string;
    /**
     * The date when the current stream's segment started, represented
     * in ISO 8601 date-time format.
     */
    streamStartedAt: string;
  };
};
﻿
JSON
{
  "mediaProgress": {
    "durationInMs": 115000,
    "elapsedTimeInMs": 47231.12,
    "isLive": false,
    "visitorDwellTimeInMs": 63571.87,
  }
}
{
  "mediaProgress": {
    "durationInMs": 115000,
    "elapsedTimeInMs": 47231.12,
    "isLive": false,
    "visitorDwellTimeInMs": 63571.87,
  }
}
﻿
Media Player Event Types
lsc:player:cta-social-sharing-init
Sent when the visitor clicks the social sharing call-to-action (CTA), triggering the display of the social sharing modal.
lsc:player:dismiss
Sent when the visitor closes or dismisses the player. 
lsc:player:init
Sent when the player begins its initialization process.
lsc:player-media-complete
Sent when the media playback of the current media item has reached or exceeded 95% of its total duration.
lsc:player:media-init
Sent when the player initiates the initialization of a new media item.
lsc:player:media-pause
Sent when the media playback of the current media item is paused, either triggered by a visitor interaction or an external event such as a document visibilitychange event.
lsc:player:media-progress
Description bla bla
lsc:player:media-ready
Sent when the media content of the current media item has completed loading.
For video content, it signifies that the first streamable chunk of the video has been loaded. In case of static content, such as a high-resolution image, this indicates the image has finished loading. 
lsc:player:media-resume
Sent when the media playback of the current media item is resumed, either triggered by a visitor interaction or an external event such as a document visibilitychange event.
lsc:palyer:media-skip
Sent when the player skips to one of the following targets:
previousItem — The previous media item within a current playlist.
previousPlaylist — The previous playlist.
nextItem — The next media item within a playlist.
nextPlaylist — The next playlist.
SKIP events can be triggered either by visitor interaction or when the media playback of the current media item is completed.
lsc:player:media-start
Sent when the current media item begins playing, triggered either by a visitor interaction or media autoplay.
lsc:player:ready
Sent when the player completed its initialization process and finished rendering.
lsc:player:transition
Sent when the player switches its rendering mode.
Name	Description
mediaProgress	Contextual information inherent to the media playback of the current media item.
Updated 25 Mar 2024
Did this page help you?
Widget Events
Interaction Events