Android SDK (Core)

Installation

8min

Here you will find step-by-step instructions to get the Android SDK running in your AndroidStudio project.

Prerequisites

To include the SDK, you will need to obtain access to a private Github repository.

Please request access by sending your Github account information to [email protected] or reach out to your contact person at NativeWaves.

The account will be added to the NativeWaves team as external developer and allows you to access the necessary repository.

Please note: only one Github account per organization is allowed.

Add the SDK to your project

The Android SDK is distributed using Github Packages. Once you have access to the Github repository, you can import the SDK using Gradle.

Personal Access Token

First create a "Personal Access Token" that will be used by you and your colleagues for authentication on Github. The token must only have the read:packages permission.

Document image


It is advised to only use the minimal required scope (read:packages) when creating the token to prevent security issues when sharing the permissions with your colleagues.

Generate personal access token (for the Github account shared with NativeWaves):

  1. Go to Github accounts > Settings > Developer Settings > and click "Generate new token"
  2. Make sure to select at least the "read:packages" scope
  3. Generate token and save it

Add Token to your Android project

  1. In your root Android project, add a local.properties or any *.properties file.
  2. Add your github properties to the file
properties


Make sure you add the file to your .gitignore to not add your credentials to git history!

Import the SDK from the Github Packages Registry

This setup adds the Nativewaves Maven Repository hosted on GitHub Packages to the project's repository list. The repository, identified by the URL https://maven.pkg.github.com/nativewaves/nw-exp-android-packages, is named "GitHubPackages" within the configuration. This repository is associated with the GitHub user or organization nativewaves and is specifically for the nw-exp-android-packages.

Correctly we supports Millicast(Dolby) and so you have to add the maven repository for Millicast. The repository, identified by the URL https://maven.pkg.github.com/millicast/maven

In your application build.gradle file add the following:

gradle


or in settings.gradle (for gradle v8.* user ) add the following:

gradle


In your app build.gradle file add the following line to your dependencies:

gradle


Change the version number accordingly.

Now you are setup and ready to use the SDK!