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.

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 Pause Ads — Implement pause advertising and custom paused ads for your Apple TV app.

What You Can Build

Feature	Description	Guide
Pause Advertising	Display ads when viewers pause playback	Pause Ads
Custom Paused Ads	Fullscreen and transparent pause ads with VAST support	Custom 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
Custom Paused Ads	Fullscreen and transparent pause ads with VAST

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

StreamLayer SDK is not distributed as a CocoaPods library. You can still integrate it 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.

Current version: v8.22.169

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
Custom Paused Ads — Fullscreen and transparent pause ads with VAST support
iOS SDK Integration Guide — Full iOS SDK setup and configuration

Getting Started