Getting Started with StreamLayer SDK for tvOS

Prerequisites

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.

Obtain an SDK API Key

You need an SDK API key to integrate StreamLayer into your tvOS app.

If you don’t have one:

1. Provide your email address to StreamLayer support.
2. We’ll create an organization and set up your personal dashboard.
3. You’ll receive an invitation email with a link to the admin panel and credentials.
4. After accessing the admin panel, generate your API key from the Development section.

This API key authenticates your app and is required for all interactions.

Installation

Swift Package Manager (SPM)

The SDK is distributed as a dynamic framework.

To integrate using SPM:

1. In Xcode, go to File > Add Packages.
2. Enter package URL: [email protected]:StreamLayer/sdk-ios.git
3. 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:

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

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

Current version: v8.22.169

Integration

Introduction

StreamLayer SDK renders an overlay on top of your app interface.

To activate the overlay:

1. Initialize the SDK with your API key.
2. Implement delegate methods to enable communication between your app and the SDK.

SDK Initialization