Adobe Analytics - Media Analytics for Audio and Video

🚨 Documentation has moved! 🚨
Documentation for Adobe Experience Platform Mobile SDKs now has a new home!
⚠️ This site will no longer be maintained ⚠️
Visit https://developer.adobe.com/client-sdks/ for the latest documentation.
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
1.In the Data Collection UI, select the Extensions tab.
2.On the Catalog tab, locate the Adobe Media Analytics for Audio and Video extension, and select Install.
3.Type the extension settings. For more information, see Configure Media Analytics Extension.
4.Select Save.
5.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 launch extension to v2.x in your launch 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 Launch property and make sure the extension is correctly configured.
Android
iOS (AEP 3.x)
iOS (ACP 2.x)
React Native
Latest Android SDK versions - ​
​ ​
​ ​
​​
1.Add the Media extension and its dependencies to your project using the app's Gradle file.
implementation 'com.adobe.marketing.mobile:sdk-core:1.+'
implementation 'com.adobe.marketing.mobile:analytics:1.+'
implementation 'com.adobe.marketing.mobile:media:2.+'
You can also manually include the libraries. Get .aar libraries from Github.
2.Import the Media extension in your application's main activity.
import com.adobe.marketing.mobile.*;
Latest iOS SDK versions - ​
​ ​
​ ​
​​
1.To add the Media library and its dependencies to your project, add the following pods to your Podfile:
pod 'AEPCore
pod 'AEPAnalytics
pod 'AEPMedia'
2.In Xcode project, import the Media extension:
Swift
import AEPMedia
import AEPCore
import AEPIdentity
import AEPAnalytics
Objective C
 @import AEPCore;
 @import AEPMedia;
 @import AEPAnalytics;
 @import AEPIdentity;
Latest iOS SDK versions - ​
​ ​
​ ​
​​
1.To add the Media library and its dependencies to your project, add the following pods to your Podfile:
pod 'ACPCore', '~> 2.0'
pod 'ACPAnalytics', '~> 2.0'
pod 'ACPMedia', '~> 2.0'
You can also manually include the libraries. Get .a libraries from Github.
1.In Xcode project, import the Media extension:
Swift
import ACPMedia
Objective C
 #import "ACPMedia.h"
JavaScript
Latest React Native Wrapper versions - ​
​ ​
​ ​
​​
1.Install Media.
   npm install @adobe/react-native-acpmedia
1.1 Link
React Native 0.60+
​CLI autolink feature links the module while building the app.
React Native <= 0.59
   react-native link @adobe/react-native-acpmedia
Note For iOS using cocoapods, run:
   cd ios/ && pod install
1.Import the extension.
 import {ACPMedia} from '@adobe/react-native-acpmedia';
2.Get the extension version.
 ACPMedia.extensionVersion().then(version => console.log("AdobeExperienceSDK: ACPMedia version: " + version));
Register Media with Mobile Core
Android
iOS (AEP 3.x)
iOS (ACP 2.x)
React Native
Java
To register media with Mobile Core, call the setApplication() method in onCreate() and call set up methods, as shown in this sample:
import com.adobe.marketing.mobile.*;
​
public class MobileApp extends Application {
​
  @Override
  public void onCreate() {
      super.onCreate();
      MobileCore.setApplication(this);
​
      try {
          Media.registerExtension();
          Analytics.registerExtension();
          Identity.registerExtension();
          MobileCore.start(new AdobeCallback () {
              @Override
              public void call(Object o) {
                  MobileCore.configureWithAppID("your-launch-app-id");
              }
          });
      } catch (InvalidInitException e) {
​
      }
  }
}
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")
 })  
 ...
}
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"];
  }];
  ...
}
Swift
In your app's _:didFinishLaunchingWithOptions function, register the Audience Manager extension with the Mobile Core:
import ACPCore
import ACPAnalytics
import ACPIdentity
import ACPMedia
​
func application(_ application: UIApplication,
                 didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    ACPCore.setLogLevel(.debug)
    ACPCore.configure(withAppId: "your-launch-app-id")
​
    ACPAnalytics.registerExtension()
    ACPIdentity.registerExtension()
    ACPMedia.registerExtension()
​
    ACPCore.start {
​
    }
​
    return true;
}
Objective-C
In your app's application:didFinishLaunchingWithOptions, register Media with Mobile Core:
#import "ACPCore.h"
#import "ACPAnalytics.h"
#import "ACPIdentity.h"
#import "ACPMedia.h"
​
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [ACPCore setLogLevel:ACPMobileLogLevelDebug];
    [ACPCore configureWithAppId:@"your-launch-app-id"];
​
    [ACPAnalytics registerExtension];
    [ACPIdentity registerExtension];
    [ACPMedia registerExtension];
​
    [ACPCore start:^{
​
    }];
​
    return YES;
  }
JavaScript
When using React Native, registering Media with Mobile Core should be done in native code which is shown under the Android and iOS tabs.
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
Platform Support
Platform
Support Status
Android
Supported
Apple iOS​
Supported
Apple tvOS​
Supported
React Native (iOS & Android)
Supported

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

Platform	Support Status
Android	Supported
Apple iOS	Supported
Apple tvOS	Supported
React Native (iOS & Android)	Supported

Mobile Services API reference

Migrating to AEPMedia reference

Last modified 2mo ago