Getting Started
Get started with the StreamLayer Android SDK. Install, configure, and integrate interactive features into your Android app.
Welcome to the StreamLayer Android SDK documentation. This guide covers everything you need to integrate StreamLayer into your Android app — from installation to customization.
Quick Start Path
- Read the Introduction — Understand what StreamLayer delivers and how the SDK architecture works.
- Follow the Integration Guide — Step-by-step setup: dependencies, SDK API Key, initialization, and StreamLayer Element placement.
- Try a Test Integration — Validate your setup with a minimal working example.
- Explore Sample Integrations — Fully functional reference projects for common use cases.
What You Can Build
| Feature | Description | Guide |
|---|---|---|
| Moment-Based Advertising | Contextual ads triggered by live events | Ads Integration |
| Pause Ads | Interactive brand ads displayed when viewers pause content | Pause Ads |
| Interactive Units | Poll, prediction, stat, and trivia units for fan engagement | StreamLayer Element Visibility |
| Custom Themes | Match StreamLayer UI to your app's branding | Customizing Themes |
| Authentication Forwarding | Pass your app's user session to StreamLayer | Auth Forwarding |
System Requirements
- Android SDK 24+ (Android 7.0 Nougat)
- Kotlin 1.9+
- Gradle 8.0+
Support
- Email: [email protected]
- Slack: Integration partners can join our real-time support channel for engineering assistance.
- SDK Releases: github.com/StreamLayer/sdk-android/releases
Related
- Integration Guide — Complete SDK setup and configuration
- Test Integration: Ads Only — Quick-start example for ad units
- Sample Integrations — Fully functional reference projects
Updated about 1 month ago