TVMLKit is a deprecated tvOS framework for building app interfaces and controllers using TVML markup and JavaScript. You host the experience with TVApplicationController and its TVApplicationControllerContext, which load and run your JavaScript and TVML documents, while view controllers such as TVDocumentViewController and TVBrowserViewController present the resulting screens. The framework turns markup into a tree of view elements, including TVViewElement, TVImageElement, and TVTextElement, with TVElementFactory and TVInterfaceFactory creating elements and TVStyleFactory, TVViewElementStyle, and TVColor applying styling. It also models media playback through TVPlayer, TVPlaylist, TVMediaItem, and TVPlaybackEvent.
Application Hosting 3
Bootstrap and run a TVMLKit app from its JavaScript and TVML documents.
- ClTVApplicationController@description The TVApplicationController class establishes the JavaScript environment
- ClTVApplicationControllerContext@brief This class is used to provide launch info to TVApplicationController.
- PrTVApplicationControllerDelegateA protocol for responding to lifecycle and load events of a TVApplicationController.
Presenting Documents 5
View controllers that present TVML documents and browse between them.
- ClTVDocumentViewControllerA view controller that presents a single TVML document on screen.
- PrTVDocumentViewControllerDelegateA protocol for responding to presentation events of a TVDocumentViewController.
- ClTVBrowserViewControllertvOS 13.0+A view controller that presents and navigates between a set of TVML documents.
- PrTVBrowserViewControllerDataSourcetvOS 13.0+A protocol that provides the documents presented by a TVBrowserViewController.
- PrTVBrowserViewControllerDelegatetvOS 13.0+A protocol for responding to navigation events in a TVBrowserViewController.
View Elements 3
The element tree that TVMLKit builds from your markup.
- ClTVViewElement@description TVViewElement represents a read only DOM node along with it's
- ClTVImageElement@decription Convenience class representing <img /> element.
- ClTVTextElement@decription Represents textual content for the DOM element.
Creating Elements and Interfaces 3
Factories and protocols that turn markup into elements and platform interfaces.
- ClTVElementFactory@description Factory for registration of new elements that extend Apple TV markup language. Registration is required
- ClTVInterfaceFactory@description Interface factory for creation of views and view controllers. Application can extend or override framework implementation by setting extendedInterfaceCreator.
- PrTVInterfaceCreatingA protocol for creating custom interface objects from TVML view elements.
Styling 6
Apply colors and visual styles to the element tree.
- ClTVStyleFactory@description Factory to register new styles to define custom style data.
- ClTVViewElementStyle@description An instance of TVViewElementStyle contains the set of styles applied to the view element.
- ClTVColor@description Defines the color data for styles of type TVViewElementStyleTypeColor.
- EnTVColorTypeConstants that specify the kind of color value resolved from TVML styling.
- EnTVViewElementStyleTypeConstants that specify the type of a view element style attribute.
- EnTVTextElementStyleConstants that specify the text style applied to a text element.
Media Playback 3
Model media items, playlists, and the player that plays them.
- ClTVPlayer/////////////////////////////////////////////////////////////////////////////
- ClTVPlaylist/////////////////////////////////////////////////////////////////////////////
- ClTVMediaItem/////////////////////////////////////////////////////////////////////////////
Playback Events 5
Describe and marshal playback events between native and JavaScript code.
- StTVPlaybackEventA structure describing an event emitted during media playback.
- StTVPlaybackEventPropertyA structure identifying a property carried by a playback event.
- EnTVPlaybackStateConstants that specify the current state of media playback.
- PrTVPlaybackEventMarshaling@discussion An event user info marshaling protocol for sending and receiving
- ClTVPlaybackCustomEventUserInfo@discussion Event object that encapsulates its identity and user info for
Element Layout and Behavior 7
Constants that describe element alignment, position, events, and updates.
- EnTVElementAlignmentConstants that specify the alignment of a view element within its parent.
- EnTVElementContentAlignmentConstants that specify the alignment of a view element's content.
- EnTVElementPositionConstants that specify the position of a view element within its layout.
- EnTVElementEventTypeConstants that specify the kinds of events a view element can emit.
- EnTVElementUpdateTypeConstants that specify how a view element is updated when markup changes.
- EnTVElementResettableProperty@abstract Properties of TVViewElement that can be reset by the client to their
- EnTVImageTypeConstants that specify the type of image displayed by an image element.
Errors 2
Error types reported when loading documents or running TVMLKit.
- StTVDocumentErrorA structure describing an error encountered while loading or parsing a TVML document.
- EnTVMLKitErrorConstants that specify error conditions raised by TVMLKit.
Classes 1
- ClTVBrowserTransitionAnimatortvOS 13.0+