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.
Start with your AI coding assistant
Connect your assistant to StreamLayer docs before changing code, then use this prompt. The connection lets it search the current guides and read the platform integration skill as it works.
Help me integrate StreamLayer into my existing Android app.
Use the streamlayer-docs MCP to search for and fetch the matching integration
guide and the streamlayer-android-integration skill page before editing code.
If search does not return the skill, read https://docs.streamlayer.io/docs/android-sdk-integration-skill
or ask me to copy that page into this session.
Cite the sources, confirm my SDK version and prerequisites, and make the smallest
documented change while preserving my player and app structure. Report missing
or conflicting guidance instead of guessing. Use placeholder keys in examples.
Finish with the checks run and the remaining platform/device validation steps.Review the diff and follow the platform setup and testing guidance linked below.
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 25 days ago