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

main -> dev sync #68

Merged
merged 5 commits into from
Jun 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 17 additions & 0 deletions Documentation/getting-started-test-app.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Getting started with the test app

## Data Collection mobile property prerequisites

The test app needs to be configured with a Data Collection mobile property with the following extensions before it can be used:

* [Mobile Core](https://github.com/adobe/aepsdk-core-android) (installed by default)
* [Edge Network](https://github.com/adobe/aepsdk-edge-android)
* [Identity for Edge Network](https://github.com/adobe/aepsdk-edgeidentity-android)
* [Assurance](https://github.com/adobe/aepsdk-assurance-android)

See the [Getting started](./getting-started.md) guide for instructions on setting up a mobile property with the required schema and datastream configurations. The test application is already implemented with the required SDK libraries, so only the first section of the "Getting started" guide is required.

## Run test application

1. In the test app, set your `ENVIRONMENT_FILE_ID` in `MediaTestApp.kt`, as found in the mobile property.
2. Select the `testappkotlin` runnable with the desired emulator and run the program.
53 changes: 48 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,57 @@
# Adobe Experience Platform Media for Edge Network Extension
# Adobe Streaming Media for Edge Network extension - Android

## BETA ACKNOWLEDGEMENT
[![Maven Central](https://img.shields.io/maven-metadata/v.svg?label=EdgeMedia&logo=android&logoColor=white&metadataUrl=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Fcom%2Fadobe%2Fmarketing%2Fmobile%2Fedgemedia%2Fmaven-metadata.xml)](https://mvnrepository.com/artifact/com.adobe.marketing.mobile/edgemedia)
[![CircleCI](https://img.shields.io/circleci/project/github/adobe/aepsdk-edgemedia-android/main.svg?label=Build&logo=circleci)](https://circleci.com/gh/adobe/workflows/aepsdk-edgemedia-android)
[![Code Coverage](https://img.shields.io/codecov/c/github/adobe/aepsdk-edgemedia-android/main.svg?label=Coverage&logo=codecov)](https://codecov.io/gh/adobe/aepsdk-edgemedia-android/branch/main)

The Media for Edge Network extension is currently in Beta. Use of this code is by invitation only and not otherwise supported by Adobe. Please contact your Adobe Customer Success Manager to learn more.
## About this project

By using the Beta, you hereby acknowledge that the Beta is provided "as is" without warranty of any kind. Adobe shall have no obligation to maintain, correct, update, change, modify or otherwise support the Beta. You are advised to use caution and not to rely in any way on the correct functioning or performance of such Beta and/or accompanying materials.
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.

## Installation

To install and start using the Media for Edge Network extension, check out the [getting started guide](Documentation/getting-started.md) and the [API reference](Documentation/api-reference.md).

## Migrating from Media Analytics

Please refer to the [Migrating from Media to Media for Edge Network guide](Documentation/migration-guide.md).

### Development

**Open the project**

To open and run the project, open the `code/settings.gradle` file in Android Studio

### Development

#### Run the test application

To configure and run the test app for this project, follow the [getting started guide for the test app](Documentation/getting-started-test-app.md).

#### Code format

This project uses the code formatting tools [Spotless](https://github.com/diffplug/spotless/tree/main/plugin-gradle) with [Prettier](https://prettier.io/). Formatting is applied when the project is built from Gradle and is checked when changes are submitted to the CI build system.

Prettier requires [Node version](https://nodejs.org/en/download/releases/) 10+
To enable the Git pre-commit hook to apply code formatting on each commit, run the following to update the project's git config `core.hooksPath`:
```
make init
```

## Related Projects

| Project | Description |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| [Core extensions](https://github.com/adobe/aepsdk-core-android) | The Mobile Core represents the foundation of the Adobe Experience Platform Mobile SDK. |
| [Edge Network extension](https://github.com/adobe/aepsdk-edge-android) | The Edge Network extension allows you to send data to the Adobe Edge Network from a mobile application. |
| [Identity for Edge Network](https://github.com/adobe/aepsdk-edgeidentity-android) | The Identity for Edge Network extension enables identity management from a mobile app when using the Edge Network extension. |
| [Assurance extension](https://github.com/adobe/aepsdk-assurance-android) | The Assurance extension enables validation workflows for your SDK implementation. |

## Documentation

Additional documentation for usage and SDK architecture can be found under the [Documentation](https://developer.adobe.com/client-sdks) directory.
Information about Adobe Streaming Media for Edge Network implementation, API usage, and architecture can be found in the [Documentation](Documentation) directory.

Learn more about Media for Edge Network and all other Mobile SDK extensions in the official [Adobe Experience Platform Mobile SDK documentation](https://developer.adobe.com/client-sdks).

## Contributing

Expand Down