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.
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 iOS UIKit app.
Use the streamlayer-docs MCP to search for and fetch the matching integration
guide and the streamlayer-ios-integration skill page before editing code.
If search does not return the skill, read https://docs.streamlayer.io/docs/ios-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: 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.
- 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 |
| Exposed Ads | Host-driven ad units you display on demand — overlay, sidebar, PIP, side-by-side, sponsor frame, full-screen, and VAST | Exposed 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
- Exposed Ads — Host-driven exposed ad units you display on demand, with step-by-step Swift examples
- Test Integration: Advertising — Quick-start example for ad units
- Sample Integrations — Fully functional reference projects
Updated 25 days ago