Readme.md

5G-MAG Reference Tools: 5GMS Common Library

This repository holds the 5GMS Common Library implementation of the 5G-MAG Reference Tools.

Introduction

The 5GMS Common Library is an Android library that includes models and helper classes used within the different client-side Android applications such as the 5GMS Aware Application, 5GMS Media Stream Handler and the 5GMS Media Session Handler.

Downloading

Release versions can be downloaded from the releases page.

We also publish this library as a Maven package on the 5G-MAG Github Packages .

The source can be obtained by cloning the github repository.

cd ~
git clone https://github.com/5G-MAG/rt-5gms-common-android-library

Building

Call the following command in order to generate the aar bundles.

./gradlew assemble

The resulting aar bundles can be found in app/build/outputs/aar/ and can be included in your project by specifying the path to the bundle.

Publish to local Maven Repository

The preferred way to include the 5GMS Common Library is via a local or remote Maven repository (see below). To include the library from a local Maven repository we need to publish it locally first:

./gradlew publishToMavenLocal

Include from local Maven Repository

To include the 5GMS Common Library from a local Maven repository apply the following changes.

Note: When using the other 5G-MAG client-side projects the changes below are already included. In this case the 5GMS Common Library only needs to be published to the local Maven repository (see above).

1. Add mavenLocal() to your project gradle file

dependencyResolutionManagement {
   repositories {
   mavenLocal()
   }
}

2. Include the 5GMS Common Library in your module gradle file

dependencies {
    // 5GMAG
    implementation 'com.fivegmag:a5gmscommonlibrary:1.0.0'
}

Development

This project follows the Gitflow workflow . The development branch of this project serves as an integration branch for new features. Consequently, please make sure to switch to the development branch before starting the implementation of a new feature.