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.

Sign up for GitHub

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
Merged

Update formal extension name in documentation #32

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e25f63f
Update name to use 'Streaming Media' when formally referring to the e…
kevinlind Jun 5, 2023
c64ca25
Use formal name 'Adobe Streaming Media for Edge Network'
kevinlind Jun 5, 2023
47abbc1
Update extension name in podspec
kevinlind Jun 6, 2023
f4f9556
Correct API name 'registerExtensions'
kevinlind Jun 6, 2023
151e3bd
Update getting started configuration guide to point to Adobe Docs
kevinlind Jun 6, 2023
af85093
Add README for Documentation folder
kevinlind Jun 6, 2023
d3b75a6
Update link references to Adobe Docs
kevinlind Jun 6, 2023
a95a8ce
Use direct links to experience league docs
kevinlind Jun 6, 2023
a6121f2
Add section with programmatic configuration
kevinlind Jun 6, 2023
bef9e68
Move dependencies to top of getting-started
kevinlind Jun 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 11 additions & 43 deletions Documentation/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,54 +1,22 @@
## Getting started

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)
## Configure the Media for Edge Network extension in the Data Collection UI
Copy link
Contributor

@addb addb Jun 6, 2023 •
edited
Loading

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 Tab mobile property.

## Configuration

### Configure Dependencies
Configure the Edge, EdgeIdentity extensions in the mobile property using the Data Collection UI.

> **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.
Use the following guides to configure the Media for Edge Network in the Data Collection UI
* [Configure and Setup Adobe Streaming Media for Edge Network with Experience Platform](https://developer.adobe.com/client-sdks/documentation/media-for-edge-network/index.md#configure-and-setup-adobe-streaming-media-for-edge-network-with-experience-platform)
* [Configure and Install Dependencies](https://developer.adobe.com/client-sdks/documentation/media-for-edge-network/index.md#configure-and-install-dependencies)
* [Configure Media for Edge Network extension in the Data Collection UI](https://developer.adobe.com/client-sdks/documentation/media-for-edge-network/index.md#configure-media-for-edge-network-extension-in-the-data-collection-ui)

----

### Configure Media for Edge Network extension
Configure the Media for Edge Network extension by installing the "Adobe Streaming Media for Edge Network" extension in the Data Collection Tag mobile property.
The Media for Edge Network extension may additionally be configured programmatically using the following configuration keys.

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