diff --git a/AEPEdgeMedia.podspec b/AEPEdgeMedia.podspec index b5f1347..26b7c9c 100644 --- a/AEPEdgeMedia.podspec +++ b/AEPEdgeMedia.podspec @@ -1,10 +1,10 @@ Pod::Spec.new do |s| s.name = "AEPEdgeMedia" s.version = "4.0.0" - s.summary = "Experience Platform Edge Media extension for Adobe Experience Platform Mobile SDK. Written and maintained by Adobe." + s.summary = "Adobe Streaming Media for Edge Network extension for Adobe Experience Platform Mobile SDK. Written and maintained by Adobe." s.description = <<-DESC - The Experience Platform Edge Media extension enables handling Media Analytics using Adobe Edge Network. + Adobe Streaming Media for Edge Network extension extension sends data about audio and video consumption on your streaming applications to the Adobe Experience Platform Edge Network. DESC s.homepage = "https://github.com/adobe/aepsdk-edgemedia-ios.git" diff --git a/Documentation/README.md b/Documentation/README.md new file mode 100644 index 0000000..285b42a --- /dev/null +++ b/Documentation/README.md @@ -0,0 +1,6 @@ +# Adobe Streaming Media for Edge Network Extension Documentation + +## Contents +- [Getting started](getting-started.md) +- [API reference](api-reference.md) +- [Migration guide from Media Analytics](migration-guide.md) diff --git a/Documentation/api-reference.md b/Documentation/api-reference.md index 3dee8c5..144e17c 100644 --- a/Documentation/api-reference.md +++ b/Documentation/api-reference.md @@ -1,4 +1,4 @@ -# Adobe Experience Platform Media for Edge Network Extension - iOS +# Adobe Streaming Media for Edge Network extension - iOS ## Prerequisites @@ -9,7 +9,7 @@ To set up the extension and start using these APIs, see the [Getting Started Gui | APIs | | ----------------------------------------------------- | | [extensionVersion](#extensionVersion) | -| [registerExtension](#registerExtension) | +| [registerExtensions](#registerExtensions) | | [createTracker](#createTracker) | | [createTrackerWithConfig](#createTrackerWithConfig) | | [createMediaObjectWith](#createMediaObjectWith) | @@ -64,7 +64,7 @@ NSString *extensionVersion = [AEPMobileEdgeMedia extensionVersion]; ``` ------ -### registerExtension +### registerExtensions Registers the Media for Edge Network extension with the Mobile Core extension. diff --git a/Documentation/getting-started.md b/Documentation/getting-started.md index 96c7654..4ebafcc 100644 --- a/Documentation/getting-started.md +++ b/Documentation/getting-started.md @@ -1,24 +1,37 @@ ## Getting started -The Adobe Experience Platform Media for Edge Network mobile extension has the following dependencies, which must be installed prior to installing the extension: +The Adobe Streaming Media for Edge Network mobile extension has the following dependencies, which must be installed prior to installing the extension: - [AEPCore](https://github.com/adobe/aepsdk-core-ios) - [AEPEdge](https://github.com/adobe/aepsdk-edge-ios) - [AEPEdgeIdentity](https://github.com/adobe/aepsdk-edgeidentity-ios) -## Configuration +## Configure the Adobe Streaming Media for Edge Network extension in the Data Collection UI +The Media for Edge Network extension has specific configuration requirements for including the Media Collection Details field group in the XDM schema, enabling Media Analytics in a datastream, and installing the Adobe Streaming Media for Edge Network extension in a Tag mobile property. -### Configure Dependencies -Configure the Edge, EdgeIdentity extensions in the mobile property using the Data Collection UI. +### Configure and Setup Adobe Streaming Media for Edge Network -> **Note** -> If this is your first time setting up Edge extensions and using Data Collection UI, please follow this [tutorial](https://github.com/adobe/aepsdk-edge-ios/tree/main/Documentation/Tutorials) to learn about Adobe Experience Platform and how to setup required schemas, datasets, datastreams and creating mobile property etc. +1. [Define a report suite](https://experienceleague.adobe.com/docs/media-analytics/using/implementation/implementation-edge.html#define-a-report-suite) +2. [Set up the schema in Adobe Experience Platform](https://experienceleague.adobe.com/docs/media-analytics/using/implementation/implementation-edge.html#set-up-the-schema-in-adobe-experience-platform) +3. [Create a dataset in Adobe Experience Platform](https://experienceleague.adobe.com/docs/media-analytics/using/implementation/implementation-edge.html#create-a-dataset-in-adobe-experience-platform) +4. [Configure a datastream in Adobe Experience Platform](https://experienceleague.adobe.com/docs/media-analytics/using/implementation/implementation-edge.html#configure-a-datastream-in-adobe-experience-platform) ----- +### Configure and Install Dependencies + +Media for Edge Network requires Edge and Edge Identity extensions. +1. [Configure the Edge extension in Data Collection UI](https://developer.adobe.com/client-sdks/documentation/edge-network/#configure-the-edge-network-extension-in-data-collection-ui) +2. [Configure the Edge Identity extension in Data Collection UI](https://developer.adobe.com/client-sdks/documentation/identity-for-edge-network/#configure-the-identity-extension-in-the-data-collection-ui) + +### Configure Media for Edge Network extension in the Data Collection Tags -### Configure AEPEdgeMedia extension -Currently AEPEdgeMedia doesn't have a Data Collection extension and needs to be configured programmatically. +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** | @@ -31,7 +44,6 @@ let mediaConfiguration = [String: Any]() mediaConfiguration ["edgeMedia.channel"] = "" mediaConfiguration ["edgeMedia.playerName"] = "" mediaConfiguration ["edgeMedia.appVersion"] = "" - MobileCore.updateConfigurationWith(configDict: mediaConfiguration) ``` @@ -41,12 +53,11 @@ NSMutableDictionary* mediaConfiguration = [NSMutableDictionary dictionary]; config["edgeMedia.channel"] = @""; config["edgeMedia.playerName"] = @""; config["edgeMedia.appVersion"] = @""; - - [AEPMobileCore updateConfiguration:mediaConfiguration]; +[AEPMobileCore updateConfiguration:mediaConfiguration]; ``` ---- -## Add the AEPEdgeMedia extension to your app +## Add the Media for Edge Network extension to your app ### Download AEPEdgeMedia extension diff --git a/README.md b/README.md index d71cc77..2a60470 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,13 @@ -# Adobe Experience Platform Media For Edge Network Extension - -[![Cocoapods](https://img.shields.io/cocoapods/v/AEPEdgeMedia.svg?color=orange&label=AEPEdgeMedia&logo=apple&logoColor=white)](https://cocoapods.org/pods/AEPEdgeMedia) - -[![SPM](https://img.shields.io/badge/SPM-Supported-orange.svg?logo=apple&logoColor=white)](https://swift.org/package-manager/) -[![CircleCI](https://img.shields.io/circleci/project/github/adobe/aepsdk-edgemedia-ios/main.svg?logo=circleci)](https://circleci.com/gh/adobe/workflows/aepsdk-edgemedia-ios) -[![Code Coverage](https://img.shields.io/codecov/c/github/adobe/aepsdk-edgemedia-ios/main.svg?logo=codecov)](https://codecov.io/gh/adobe/aepsdk-edgemedia-ios/branch/main) +# Adobe Streaming Media for Edge Network extension +[![CocoaPods](https://img.shields.io/github/v/release/adobe/aepsdk-edgemedia-ios?label=CocoaPods&logo=apple&logoColor=white&color=orange)](https://cocoapods.org/pods/AEPEdgeMedia) +[![SPM](https://img.shields.io/github/v/release/adobe/aepsdk-edgemedia-ios?label=SPM&logo=apple&logoColor=white&color=orange)](https://github.com/adobe/aepsdk-edgemedia-ios/releases) +[![CircleCI](https://img.shields.io/circleci/project/github/adobe/aepsdk-edgemedia-ios/main.svg?label=Build&logo=circleci)](https://circleci.com/gh/adobe/workflows/aepsdk-edgemedia-ios) +[![Code Coverage](https://img.shields.io/codecov/c/github/adobe/aepsdk-edgemedia-ios/main.svg?label=Coverage&logo=codecov)](https://codecov.io/gh/adobe/aepsdk-edgemedia-ios/branch/main) ## About this project -The AEP Media Analytics for Edge Network mobile extension provides clients with robust measurement for audio, video and advertisements when using the [Adobe Experience Platform Mobile SDK](https://developer.adobe.com/client-sdks) and the Edge Network extension. +The Adobe Streaming Media for Edge Network extension sends data about audio and video consumption on your streaming applications to the Adobe Experience Platform Edge Network. This enables capabilities for measurement, analysis, and activation with media data across the Adobe Experience Cloud solutions when using the [Adobe Experience Platform Mobile SDK](https://developer.adobe.com/client-sdks) and the Edge Network extension. ## Requirements - Xcode 14.1 (or newer)