DocumentationExperience PlatformData Collection

streamingMedia

Last update: Mon Jun 16 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer

The streamingMedia component helps you collect data related to media sessions on your website.

The collected data can include information about media playbacks, pauses, completions, and other related events. Once collected, you can send this data to Adobe Experience Platform or Adobe Analytics to generate reports. This feature provides a comprehensive solution for tracking and understanding media consumption behavior on your website.

Prerequisites

To use the streamingMedia component of the Web SDK, you must meet the following prerequisites:

  • Make sure that you have access to Adobe Experience Platform or Adobe Analytics.
  • You must use Web SDK version 2.20.0 or later. See the Web SDK installation overview to learn how to install the latest version.
  • Enable the Media Analytics option for the datastream you are using.
  • Ensure that the schema used by your datastream includes the Media Collection schema fields.
  • Configure the Streaming Media feature in the Web SDK, as shown on this page.

When calling the configure command, add the streamingMedia object.

alloy("configure", {
    streamingMedia: {
        channel: "Video channel",
        playerName: "Example player",
        appVersion: "Media Analytics with Web SDK 2.20.0",
        mainPingInterval: 10,
        adPingInterval: 10
    }
});
Property
Type
Required
Description
channel
String
Yes
The name of the channel where streaming media collection occurs. Example: Video channel.
playerName
String
Yes
The name of the media player.
appVersion
String
No
The version of the media player application.
mainPingInterval
Integer
No
Frequency of pings for main content, in seconds. The default value is 10. Values can range from 10 to 50 seconds. If no value is specified, the default value is used when using automatically-tracked sessions.
adPingInterval
Integer
No
Frequency of pings for ad content, in seconds. The default value is 10. Values can range from 1 to 10 seconds. If no value is specified, the default value is used when using automatically-tracked sessions.

Streaming media configuration using the Web SDK tag extension

These settings can be configured in the Web SDK tag extension using Streaming media configuration settings.

recommendation-more-help
1ae86b30-e55e-49c1-ab11-9d0356a5f3e1