Installation¶

To use the Video Analyzer SDK, you need to integrate the library files into your Android app.

Requirements¶

Android SDK¶

You need Android SDK 24 or later to compile and use the Video Analyzer SDK. We support all major architectures: armeabi-v7a, arm64-v8a, x86, and x86_64.

No Further Dependencies¶

The Video Analyzer SDK has no external dependencies. It takes video frames as YUV 4:2:0 plane buffers, which is the format that CameraX and most MediaCodec decoders deliver. You do not need OpenCV.

Permissions¶

The Video Analyzer SDK requires the following Android permissions:

• INTERNET: Required for registration with AVEQ servers

Add these to your AndroidManifest.xml:

<uses-permission android:name="android.permission.INTERNET" />

Download¶

Download the Video Analyzer SDK from the links provided by AVEQ, and extract them locally. The extracted folder should look like this:

.
├── LICENSE.md
├── README_SDK.md
├── docs/
├── videoanalyzer
│   └── videoanalyzer/…
└── videoanalyzer_demo-$version-$customer.zip

The docs folder contains the JavaDoc API documentation. The videoanalyzer folder contains the actual SDK library files. The demo ZIP file contains sample source code demonstrating SDK usage.

Integration into your Android project¶

The Video Analyzer SDK is packaged as a Maven library in the videoanalyzer/videoanalyzer folder.

First, copy the videoanalyzer folder to your app directory. Your Android project structure might look like this:

.
├── app
│   ├── build.gradle
│   ├── proguard-rules.pro
│   └── src (your Android app source code)
├── build.gradle
├── gradle
│   └── wrapper
├── gradle.properties
├── gradlew
├── gradlew.bat
├── local.properties
└── settings.gradle

Place the inner videoanalyzer folder into the app folder:

.
├── app
│   ├── build.gradle
│   ├── proguard-rules.pro
│   ├── src (your Android app source code)
│   └── videoanalyzer (Video Analyzer SDK library)
│       └── com
│           └── aveq
│               └── videoanalyzer
│                   ├── ...

Updating Gradle settings¶

Modify your settings.gradle file to add the SDK as a local Maven repository:

dependencyResolutionManagement {
    repositories {
        // videoanalyzer local repo
        maven {
            url = "file://" + file('app/videoanalyzer')
        }
        google()
        mavenCentral()
    }
}

repositories{
    maven {
        url uri("${rootProject.projectDir}/app/videoanalyzer")
    }
}

In your app's build.gradle, add the Video Analyzer SDK to the dependencies:

dependencies {
    implementation 'com.aveq:videoanalyzer:$version'

    // Other dependencies...
}

Replace $version with the version number provided with your SDK download, e.g., 1.0.0.

The com.aveq.videoanalyzer package should now be available for importing in your application.

Verification¶

To verify that the integration was successful, try importing the main SDK class in your Android code:

import com.aveq.videoanalyzer.VideoAnalyzerManager;

If the import resolves without errors, you're ready to proceed with registration.

Updating the SDK¶

To update the SDK to a newer version:

1. Download the latest SDK version from AVEQ
2. Replace the videoanalyzer folder with the new version
3. Update the version number in your build.gradle file
4. Clean and rebuild your project
5. Check the changelog for changes to the API