tvOS SDK

Welcome to the StreamLayer tvOS SDK documentation. StreamLayer supports Apple TV applications through the iOS SDK. This guide covers installation, initialization, and integration for tvOS.

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 tvOS / Apple TV app.
Use the streamlayer-docs MCP to search for and fetch the matching integration
guide and the streamlayer-tvos-integration skill page before editing code.
If search does not return the skill, read https://docs.streamlayer.io/docs/tvos-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 iOS SDK Integration Guide — The tvOS SDK shares the iOS SDK. Follow the full setup guide for dependencies, SDK API Key, and initialization.
Configure for tvOS — Review the tvOS-specific notes below for Apple TV remote handling and SDK initialization.
Add ads — Implement exposed ads (host-driven, on demand) and paused ads (StreamLayer-delivered on ad breaks) for your Apple TV app.

What You Can Build

Feature	Description	Guide
Pause Advertising	Display ads when viewers pause playback	Pause Ads
Exposed Ads	Host-driven ad units you display on demand — full-bleed, sidebar, PIP, side-by-side, sponsor frame, and VAST	Exposed Ads
Paused Ads	StreamLayer-delivered ads on ad breaks, sourced from Studio or Prebid	Paused Ads
StreamLayer Element	Interactive UI surface with remote control navigation	iOS Integration Guide

Reference Documentation

Documentation	Description
iOS SDK Integration Guide	Full iOS SDK setup and configuration
Pause Advertising	Display ads when the viewer pauses playback
Exposed Ads	Host-driven, on-demand ad units and VAST shapes
Paused Ads	StreamLayer-delivered ads (Studio / Prebid) on ad breaks

System Requirements

Xcode: 16.0 or higher
Swift: 6 or higher
tvOS: 18 or higher

Note:
If you use a different Swift version, contact support so we can add it to our continuous delivery pipeline.

Quick Installation

Swift Package Manager (SPM)

The SDK is distributed as a dynamic framework.

In Xcode, go to File > Add Packages.
Enter package URL: [email protected]:StreamLayer/sdk-ios.git
Set Dependency Rule to Up to Next Major Version.

CocoaPods-based projects

StreamLayer SDK is not distributed as a CocoaPods library for tvOS. If your app already uses CocoaPods, add StreamLayer as an SPM dependency in your .xcworkspace:

Open your .xcworkspace.
Go to Project Settings > Package Dependencies.
Press + to add a new package.
Enter URL: https://github.com/StreamLayer/sdk-ios.git
Set Dependency Rule to Up to Next Minor Version.
Click Add.

Refer to our example repository for a CocoaPods + SPM integration example.

Check the SDK releases for available versions. Use the version selected for your integration and consult the changelog before upgrading.

tvOS-Specific Notes

SDK Initialization: Initialize the SDK with your API key, then implement delegate methods to enable communication between your app and the SDK.
StreamLayer Element Rendering: StreamLayer SDK renders a StreamLayer Element on top of your app interface.
Remote Control: The SDK handles Apple TV remote navigation automatically.

SDK Initialization

Support

For tvOS-specific issues or questions:

Email: [email protected]

Pause Advertising — Display ads when the viewer pauses playback
Exposed Ads — Host-driven, on-demand ad units and VAST shapes
Paused Ads — StreamLayer-delivered ads (Studio / Prebid) on ad breaks
iOS SDK Integration Guide — Full iOS SDK setup and configuration

Getting Started