Framework

TVServices

Help users discover your app by providing top shelf content and a description of your tvOS app.

Overview

Use the TVServices framework to display content in the top shelf area of the screen and to speed up user login. Use the top shelf area to highlight media and other information from your app. For example, a video playback app might show the user's most recently viewed videos. The system displays your media items when the user selects your app on the tvOS home screen; your app doesn't need to be running. You provide top shelf content using a Top Shelf app extension, which you include in the bundle of your tvOS app.

Apps that manage multiple user profiles can accelerate the login process by assigning a default profile to each Apple ID on the system. Apple TV supports multiple user accounts, and these accounts are separate from the profiles your app manages. Mapping the system accounts to your own profiles lets users skip profile selection screens and go straight to their content, which provides a better user experience.

For more information about how to create app extensions, see App Extension Programming Guide.

Topics

Top Shelf Extensions

Building a Full Screen Top Shelf Extension

Highlight content from your Apple TV application by building a full screen Top Shelf extension.

class TVTopShelfContentProvider

The main interface for your Top Shelf app extension, which you use to provide content for the top shelf area of the tvOS home screen.

Legacy Extension

Help users discover your app by providing top shelf content and a description of your tvOS app.

Carousel Content

class TVTopShelfCarouselItem

An item containing images, video, and other information that you want to display using a carousel-based interface.

class TVTopShelfCarouselContent

A set of items you present using a carousel-style interface in the top shelf.

Sectioned and Inset Content

class TVTopShelfSectionedItem

An item to display in a section-based interface.

class TVTopShelfItemCollection

A group of items that you display together in a sectioned interface in the top shelf.

class TVTopShelfSectionedContent

The set of items you want to present using a section-based interface in the top shelf.

class TVTopShelfInsetContent

A set of items to present using an inset-style interface in the top shelf.

Multiple User Login

class TVUserManager

An object for mapping Apple TV user accounts to app-specific user preferences.

class TVAppProfileDescriptor

A model object that you use to represent an app-specific profile.

Mapping Apple TV Users to App Profiles

Adapt the content of your app for the current viewer by using TV user manager.

Common Types

class TVTopShelfItem

An item that uses an image to represent a movie, show, or other content in the top shelf.

class TVTopShelfAction

An action to perform in response to user interactions with an item in the top shelf.

protocol TVTopShelfContent

The protocol adopted by objects that provide content for the top shelf.

class TVTopShelfObject

An abstract base class for describing top shelf items and item collections.