streamingMedia
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 and/or Adobe Analytics, to generate reports. This feature provides a comprehensive solution for tracking and understanding media consumption behavior on your website.
To use the streamingMedia
component of Web SDK, you must meet the following prerequisites:
To configure streaming media in the Web SDK tag extension, follow the steps below.
To configure streaming media in Web SDK, use the properties described below.
When calling the configure
command, add the streamingMedia
object.
alloy("configure", {
streamingMedia: {
channel: "video channel",
playerName: "test 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. |