getting-started.md

Getting started

The Adobe Streaming Media for Edge Network extension has specific configuration requirements for including the Media Collection Details field group in the XDM schema and enabling Media Analytics in a datastream configuration. For more details, please refer to this guide to configure and set up Adobe Streaming Media for Edge Network.

Configure and install dependencies

The Adobe Streaming Media for Edge Network mobile extension has the following dependencies, which must be installed prior to installing the extension:

• AEPCore
• AEPEdge
• AEPEdgeIdentity

Configure Media for Edge Network extension in the Data Collection Tags

1. In the Data Collection Tags, select the Extensions tab in your mobile property.
2. On the Catalog tab, locate the Adobe Streaming Media for Edge Network extension, and select Install.
3. Type the extension settings for Channel, Player Name, and Application Version.
4. Select Save.
5. Follow the publishing process to update your SDK configuration.

Configuration keys

Optionally, the Media for Edge Network configuration may be set or changed programmatically.

Name	Key	Value	Required
Channel	"edgeMedia.channel"	String	Yes
Player Name	"edgeMedia.playerName"	String	Yes
Application Version	"edgeMedia.appVersion"	String	No

Swift

let mediaConfiguration = [String: Any]()
mediaConfiguration ["edgeMedia.channel"] = "<YOUR_CHANNEL_NAME>"
mediaConfiguration ["edgeMedia.playerName"] = "<YOUR_PLAYER_NAME>"
mediaConfiguration ["edgeMedia.appVersion"]  = "<YOUR_APP_VERSION>"
MobileCore.updateConfigurationWith(configDict: mediaConfiguration)

Objective-C

NSMutableDictionary* mediaConfiguration = [NSMutableDictionary dictionary];
config["edgeMedia.channel"] = @"<YOUR_CHANNEL_NAME>";
config["edgeMedia.playerName"] = @"<YOUR_PLAYER_NAME>";
config["edgeMedia.appVersion"] = @"<YOUR_APP_VERSION>";
[AEPMobileCore updateConfiguration:mediaConfiguration];

---

Add the Media for Edge Network extension to your app

Download AEPEdgeMedia extension

Note The following instructions are for setting up an application using Adobe Experience Platform Edge Network mobile extensions. If an application will include both Edge Network and Adobe Solution extensions, both the Identity for Edge Network and Identity for Experience Cloud ID Service extensions are required. For more details, see the Frequently Asked Questions page.

Add the AEPEdgeMedia and other dependency extensions to your project:

Note Try to use the latest extension versions to have access to all our latest features and fixes.

Using Cocoapods

1. Add following pods in your Podfile:

use_frameworks!
target 'YourTargetApp' do
   pod 'AEPCore'
   pod 'AEPEdge'
   pod 'AEPEdgeIdentity'
   pod 'AEPEdgeMedia'
end

2. Replace the target (YourTargetApp) with your actual app target name.

3. Install the pod dependencies by typing the following command in your Podfile directory:

$ pod install

Using Swift Package Manager

To add the AEPEdgeMedia Package to your application, from the Xcode menu select:

File > Add Packages...

Note The menu options may vary depending on the version of Xcode being used.

Enter the URL for the AEPMedia package repository: https://github.com/adobe/aepsdk-edgemedia-ios.git.

When prompted, input a specific version or a range of versions for Version rule.

Alternatively, if your project has a Package.swift file, you can add AEPEdgeMedia directly to your dependencies:

dependencies: [
  .package(url: "https://github.com/adobe/aepsdk-edge-ios.git", .upToNextMajor(from: "5.0.0")),
  .package(url: "https://github.com/adobe/aepsdk-edgeidentity-ios.git", .upToNextMajor(from: "5.0.0")),
  .package(url: "https://github.com/adobe/aepsdk-edgemedia-ios.git", .upToNextMajor(from: "5.0.0"))
]

Using binaries

Run make archive from the root directory to generate .xcframeworks for each module under the build folder. Drag and drop all .xcframeworks to your app target in Xcode.

---

Import the AEPEdgeMedia along with the dependencies and register the extensions with MobileCore:

Swift

// AppDelegate.swift
import AEPCore
import AEPEdge
import AEPEdgeIdentity
import AEPEdgeMedia

// AppDelegate.swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
  MobileCore.registerExtensions([Edge.self, Identity.self, Media.self], {
     MobileCore.configureWith(appId: "yourEnvironmentID")
      // Configure EdgeMedia extension
      let mediaConfiguration: [String: Any] = [
                                                "edgeMedia.channel": "<YOUR_CHANNEL_NAME>", 
                                                "edgeMedia.playerName": "<YOUR_PLAYER_NAME>", 
                                                "edgeMedia.appVersion": "<YOUR_APP_VERSION>"
                                              ]
      MobileCore.updateConfigurationWith(configDict: mediaConfiguration)
   })
   ...
}

Objective-C

// AppDelegate.h
@import AEPCore;
@import AEPEdge;
@import AEPEdgeIdentity;
@import AEPEdgeMedia;

// AppDelegate.m
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [AEPMobileCore registerExtensions:@[AEPMobileEdge.class, AEPMobileEdgeIdentity.class, AEPMobileEdgeMedia.class] completion:^{
    ...
  }];
  [AEPMobileCore configureWithAppId: @"yourEnvironmentID"];
  ...
}