Skip to content

Live TV

Luke edited this page Jan 15, 2014 · 26 revisions

Begin live tv support by making a call to /LiveTv/Info. The ActiveServiceName will tell you if there is a live tv service plugin installed on the server.

Channels

Query for tv channels using /LiveTv/Channels. The most interesting channel properties are:

  • Name
  • Number
  • ChannelType
  • CurrentProgram

Channel images use the same api endpoints as regular library items, e.g. /Items/{Id}/Images/Primary. Channels also can have user data allowing users to like or favorite them which will help influence suggested programs.

Recording Groups

To display recordings by group, first get the list of groups using /LiveTv/Recordings/Groups. Each group has a Name, Id and RecordingCount.

Recordings

Recordings can be queried using /LiveTv/Recordings. Some of the available query params are:

  • ChannelId
  • IsRecording (active recordings)
  • GroupId
  • SeriesTimerId

Recording Info

Most of the data attached to recordings is self-explanatory and will not be rehashed here. They are very similar to library items. Only the properties requiring explanation are listed below.

  • Status, StatusName - The recording status. StatusName is a displayable value.
  • CompletionPercentage - Only applicable if in progress.
  • Path - The physical path to the recording file. Some clients may prefer to play the file directly.
  • MediaStreams - Only available for completed recordings.

Name & EpisodeTitle

For programs, recordings and timers that are part of a series, Name will always equal the series name, while EpisodeTitle is the title of the episode. Please note that episode title will not always be available.

Clone this wiki locally