Framework

TVMLKit JS

Create tvOS client-server apps using web technologies to stream media and respond to events.

Overview

The TVMLKit JS framework provides you with the means to display client-server apps created with the Apple TV Markup Language (TVML) on tvOS. You use other classes in the framework to stream media and respond to events.

The TVMLKit JS framework incorporates the following standard Document Object Module classes, which are not documented here. For information on these classes, see World Wide Web Consortium.

  • CharacterData

  • Comment

  • CustomEvent

  • Document

  • DocumentFragment

  • DOMException

  • DOMImplementation

  • DOMImplementationLS

  • DOMImplementationRegistry

  • DOMParser

  • Element

  • Event

  • EventException

  • HTMLCollection

  • LSException

  • LSInput

  • LSParser

  • LSSerializer

  • NamedNodeMap

  • Node

  • NodeList

  • ParentNode

  • ParsingElement

  • Text

  • XMLSerializer

  • XPathEvaluator

  • XPathException

  • XPathExpression

  • XPathResult

Topics

App Initialization

App

An object that provides access to—and a means to respond to—app life-cycle events.

UserDefaults

An object that contains the app's default preferences.

NavigationDocument

A document stack that holds the individual TVML documents for a client-server app.

EventListenerObject

An object that communicates events and allows other objects to add themselves as listeners.

Device Settings

Device

An object that provides information about an Apple TV and the host app installed on the device.

Settings

An object that provides access to setting information for a device.

Restrictions

An object used to retrieve rating restriction information.

Media Playback

Player

A media player that displays the UI for playing video and audio in an Apple TV client-server app.

Playlist

An array of media items to be played in an Apple TV client-server app.

MediaItem

A single audio or video item.

Slideshow

An object used to display images on Apple TV in a slideshow format.

Element Access

Keyboard

An object used to retrieve user inputs from search fields and text fields.

MenuBarDocument

An object used for setting and retrieving documents associated with a menu item.

Data Storage and Retrieval

XMLHttpRequest

An object used to retrieve data from a URL.

DataItem

An object used to create observable objects from JSON objects for data binding.

Storage

An object used to store key-value-pair information.

Errors

TVError

Error codes for the TVError domain.

NSError

Information about an error condition, including a domain, a domain-specific error code, and application-specific information.

Reference

TVMLKit JS Functions

The functions contained in this reference can be used globally in your app. They are not associated with a particular class.