Data Types

Channel

Table to hold all details of a channel
Table Members:

• ID: String. Unique ID used internally by the GUI and the grabber
• XML_ID: String. Unique ID written to the XML file. If not specified then an ID in the form of "[Grabber Name]_[ID]" is used
• Name: XMLTVStringList. Display name(s) for the channel
• Icon: IconList. Channel icon(s) (optional)
• URL: StringList. URL(s) for the channel (optional)

XMLTVStringList

Table containing a list of XMLTVStrings or a single XMLTVString

XMLTVString

A single string or a table containing a string and its language
Table Members:

• Value: String. Value of the string
• Lang: String. Language of the string (optional)

IconList

A single Icon or a table containing a list of Icons

Icon

Table to hold the details of an Icon
Table Members:

• Source: String. Source of the icon
• Width: Number. Width of the icon (optional)
• Height: Number. Height of the icon (optional)

StringList

A single string or a table containing a list of strings

Program

A table to hold all the details of a program
Table Members:

• ID: String. Unique ID to identify the program internally (optional)
• Channel: String. The channel the program will be broadcast on, this must match exactly the internal ID of one of the channels
• Start: Time. The time the program starts
• Stop: Time. The time the program ends (optional)
• PDCStart: Time. The PDC start time (optional)
• VPSStart: Time. The VPS start time (optional)
• ShowView: String. Gemstar's Showview code (optional)
• VideoPlus: String. VideoPlus code (optional)
• Clump: String. Clump idx (optional)
• Title: XMLTVStringList. Program's title(s)
• Sub_Title: XMLTVStringList. Program's sub title(s) (optional)
• Description: XMLTVStringList. Program's description (optional)
• Credits: Credits. Program Credits (optional)
• Date: String. Programs production date (optional)
• Category: XMLTVStringList. Program's category(ies) (optional)
• Lang: XMLTVString. Programs language (optional)
• OriginalLang: XMLTVString. Programs original language (optional)
• Length: Length. Program length (excluding adverts etc.) (optional)
• Icon: IconList. Program icon(s) (optional)
• URL: StringList. URL(s) for the program (optional)
• Country: XMLTVStringList. Country(ies) program was made in (optional)
• Episode: Episode. Program episode number (optional)
• Video: Video. Program video information (optional)
• Audio: Audio. Program audio information (optional)
• PreviouslyShown: PreviouslyShown. States whether program has previously been shown (optional)
• Premiere: XMLTVString. States whether a program is a premiere, the string value describes the premiere e.g. "First showing on national terrestrial TV". If this element is absent the program will not be marked as a premiere (optional)
• LastChance: XMLTVString. Similar to the Premiere item, says that this is the last time the program will be shown on this channel (optional)
• New: Boolean. If true the program is the first program from a new show and this is the first time it has been shown (not to be used for new a series, for that use Episode) (optional)
• Subtitles: Subtitles. Describes whether a program has subtitles and their type. (optional)
• Rating: Ratings. The program's age classification (optional)
• StarRating: StarRating. A measure of how good the program is (optional)

Time

A table to hold a date and time. All times should be specified in UTC (+0000)
Table Members:

• Year: Number.
• Month: Number.
• Day: Number.
• Hour: Number.
• Minute: Number.
• Second: Number.

Credits

A table to hold a program's credits
Table Members:

• Director: StringList. Program director(s) (optional)
• Actor: CastList. Program cast member(s) (optional)
• Writer: StringList. Program writer(s) (optional)
• Adapter: StringList. Program adapters(s) (optional)
• Producer: StringList. Program producer(s) (optional)
• Presenter: StringList. Program presenter(s) (optional)
• Commentator: StringList. Program commentator(s) (optional)
• Guest: StringList. Program guest(s) (optional)

CastList

A single CastMember or a list of CastMembers

CastMember

A cast member, either a single string for the actor's name or a table containing the actor and character name
Table Members:

• Actor: String.
• Character: String. (optional)

Length

A table to hold the length of a program
Table Members:

• Length: Number. Length of the program
• Units: Number. Units of the length, can have the following values:
  • XGUI.LengthUnits.Seconds
  • XGUI.LengthUnits.Minutes
  • XGUI.LengthUnits.Hours

Episode

A table to hold a program's episode number
Table Members:

• Number: String. Episode number
• System: String. Episode number system (see XMLTV DTD)

Video

Program video information
Table Members:

• Present: Boolean. If true then the program has video else the program is audio only (optional, default: true)
• Colour: Boolean. If true then the is colour else the program is black and white (optional, default: true)
• Aspect: String. The aspect ratio of the program (optional)
• Quality: String. The quality of the picture (optional)

Audio

Program audio information
Table Members:

• Present: Boolean. If true then the program has audio else the program is silent (optional, default: true)
• Stereo: String. Describes the "Stereoness" of the audio, can be "mono", "stereo", "dolby" or "surround" (optional)

PreviouslyShown

Boolean or table containing information about previous showing
Table Members:

• Channel: String. The channel the program was last shown on (optional)
• Start: String. The time the program was last shown (optional)

Subtitles

A table containing a list of Subtitles or a single Subtitle

Subtitle

A number representing a subtitle type or a table containing a subtitle type and language
Table Members:

• Type: Number. The type of the subtitles, can have the following values
  • XGUI.SubtitlesType.Teletext
  • XGUI.SubtitlesType.OnScreen
• Lang: XMLTVString. The language of the subtitles (optional)

Ratings

A table containing a list of ratings or a single rating

Rating

A string for the rating or a table containing rating details
Table Members:

• Value: String. The rating value e.g. "PG"
• System: String. The rating system or body e.g. "BBFC" in the UK (optional)
• Icon: IconList. Program icon(s) (optional)

StarRating

Table containing a programs star rating
Table Members:

• Number: Number.
• OutOf: Number.
• Icon: IconList. Program icon(s) (optional)