Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update formal extension name in documentation #32

Merged
merged 10 commits into from
Jun 6, 2023
4 changes: 2 additions & 2 deletions AEPEdgeMedia.podspec
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
6 changes: 6 additions & 0 deletions Documentation/README.md
Original file line number Diff line number Diff line change
@@ -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)
6 changes: 3 additions & 3 deletions Documentation/api-reference.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Adobe Experience Platform Media for Edge Network Extension - iOS
# Adobe Streaming Media for Edge Network extension - iOS

## Prerequisites

addb marked this conversation as resolved.
Show resolved Hide resolved
Expand All @@ -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) |
Expand Down Expand Up @@ -64,7 +64,7 @@ NSString *extensionVersion = [AEPMobileEdgeMedia extensionVersion];
```
------

### registerExtension
### registerExtensions

Registers the Media for Edge Network extension with the Mobile Core extension.

Expand Down
63 changes: 24 additions & 39 deletions Documentation/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,38 @@
## 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:
- [AEPCore](https://github.com/adobe/aepsdk-core-ios)
- [AEPEdge](https://github.com/adobe/aepsdk-edge-ios)
- [AEPEdgeIdentity](https://github.com/adobe/aepsdk-edgeidentity-ios)
## Configure the Media for Edge Network extension in the Data Collection UI
Copy link
Contributor

@addb addb Jun 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Configure the Adobe Streaming Media for Edge Network extension in the Data Collection UI

Since this is the start of the doc and also involves 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.

## Configuration
### Configure and Setup Adobe Streaming Media for Edge Network

### Configure Dependencies
Configure the Edge, EdgeIdentity extensions in the mobile property using the Data Collection UI.
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)

> **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.
### 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

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 more information, see [Configure Media for Edge Network extension](#configure-the-media-for-edge-network-extension).
addb marked this conversation as resolved.
Show resolved Hide resolved
4. Select **Save**.
5. Follow the publishing process to update your SDK configuration.

### Configure AEPEdgeMedia extension
Currently AEPEdgeMedia doesn't have a Data Collection extension and needs to be configured programmatically.

#### Configuration Keys
addb marked this conversation as resolved.
Show resolved Hide resolved
| Name | Key | Value | Required |
| --- | --- | --- | --- |
| Channel | "edgeMedia.channel" | String | **Yes** |
| Player Name | "edgeMedia.playerName" | String | **Yes** |
| Application Version | "edgeMedia.appVersion" | String | **No** |

##### Swift
```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
```objectivec
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 AEPEdgeMedia extension to your app

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)

### Download AEPEdgeMedia extension

> **Note**
Expand Down
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down