TVServices lets a tvOS app supply featured content for the Top Shelf, the area displayed when the app is focused on the Apple TV Home screen. You implement a TVTopShelfContentProvider that returns TVTopShelfContent, building it from carousel content (TVTopShelfCarouselContent and TVTopShelfCarouselItem), sectioned content (TVTopShelfSectionedContent and TVTopShelfSectionedItem), or inset content, with each TVContentItem carrying a TVContentIdentifier, images described by TVContentItemImageTrait and TVContentItemImageShape, and a TVTopShelfAction. The framework also provides TV app profile management through TVAppProfileDescriptor and TVUserManager.
Top Shelf Content Providers 3
The provider objects that supply featured content for an app's Top Shelf on the Apple TV Home screen.
- ClTVTopShelfContentProvidertvOS 13.0+The principal object an app subclasses to supply featured content for the Top Shelf.
- PrTVTopShelfContenttvOS 13.0+A protocol adopted by objects that supply content for the Top Shelf.
- PrTVTopShelfProvider@protocol TVTopShelfProvider
Carousel Content 2
Types for presenting Top Shelf content as a large, automatically rotating carousel.
- ClTVTopShelfCarouselContenttvOS 13.0+An object that represents carousel content.
- ClTVTopShelfCarouselItemtvOS 13.0+An object that represents a single item in the carousel content style.
Sectioned and Inset Content 3
Types for presenting Top Shelf content grouped into sections or as a single inset banner.
- ClTVTopShelfSectionedContenttvOS 13.0+An object that represents sectioned content.
- ClTVTopShelfSectionedItemtvOS 13.0+An object that represents a single item in the sectioned content style.
- ClTVTopShelfInsetContenttvOS 13.0+An object that represents inset banner content.
Content Items and Identifiers 3
The items, identifiers, and actions that describe individual pieces of featured content.
- ClTVContentItem@class TVContentItem
- ClTVContentIdentifier@class TVContentIdentifier
- ClTVTopShelfActiontvOS 13.0+An object that describes a user action in the Top Shelf.
Image Traits and Styles 3
Constants that describe the shape, traits, and display style of Top Shelf imagery.
- StTVContentItemImageTraittvOS 11.0+@enum TVContentItemImageTrait
- EnTVContentItemImageShape@enum TVContentItemImageShape
- EnTVTopShelfContentStyleConstants that specify the display style of Top Shelf content.
Legacy Top Shelf Types 4
Earlier Top Shelf objects, items, and collections retained for backward compatibility.
- ClTVTopShelfObjecttvOS 13.0+An abstract base class for describing Top Shelf items and Top Shelf item collections.
- ClTVTopShelfItemtvOS 13.0+The base class for describing Top Shelf content to the system.
- ClTVTopShelfItemCollectiontvOS 13.0+An object that represents a collection of Top Shelf items that can be displayed in a section.
- ClTVTopShelfNamedAttributetvOS 13.0+An object that represents a named attribute with a list of associated values. Instances of this class will be displayed in a stylized manner by the Top Shelf UI.
Profile Management 2
Types for describing and managing TV app user profiles.
- ClTVAppProfileDescriptor@class TVAppProfileDescriptor
- ClTVUserManagertvOS 13.0+@class TVUserManager
Type Aliases 1
- TyTVUserIdentifier