Description:

This driver controls the SageTV software. SageTV allows recording and playback of TV shows on a PC equipped with a tuner card. It can also playback DVDs and other media files. The software can be found at http://www.sagetv.com. This driver should work correctly with Sage 5.0 and 6.0+.

Quirks and Limitations:

SageTV is primarily meant to record and playback TV shows, though it also supports DVD and Imported Media File playback. However, DVDs and imported files will not have the auxiliary information included such as title and description, and displayed times may not make sense.  Transport control will work correctly, however.

Connection Details

This driver connects through a TCP port.  In order to do this, you must also download and install a java plug-in. The plug-in and instructions on how to install it can be found here: http://forums.sagetv.com/forums/downloads.php?do=file&id=162.

When installing multiple copies of this driver to control extenders and other Sage clients, you will always use the IP address of the Sage Server, and whatever port you identify in the sage.properties file.

Driver Fields

This section lists the fields that the driver makes available, their types, minimum and maximum values, etc...

Name	Type	R/W	Description/Limits
PlayMode	String	R/W	Read or set the playmode. Legal values are: Play, Pause, Stop
PlayerControl	String	W	Alter the way playback proceeds. Valid settings are SkipForward1, SkipForward2, SkipBackward1, SkipBackward2, PlayFaster, PlaySlower
CurrentMediaTitle	String	R	Title of the currently playing media (if available)
CurrentMediaDescription	String	R	Description of the currently playing media (if available)
CurrentMediaDuration	Card	R	Total playing time of the current media, in seconds. Note: This value will be increasing if watching Live TV, even if playback is paused..
CurrentMediaDurationFmt	String	R	Same information as CurrentMediaDuration, but formatted as HH:MM:SS
CurrentMediaTime	Time	R	UTC Time/Date location of the currently playing media
CurrentMediaTimeElapsed	Card	R	Time difference between current media time and media start time, in seconds.
CurrentMediaTimeElapsedFmt	String	R	Same information as CurrentMediaTimeElapsed, but formatted as HH:MM:SS
CurrentMediaStartTime	Time	R	UTC Time/Date when media started.
CurrentMediaEndTime	Time	R	UTC Time/Date when media ended (or will end).
RecordedShows	StringList	R	A string list of all recorded show titles.
UpcomingRecordings	StringList	R	A string list of all upcoming recordings.
SelectedRecordedShowIndex	Card	W	When you write an index of a recorded show into this field, it causes that shows detailed information to appear in the “Selected Shows” fields. The index represents that shows place in its string list. The easiest way to accomplish this is via an Action within the list browser you'd use to display the string list.
SelectedUpcomingRecordingIndex	Card	W	When you write an index of an upcoming recording into this field, it causes that shows detailed information to appear in the “Selected Shows” fields. The index represents that shows place in its string list. The easiest way to accomplish this is via an Action within the list browser you'd use to display the string list.
WatchShow	Bool	W	Causes the currently selected recorded show to start playing in Sage.
WindowingMode	String	R/W	Get/Set the current windowing mode of Sage. Options are: Windowed and FullScreen.
SelectedShowTitle	String	R	Title of the currently selected show
SelectedShowDescription	String	R	Description of the currently selected show
SelectedShowCategory	String	R	Category of the currently selected show (categories are defined within Sage)
SelectedShowChannelNumber	String	R	Channel number the currently selected show appeared or will appear on.
SelectedShowChannelName	String	R	Channel name the currently selected show appeared or will appear on.
SelectedShowRecordDate	Time	R	Time the selected show was or will be recorded on.
SelectedShowIsHDTV	Bool	R	Indicates if selected show is in HD
SelectedShowIsFirstRun	Bool	R	Indicates if selected show is a first run (not a repeat)
SelectedShowId	Int	R	ID number of the currently selected show. This number is used internally by sage to identify the media.
SelectedShowType	String	R	Type of selected show. Options are UpcomingRecording or RecordedShow
Mute	Boolean	R/W	Get or set the mute status.
Command	String	W	Execute the following Sage Command: ChannelUp, ChannelDown, Quit, Select, Back, Forward, PageUp, PageDown, Home Left, Up, Right, Down, Record, Guide, TV, Info, Options, Power On, Power Off, Library, Time Scroll, Volume Up, Volume Down, Power, Watched, Favorite, Don't Like, Num0 through Num9, Search, Setup, Aspect Ratio Fill, 4x3, 16x9 and Source, Page Left and Right, Previous Channel, Live TV, DVD Next Chapter, DVD Prev Chapter, DVD Menu and Title Menu, DVD Return, DVD, Delete, Music Jukebox, Recording Schedule, Picture Library, Video Library, and Eject.
Channel	String	R/W	Read or write the channel number.
WatchShowPath	String	W	Immediately play the media located at the path location. This must be a format of media that Sage is able to play. This can include video files, ripped DVDs, audio files, etc.