Adobe Analytics - Media Analytics for Audio and Video

Adobe Streaming Media for Edge Network extension is now available!

Refer to the Migrating to Media for Edge Network Guide and Media for Edge Network extension documentation to learn more about implementing Streaming Media using Adobe Experience Edge Network.

This extension requires the Adobe Analytics for Media add-on SKU. To learn more, contact your Adobe Customer Success Manager.

Configure Media Analytics extension in the Data Collection UI

In the Data Collection UI, select the Extensions tab.
On the Catalog tab, locate the Adobe Media Analytics for Audio and Video extension, and select Install.
Type the extension settings. For more information, see Configure Media Analytics Extension.
Select Save.
Follow the publishing process to update your SDK configuration.

Configure the Media Analytics extension

If you update the Adobe Media Analytics for Audio and Video tag extension to v2.x in your tag property, you must make sure to update and use AEP SDK Media extension v2.0.0 and higher.

Adobe Media Analytics Extension Configuration

To configure the Media Analytics extension, complete the following steps:

Collection API Server

Type the name of the media collection API server. This is the server where the downloaded media tracking data is sent. Important: You need to contact your Adobe account representative for this information.

Channel

Type the channel name property.

Player name

Type the name of the media player in use (for example, AVPlayer, Native Player, or Custom Player).

Application version

Type the version of the media player application/SDK.

Legacy settings should not be configured for Media Extension v2.x and higher. Those settings are only for backwards compatibility.

If you are using Media Extension v1.x, then go to Legacy settings section 1. Enable the Use Tracking Server checkbox. 2. In Tracking Server, Type the name of the tracking server to which all media tracking data should be sent.

Add Media Analytics to your app

This extension requires the Adobe Analytics extension. You must add the Analytics extension to your mobile property and make sure the extension is correctly configured.

Android

Add the Media extension and its dependencies to your project using the app's Gradle file.

Kotlin

implementation(platform("com.adobe.marketing.mobile:sdk-bom:3.+"))
implementation("com.adobe.marketing.mobile:core")
implementation("com.adobe.marketing.mobile:identity")
implementation("com.adobe.marketing.mobile:analytics")
implementation("com.adobe.marketing.mobile:media")
Copied to your clipboard
implementation(platform("com.adobe.marketing.mobile:sdk-bom:3.+"))
implementation("com.adobe.marketing.mobile:core")
implementation("com.adobe.marketing.mobile:identity")
implementation("com.adobe.marketing.mobile:analytics")
implementation("com.adobe.marketing.mobile:media")

Groovy

implementation platform('com.adobe.marketing.mobile:sdk-bom:3.+')
implementation 'com.adobe.marketing.mobile:core'
implementation 'com.adobe.marketing.mobile:identity'
implementation 'com.adobe.marketing.mobile:analytics'
implementation 'com.adobe.marketing.mobile:media'
Copied to your clipboard
implementation platform('com.adobe.marketing.mobile:sdk-bom:3.+')
implementation 'com.adobe.marketing.mobile:core'
implementation 'com.adobe.marketing.mobile:identity'
implementation 'com.adobe.marketing.mobile:analytics'
implementation 'com.adobe.marketing.mobile:media'

Using dynamic dependency versions is not recommended for production apps. Please read the managing Gradle dependencies guide for more information.

Import the libraries in your application's main activity.

Java

import com.adobe.marketing.mobile.MobileCore;
import com.adobe.marketing.mobile.Identity;
import com.adobe.marketing.mobile.Analytics;
import com.adobe.marketing.mobile.Media;
Copied to your clipboard
import com.adobe.marketing.mobile.MobileCore;
import com.adobe.marketing.mobile.Identity;
import com.adobe.marketing.mobile.Analytics;
import com.adobe.marketing.mobile.Media;

Kotlin

import com.adobe.marketing.mobile.MobileCore
import com.adobe.marketing.mobile.Identity
import com.adobe.marketing.mobile.Analytics
import com.adobe.marketing.mobile.Media
Copied to your clipboard
import com.adobe.marketing.mobile.MobileCore
import com.adobe.marketing.mobile.Identity
import com.adobe.marketing.mobile.Analytics
import com.adobe.marketing.mobile.Media

iOS

To add the Media library and its dependencies to your project, add the following pods to your Podfile:

pod 'AEPCore', '~> 5.0'
pod 'AEPAnalytics', '~> 5.0'
pod 'AEPMedia', '~> 5.0'
Copied to your clipboard
pod 'AEPCore', '~> 5.0'
pod 'AEPAnalytics', '~> 5.0'
pod 'AEPMedia', '~> 5.0'

In Xcode project, import the Media extension:

Swift

import AEPMedia
import AEPCore
import AEPIdentity
import AEPAnalytics
Copied to your clipboard
import AEPMedia
import AEPCore
import AEPIdentity
import AEPAnalytics

Objective-C

@import AEPCore;
@import AEPMedia;
@import AEPAnalytics;
@import AEPIdentity;
Copied to your clipboard
@import AEPCore;
@import AEPMedia;
@import AEPAnalytics;
@import AEPIdentity;

Add the Media extension and its dependencies to your project using the app's Gradle file.

Kotlin

implementation(platform("com.adobe.marketing.mobile:sdk-bom:3.+"))
implementation("com.adobe.marketing.mobile:core")
implementation("com.adobe.marketing.mobile:identity")
implementation("com.adobe.marketing.mobile:analytics")
implementation("com.adobe.marketing.mobile:media")
Copied to your clipboard
implementation(platform("com.adobe.marketing.mobile:sdk-bom:3.+"))
implementation("com.adobe.marketing.mobile:core")
implementation("com.adobe.marketing.mobile:identity")
implementation("com.adobe.marketing.mobile:analytics")
implementation("com.adobe.marketing.mobile:media")

Groovy

implementation platform('com.adobe.marketing.mobile:sdk-bom:3.+')
implementation 'com.adobe.marketing.mobile:core'
implementation 'com.adobe.marketing.mobile:identity'
implementation 'com.adobe.marketing.mobile:analytics'
implementation 'com.adobe.marketing.mobile:media'
Copied to your clipboard
implementation platform('com.adobe.marketing.mobile:sdk-bom:3.+')
implementation 'com.adobe.marketing.mobile:core'
implementation 'com.adobe.marketing.mobile:identity'
implementation 'com.adobe.marketing.mobile:analytics'
implementation 'com.adobe.marketing.mobile:media'

Using dynamic dependency versions is not recommended for production apps. Please read the managing Gradle dependencies guide for more information.

Import the libraries in your application's main activity.

Java

import com.adobe.marketing.mobile.MobileCore;
import com.adobe.marketing.mobile.Identity;
import com.adobe.marketing.mobile.Analytics;
import com.adobe.marketing.mobile.Media;
Copied to your clipboard
import com.adobe.marketing.mobile.MobileCore;
import com.adobe.marketing.mobile.Identity;
import com.adobe.marketing.mobile.Analytics;
import com.adobe.marketing.mobile.Media;

Kotlin

import com.adobe.marketing.mobile.MobileCore
import com.adobe.marketing.mobile.Identity
import com.adobe.marketing.mobile.Analytics
import com.adobe.marketing.mobile.Media
Copied to your clipboard
import com.adobe.marketing.mobile.MobileCore
import com.adobe.marketing.mobile.Identity
import com.adobe.marketing.mobile.Analytics
import com.adobe.marketing.mobile.Media

To add the Media library and its dependencies to your project, add the following pods to your Podfile:

pod 'AEPCore', '~> 5.0'
pod 'AEPAnalytics', '~> 5.0'
pod 'AEPMedia', '~> 5.0'
Copied to your clipboard
pod 'AEPCore', '~> 5.0'
pod 'AEPAnalytics', '~> 5.0'
pod 'AEPMedia', '~> 5.0'

In Xcode project, import the Media extension:

Swift

import AEPMedia
import AEPCore
import AEPIdentity
import AEPAnalytics
Copied to your clipboard
import AEPMedia
import AEPCore
import AEPIdentity
import AEPAnalytics

Objective-C

@import AEPCore;
@import AEPMedia;
@import AEPAnalytics;
@import AEPIdentity;
Copied to your clipboard
@import AEPCore;
@import AEPMedia;
@import AEPAnalytics;
@import AEPIdentity;

Register Media with Mobile Core

Android

To register Media with Mobile Core, import the Media library and register it:

Java

public class MainApp extends Application {
     private final String ENVIRONMENT_FILE_ID = "YOUR_APP_ENVIRONMENT_ID";

     @Override
     public void onCreate() {
         super.onCreate();

         MobileCore.setApplication(this);
         MobileCore.configureWithAppID(ENVIRONMENT_FILE_ID);

         List<Class<? extends Extension>> extensions = Arrays.asList(
                 Media.EXTENSION, Analytics.EXTENSION, Identity.EXTENSION);
         MobileCore.registerExtensions(extensions, o -> {
             Log.d(LOG_TAG, "AEP Mobile SDK is initialized");
         });
     }
 }
Copied to your clipboard
public class MainApp extends Application {
     private final String ENVIRONMENT_FILE_ID = "YOUR_APP_ENVIRONMENT_ID";

     @Override
     public void onCreate() {
         super.onCreate();

         MobileCore.setApplication(this);
         MobileCore.configureWithAppID(ENVIRONMENT_FILE_ID);

         List<Class<? extends Extension>> extensions = Arrays.asList(
                 Media.EXTENSION, Analytics.EXTENSION, Identity.EXTENSION);
         MobileCore.registerExtensions(extensions, o -> {
             Log.d(LOG_TAG, "AEP Mobile SDK is initialized");
         });
     }
 }

Kotlin

class MyApp : Application() {
    val ENVIRONMENT_FILE_ID = "YOUR_APP_ENVIRONMENT_ID"

    override fun onCreate() {
        super.onCreate()
        MobileCore.setApplication(this)
        MobileCore.configureWithAppID(ENVIRONMENT_FILE_ID)

        val extensions = listOf(Media.EXTENSION, Analytics.EXTENSION, Identity.EXTENSION)
        MobileCore.registerExtensions(extensions) {
            Log.d(LOG_TAG, "AEP Mobile SDK is initialized")
        }
    }
}
Copied to your clipboard
class MyApp : Application() {
    val ENVIRONMENT_FILE_ID = "YOUR_APP_ENVIRONMENT_ID"

    override fun onCreate() {
        super.onCreate()
        MobileCore.setApplication(this)
        MobileCore.configureWithAppID(ENVIRONMENT_FILE_ID)

        val extensions = listOf(Media.EXTENSION, Analytics.EXTENSION, Identity.EXTENSION)
        MobileCore.registerExtensions(extensions) {
            Log.d(LOG_TAG, "AEP Mobile SDK is initialized")
        }
    }
}

iOS

Swift

In your app's _:didFinishLaunchingWithOptions function, register the Audience Manager extension with the Mobile Core:

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
   MobileCore.registerExtensions([Media.self, Analytics.self, Identity.self], {
   MobileCore.configureWith(appId: "yourAppId")
 })
 ...
}
Copied to your clipboard
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
   MobileCore.registerExtensions([Media.self, Analytics.self, Identity.self], {
   MobileCore.configureWith(appId: "yourAppId")
 })
 ...
}

Objective-C

In your app's application:didFinishLaunchingWithOptions, register Media with Mobile Core:

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [AEPMobileCore registerExtensions:@[AEPMobileMedia.class, AEPMobileAnalytics.class, AEPMobileIdentity.class] completion:^{
    [AEPMobileCore configureWithAppId: @"yourAppId"];
  }];
  ...
}
Copied to your clipboard
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [AEPMobileCore registerExtensions:@[AEPMobileMedia.class, AEPMobileAnalytics.class, AEPMobileIdentity.class] completion:^{
    [AEPMobileCore configureWithAppId: @"yourAppId"];
  }];
  ...
}

To register Media with Mobile Core, import the Media library and register it:

Java

public class MainApp extends Application {
     private final String ENVIRONMENT_FILE_ID = "YOUR_APP_ENVIRONMENT_ID";

     @Override
     public void onCreate() {
         super.onCreate();

         MobileCore.setApplication(this);
         MobileCore.configureWithAppID(ENVIRONMENT_FILE_ID);

         List<Class<? extends Extension>> extensions = Arrays.asList(
                 Media.EXTENSION, Analytics.EXTENSION, Identity.EXTENSION);
         MobileCore.registerExtensions(extensions, o -> {
             Log.d(LOG_TAG, "AEP Mobile SDK is initialized");
         });
     }
 }
Copied to your clipboard
public class MainApp extends Application {
     private final String ENVIRONMENT_FILE_ID = "YOUR_APP_ENVIRONMENT_ID";

     @Override
     public void onCreate() {
         super.onCreate();

         MobileCore.setApplication(this);
         MobileCore.configureWithAppID(ENVIRONMENT_FILE_ID);

         List<Class<? extends Extension>> extensions = Arrays.asList(
                 Media.EXTENSION, Analytics.EXTENSION, Identity.EXTENSION);
         MobileCore.registerExtensions(extensions, o -> {
             Log.d(LOG_TAG, "AEP Mobile SDK is initialized");
         });
     }
 }

Kotlin

class MyApp : Application() {
    val ENVIRONMENT_FILE_ID = "YOUR_APP_ENVIRONMENT_ID"

    override fun onCreate() {
        super.onCreate()
        MobileCore.setApplication(this)
        MobileCore.configureWithAppID(ENVIRONMENT_FILE_ID)

        val extensions = listOf(Media.EXTENSION, Analytics.EXTENSION, Identity.EXTENSION)
        MobileCore.registerExtensions(extensions) {
            Log.d(LOG_TAG, "AEP Mobile SDK is initialized")
        }
    }
}
Copied to your clipboard
class MyApp : Application() {
    val ENVIRONMENT_FILE_ID = "YOUR_APP_ENVIRONMENT_ID"

    override fun onCreate() {
        super.onCreate()
        MobileCore.setApplication(this)
        MobileCore.configureWithAppID(ENVIRONMENT_FILE_ID)

        val extensions = listOf(Media.EXTENSION, Analytics.EXTENSION, Identity.EXTENSION)
        MobileCore.registerExtensions(extensions) {
            Log.d(LOG_TAG, "AEP Mobile SDK is initialized")
        }
    }
}

Swift

In your app's _:didFinishLaunchingWithOptions function, register the Audience Manager extension with the Mobile Core:

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
   MobileCore.registerExtensions([Media.self, Analytics.self, Identity.self], {
   MobileCore.configureWith(appId: "yourAppId")
 })
 ...
}
Copied to your clipboard
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
   MobileCore.registerExtensions([Media.self, Analytics.self, Identity.self], {
   MobileCore.configureWith(appId: "yourAppId")
 })
 ...
}

Objective-C

In your app's application:didFinishLaunchingWithOptions, register Media with Mobile Core:

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [AEPMobileCore registerExtensions:@[AEPMobileMedia.class, AEPMobileAnalytics.class, AEPMobileIdentity.class] completion:^{
    [AEPMobileCore configureWithAppId: @"yourAppId"];
  }];
  ...
}
Copied to your clipboard
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [AEPMobileCore registerExtensions:@[AEPMobileMedia.class, AEPMobileAnalytics.class, AEPMobileIdentity.class] completion:^{
    [AEPMobileCore configureWithAppId: @"yourAppId"];
  }];
  ...
}

Configuration keys

To update your SDK configuration programmatically, use the following information to change your Media configuration values. For more information, see Configuration API reference.

Key	Required	Description	Data Type
`media.collectionServer`	Yes	Media Collection Server endpoint to which all the media tracking data is sent. For more information, see Collection Server.	String
`media.channel`	No	Channel name. For more information, see Channel.	String
`media.playerName`	No	Name of the media player in use, i.e., "AVPlayer", "HTML5 Player", "My Custom Player". For more information, see Player Name.	String
`media.appVersion`	No	Version of the media player app/SDK. For more information, see Application Version.	String

Release notes

API reference

Was this helpful?

Yes

Adobe Analytics - Media Analytics for Audio and Video

Configure Media Analytics extension in the Data Collection UI.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Configure the Media Analytics extension

Collection API Server.css-jmmyhj{margin-left:var(--spectrum-global-dimension-size-50);}

Channel

Player name

Application version

Add Media Analytics to your app

Kotlin

Groovy

Java

Kotlin

Kotlin

Groovy

Java

Kotlin

Register Media with Mobile Core

Java

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

Configuration keys

Configure Media Analytics extension in the Data Collection UI

Collection API Server