Getting Started
Get started with the StreamLayer iOS SDK. Install, configure, and integrate interactive features into your iOS app.
Welcome to the StreamLayer iOS SDK documentation. This guide covers everything you need to integrate StreamLayer into your iOS 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: Swift Package Manager, SDK API Key, initialization, and StreamLayer Element placement.
- Try a Test Integration — Validate your setup with a minimal working example:
- Advertising Only — Test nonlinear ad units.
- Advertising + Games — Ad units and interactive game units together.
- X (Social) Only — Social Highlights integration.
- Explore Sample Integrations — Fully functional reference projects for common use cases.
What You Can Build
| Feature | Description | Guide |
|---|---|---|
| Moment-Based Advertising | Contextual ad units triggered by live events | Advertising Test |
| 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 the StreamLayer Element's UI to your app's branding | Customizing Themes |
| Authentication Forwarding | Pass your app's user session to StreamLayer | Auth Forwarding |
| Deep Linking | Navigate users to specific content within the StreamLayer Element | Routing & Deep Links |
System Requirements
- Xcode 16.0 or higher
- Swift 6 or higher
- iOS 15+
Support
- Email: [email protected]
- Slack: Integration partners can join our real-time support channel for engineering assistance.
- SDK Releases: github.com/StreamLayer/sdk-ios/releases
Related
- Integration Guide — Complete SDK setup and configuration instructions
- Test Integration: Advertising — Quick-start example for ad units
- Sample Integrations — Fully functional reference projects
Updated 15 days ago