SageTV Platform
V9.0
A B C D E F G H I K L M N P Q R S T U V W

A

about - Variable in class sage.media.rss.RSSObject
 
AddAiring(String, int, long, long) - Method in class sage.api.AiringAPI
Adds a new Airing object to the database.
AddAiringDetailed(String, int, long, long, int, int, String, boolean, boolean, boolean, boolean, boolean, String) - Method in class sage.api.AiringAPI
Adds a new Airing object to the database.
AddAiringDetailed(String, int, long, long, int, int, String, String[], String) - Method in class sage.api.AiringAPI
Adds a new Airing object to the database.
AddChannel(String, String, String, int) - Method in class sage.api.ChannelAPI
Adds a new Channel to the database.
addContent(RSSMediaContent) - Method in class sage.media.rss.RSSMediaGroup
 
addDoublinCoreElement(String, String) - Method in class sage.media.rss.RSSObject
Add a doublin core element to the object
AddElement(Collection, Object) - Method in class sage.api.Utility
Add the element with the specified value to this data.
addElement(RSSSequenceElement) - Method in class sage.media.rss.RSSSequence
Add an element to a sequence
AddFavorite(String, boolean, boolean, String, String, Person, String, String, String, String, String, String, String, String) - Method in class sage.api.FavoriteAPI
Creates a new Favorite object in SageTV.
AddGlobalContext(String, Object) - Method in class sage.api.Global
Sets the variable with the specified name to the specified value.
AddInputForRFChannel(String, int) - Method in class sage.api.CaptureDeviceAPI
Returns a CaptureDeviceInput that corresponds to using the tuner input on the CaptureDevice locked to a certain channel.
addItem(RSSItem) - Method in class sage.media.rss.RSSChannel
Add an RSSItem to a channel object
AddLibraryImportPath(String) - Method in class sage.api.Configuration
Adds a new file path to the list of paths that SageTV checks for library import files.
AddMediaFile(File, String) - Method in class sage.api.MediaFileAPI
Adds a new MediaFile to the database.
AddMusicLibraryImportPath(String) - Method in class sage.api.Configuration
Adds a new file path to the list of paths that SageTV checks for library import files.
AddPictureLibraryImportPath(String) - Method in class sage.api.Configuration
Adds a new file path to the list of paths that SageTV checks for library import files.
AddPlaylist(String) - Method in class sage.api.PlaylistAPI
Creates a new Playlist object
AddRemoteForInfraredTuningPlugin(String, int, String) - Method in class sage.api.Configuration
Creates a new 'Remote Control' with the specified name for the specified plugin.
addRSSSequence(RSSSequence) - Method in class sage.media.rss.RSSChannel
Set the channel's item's sequece
AddSecurityProfile(String) - Method in class sage.api.Security
Adds a new security profile with the specified name.
AddSeriesInfo(int, String, String, String, String, String, String, String, String, String, String[], String[]) - Method in class sage.api.SeriesInfoAPI
Call this to add a SeriesInfo object to the database.
AddShow(String, boolean, String, String, long, String, String, String[], String[], String, String[], String, String, String[], String, String, long) - Method in class sage.api.ShowAPI
Adds a new Show to the database.
AddShow(String, boolean, String, String, long, String[], String[], String[], String, String[], String, String, String[], String, String, long, int, int) - Method in class sage.api.ShowAPI
Adds a new Show to the database.
AddStaticContext(String, Object) - Method in class sage.api.Global
Sets the variable with the specified name to the specified value.
AddToGrouping(Map, Object, Object) - Method in class sage.api.Utility
Adds the specified value into the grouping using the specified key.
AddToPlaylist(Playlist, Object) - Method in class sage.api.PlaylistAPI
Adds the specified item to this Playlist.
AddTranscodeFormat(String, String) - Method in class sage.api.TranscodeAPI
Adds the specified transcode format to the list of available formats
AddTranscodeJob(MediaFile, String, File, boolean) - Method in class sage.api.TranscodeAPI
Adds the specified job to the transcoder's queue.
AddTranscodeJob(MediaFile, String, File, boolean, long, long) - Method in class sage.api.TranscodeAPI
Adds the specified job to the transcoder's queue.
AddUserRecord(String, String) - Method in class sage.api.UserRecordAPI
Creates a new UserRecord object in the database under the specified data 'Store' and with the specified 'Key'.
AddVideoDirectory(String, String, long) - Method in class sage.api.Configuration
Adds a new directory to SageTV's list of directories that it can record video to.
AddVideoLibraryImportPath(String) - Method in class sage.api.Configuration
Adds a new file path to the list of paths that SageTV checks for library import files.
AddWidget(String) - Method in class sage.api.WidgetAPI
Creates a new Widget of the specified type and adds it to the STV
AddWidgetChild(Widget, Widget) - Method in class sage.api.WidgetAPI
Creates a parent-child relationship between two Widgets.
AddWidgetWithSymbol(String, String) - Method in class sage.api.WidgetAPI
Creates a new Widget of the specified type and adds it to the STV.
AiringAPI - Class in sage.api
Airing is the 'meta' object used to access content.
AiringAPI() - Constructor for class sage.api.AiringAPI
 
AlbumAPI - Class in sage.api
Represents an Album of music.
AlbumAPI() - Constructor for class sage.api.AlbumAPI
 
Animate(String, String, String, long) - Method in class sage.api.Utility
Starts an animation for the specified Widget in the specified Layer.
AnimateDelayed(String, String, String, long, long, boolean) - Method in class sage.api.Utility
This is the same as the Animate API call; but it allows specifiying a delay that should occur before the animation actually starts.
AnimateTransition(String, String, String, String, long, long, boolean) - Method in class sage.api.Utility
Performs an Animation between two different Widgets.
AnimateVariable(String, String, String, Object, String, long, long, boolean) - Method in class sage.api.Utility
For more details on Animations see here: Animate() In addition to what's specified in the Animate API call; this also offers restricting of an Animation by a variable name and value.
AppendNodeFilter(MediaNode, String, boolean) - Method in class sage.api.MediaNodeAPI
Adds a filtering technique to used by the specified MediaNode hierarchy.
ApplyRelativeSubtitleAdjustment(int) - Method in class sage.api.MediaPlayerAPI
Adjusts the timing for subtitle display by increasing/decreasing the delay so that the sub at the relative SubCount position would be currently displayed.
ApplyServiceLevelToLineup(String, int) - Method in class sage.api.Global
Applies a service level to a given lineup.
AreAiringsSameShow(Airing, Airing) - Method in class sage.api.Global
Returns true if two Airings represent the same Show.
AreClientPluginsSupported() - Method in class sage.api.PluginAPI
Returns true if this instance of SageTV supports installation of client plugins.
AreCoreAnimationsEnabled() - Method in class sage.api.Utility
Returns whether or not animation support is enabled (either layered or Effect based animations; depending upon the STV configuration)
AreCoreAnimationsSupported() - Method in class sage.api.Utility
Returns whether or not animation support is possible in the current UI environment.
AreScreenshotsSupported() - Method in class sage.api.Global
Returns true if it's possible to take screenshots of the UI using the API on this UI client
AreThereUnresolvedConflicts() - Method in class sage.api.Global
Returns whether or not there are unresolved scheduling conflicts
AUTHOR_TAG - Static variable in class sage.media.rss.RSSHandler
 
AutorotatePictureFile(MediaFile) - Method in class sage.api.MediaFileAPI
Automatically rotates the specified picture file according to the orientation set in the EXIF data.
AutoScanChannelInfo(String, String) - Method in class sage.api.CaptureDeviceInputAPI
Tunes the CaptureDeviceInput to the specified physical channel and returns a list of the available channels.
AutoTuneChannelTest(String, String) - Method in class sage.api.CaptureDeviceInputAPI
Tunes the CaptureDeviceInput to the specified physical channel and indicates whether or not a signal is present.

B

BREAKPOINT - Static variable in class sage.media.rss.Translate
The dividing point between a simple table lookup and a binary search.
buildDcModule(Hashtable) - Static method in class sage.media.rss.RSSDoublinCoreModule
Build a RSSDoublinCoreModule object from an Hashtable

C

CachePlaceshifterLogin() - Method in class sage.api.Global
This is used to store an authentication block on the current client that it can use in the future to automatically connect to this server w/out having to login.
CalculateMD5Sum(File) - Method in class sage.api.Utility
Calculates the MD5 Sum of a given file
CanAdjustSubtitleTiming() - Method in class sage.api.MediaPlayerAPI
Returns true if the subtitles for the currently loaded file can have their timing adjusted.
CanAutorotatePictureFile(MediaFile) - Method in class sage.api.MediaFileAPI
Returns true if the specified picture file can be autorotated and is currently not in that autorotated position
CanCachePlaceshifterLogin() - Method in class sage.api.Global
This indicates whether the server and the client both support caching of placeshifter logins.
CancelBackgroundFileDownload(File) - Method in class sage.api.Global
Cancels a previous request that was made to perform a background file download.
CancelFileCopy() - Method in class sage.api.Global
Cancels a previous request that was made to perform a file copy
CancelFileDownload() - Method in class sage.api.Global
Cancels a previous request that was made to perform a file download
CancelRecord(Airing) - Method in class sage.api.AiringAPI
Cancels a recording that was previously set with a call to Record() or SetRecordingTimes()
CancelTranscodeJob(int) - Method in class sage.api.TranscodeAPI
Cancels the specified transcoding ob
CanDoNativeOutputResolution() - Method in class sage.api.Configuration
Returns true if this device can do native output resolutions (where output resolution matches the format of the media being played)
CanFileBeTranscoded(MediaFile) - Method in class sage.api.TranscodeAPI
Returns true if the specified MediaFile can be transcoded, false otherwise.
CanPluginBeDisabled(Plugin) - Method in class sage.api.PluginAPI
Returns whether the specified plugin can be enabled/disabled.
CaptureDeviceAPI - Class in sage.api
Represents a capture card or network encoder which is used to record TV.
CaptureDeviceAPI() - Constructor for class sage.api.CaptureDeviceAPI
 
CaptureDeviceInputAPI - Class in sage.api
Represents an specific input on a CaptureDevice such as the TV Tuner, Composite or S-Video inputs
CaptureDeviceInputAPI() - Constructor for class sage.api.CaptureDeviceInputAPI
 
CATEGORY_TAG - Static variable in class sage.media.rss.RSSHandler
 
CDBurnTheBurnList(Playlist) - Method in class sage.api.Global
Instructs the CD burning engine inside SageTV to start prepping the specified Playlist to be burned to a CD, and then perform the actual burn.
CDCancelBurn() - Method in class sage.api.Global
Cancels a previous request that was made to perform CD burning.
CDCancelRip() - Method in class sage.api.Global
Cancels a previous request that was made to perform CD ripping
CDGetCurrentBurnStatus() - Method in class sage.api.Global
Gets the current status of a previously invoked CD burning process.
CDGetCurrentRipStatus() - Method in class sage.api.Global
Gets the current status of a previously invoked CD ripping process.
CDRipToLibrary(File, String) - Method in class sage.api.Global
Instructs the CD ripping engine to rip the contents of a CD and encode it in MP3 format and then store it in the music library.
ChangeVideoDirectory(File, File, String, long) - Method in class sage.api.Configuration
Changes the location of a given video directory, or modifies the diskspace rule or diskspace rule size for a video directory.
CHANNEL_TAG - Static variable in class sage.media.rss.RSSHandler
 
ChannelAPI - Class in sage.api
A Channel represents a logical station on a broadcast, cable or satellite lineup.
ChannelAPI() - Constructor for class sage.api.ChannelAPI
 
ChannelDown() - Method in class sage.api.MediaPlayerAPI
Performs a logical channel down in the MediaPlayer.
ChannelSet(String) - Method in class sage.api.MediaPlayerAPI
Performs a logical channel set in the MediaPlayer.
ChannelUp() - Method in class sage.api.MediaPlayerAPI
Performs a logical channel up in the MediaPlayer.
CharacterReference - Class in sage.media.rss
Structure to hold a character and it's equivalent entity reference kernel.
CharacterReference(String, int) - Constructor for class sage.media.rss.CharacterReference
Construct a CharacterReference with the character and kernel given.
CharacterReferenceEx - Class in sage.media.rss
Extended character entity reference.
CharacterReferenceEx() - Constructor for class sage.media.rss.CharacterReferenceEx
Zero args constructor.
characters(char[], int, int) - Method in class sage.media.rss.RSSHandler
Receive notification of character data inside an element
ClearChannelMappingOnLineup(Channel, String) - Method in class sage.api.ChannelAPI
Clears any associated channel mappings that were created for this Channel on the specified Lineup
ClearDontLike(Airing) - Method in class sage.api.AiringAPI
Called to cancel the indication that the content in this Airing is "Not Liked" by the user
ClearMenuCache() - Method in class sage.api.Utility
Clears the cache that links Widgets to the in memory-menu representations for this UI.
ClearPhysicalChannelMappingsOnLineup(Channel, String) - Method in class sage.api.ChannelAPI
Clears any associated physical channel mappings that were created for this Channel on the specified Lineup
ClearRecentChannels() - Method in class sage.api.MediaPlayerAPI
Clears the list of recently viewed channels.
ClearTranscodedJobs() - Method in class sage.api.TranscodeAPI
Removes all of the completed transcode jobs from the transcoder queue
ClearWatched(Airing) - Method in class sage.api.AiringAPI
Clears the watched information for this Airing completely.
CloseAndWaitUntilClosed() - Method in class sage.api.MediaPlayerAPI
Closes the file that is currently loaded by the MediaPlayer and waits for the MediaPlayer to completely free all of its resources before returning.
CloseOptionsMenu() - Method in class sage.api.Global
Closes the last OptionsMenu that was shown and continues execution of the Action chain that spawned that OptionsMenu at the sibling after this OptionsMenu.
CloseOptionsMenu(String, boolean) - Method in class sage.api.Global
Closes the OptionsMenu who's Widget name (or themed Widget name) matches that of the argument and continues execution of the Action chain that spawned that OptionsMenu at the sibling after this OptionsMenu.
CLOUD_TAG - Static variable in class sage.media.rss.RSSHandler
 
COMMENTS_TAG - Static variable in class sage.media.rss.RSSHandler
 
compare(Object) - Method in class sage.media.rss.CharacterReferenceEx
Compare one reference to another.
compareTo(Object) - Method in class sage.media.rss.CharacterReference
Compare one reference to another.
Configuration - Class in sage.api
Configuration and properties for the whole system
Configuration() - Constructor for class sage.api.Configuration
 
ConfigureInputForEPGDataLineup(String, String) - Method in class sage.api.CaptureDeviceInputAPI
Configures this CaptureDeviceInput to use the specified EPG Lineup.
ConfigureInputWithoutEPGData(String) - Method in class sage.api.CaptureDeviceInputAPI
Configures this CaptureDeviceInput to not use an EPG data source.
ConfirmManualRecordOverFavoritePriority(Airing, Airing) - Method in class sage.api.FavoriteAPI
Confirms that the user is aware that a manual recording they've selected creates a conflict with this favorite recording.
CONTENT_ENCODED_TAG - Static variable in class sage.media.rss.RSSHandler
 
contentEncoded - Variable in class sage.media.rss.RSSItem
 
ConvertNteChars(String) - Method in class sage.api.Utility
converts a string of NTE key characters (and normal characters) into their default character representation - given by the first character in the NTE chatacter list
The NTE key characters are the Unicode characters u2460-u2468 and u24EA (Unicode Circled Digits), representing the numeric Text Keys 1-9 and 0.
The characters represented by the keys are defined by the client properties "ui/numeric_text_input_<ui/translation_language_code>_<key>_lower.
convertToChar(String, int, int) - Static method in class sage.media.rss.Translate
Deprecated. Use decode.
convertToChar(String) - Static method in class sage.media.rss.Translate
Deprecated. Use decode.
convertToString(int) - Static method in class sage.media.rss.Translate
Deprecated. Use encode.
COPY_TAG - Static variable in class sage.media.rss.RSSHandler
 
CopyToLocalFile(MediaFile, File) - Method in class sage.api.MediaFileAPI
Downloads the specified MediaFile from the SageTV server and saves it as the specified LocalFile.
CreateArray(Object) - Method in class sage.api.Utility
Creates a java.lang.Object array and initializes each element to the passed in argument.
CreateFavoritePriority(Favorite, Favorite) - Method in class sage.api.FavoriteAPI
Establishes a priority of one Favorite over another.
CreateFilePath(String, String) - Method in class sage.api.Utility
Creates a new file object for the specified directory and file name or relative path
CreateMediaNode(String, String, Object, Object, Object) - Method in class sage.api.MediaNodeAPI
Creates a static MediaNode that has no parents and no children.
CreateNewDirectory(File) - Method in class sage.api.Utility
Creates a new directory and any parent directories for the specified directory path.
CreateNewLocalDirectory(File) - Method in class sage.api.Utility
Creates a new local directory and any parent directories for the specified directory path.
CreateTempMediaFile(String) - Method in class sage.api.MediaFileAPI
Creates a temporary MediaFile object which can be used for playback later.
CreateTimedRecording(Channel, long, long, String) - Method in class sage.api.Global
Creates a new time based recording for SageTV.
CreateTimeSpan(long, long) - Method in class sage.api.Utility
Returns a length 2 Long object array which can be used for specifying a time span in a table.

D

Database - Class in sage.api
Contains methods for manipulating database objects in SageTV as well as doing general database queries NOTE: All of the 'Search' methods will be limited to 1000 results.
Database() - Constructor for class sage.api.Database
 
DataIntersection(Object, Object) - Method in class sage.api.Database
Creates an intersection of two sets of data.
DataUnion(Object, Object) - Method in class sage.api.Database
Creates a Union of one or more sets of data.
DateFormat(String, Object) - Method in class sage.api.Utility
Returns a formatted date string for the specified Date.
dc - Variable in class sage.media.rss.RSSObject
 
dc_container - Variable in class sage.media.rss.RSSObject
 
DC_CONTRIBUTOR_TAG - Static variable in class sage.media.rss.RSSHandler
 
DC_COVERAGE_TAG - Static variable in class sage.media.rss.RSSHandler
 
DC_CREATOR_TAG - Static variable in class sage.media.rss.RSSHandler
 
DC_DATE_TAG - Static variable in class sage.media.rss.RSSHandler
 
DC_DESCRIPTION_TAG - Static variable in class sage.media.rss.RSSHandler
 
DC_FORMAT_TAG - Static variable in class sage.media.rss.RSSHandler
 
DC_IDENTIFIER_TAG - Static variable in class sage.media.rss.RSSHandler
 
DC_LANGUAGE_TAG - Static variable in class sage.media.rss.RSSHandler
 
DC_PUBLISHER_TAG - Static variable in class sage.media.rss.RSSHandler
 
DC_RELATION_TAG - Static variable in class sage.media.rss.RSSHandler
 
DC_RIGHTS_TAG - Static variable in class sage.media.rss.RSSHandler
 
DC_SOURCE_TAG - Static variable in class sage.media.rss.RSSHandler
 
DC_SUBJECT_TAG - Static variable in class sage.media.rss.RSSHandler
 
DC_TITLE_TAG - Static variable in class sage.media.rss.RSSHandler
 
DC_TYPE_TAG - Static variable in class sage.media.rss.RSSHandler
 
DebugLog(String) - Method in class sage.api.Global
Prints out a message to SageTV's debug log
decode(String) - Static method in class sage.media.rss.Translate
Decode a string containing references.
decode(StringBuffer) - Static method in class sage.media.rss.Translate
Decode the characters in a string buffer containing references.
decode(InputStream, PrintStream) - Static method in class sage.media.rss.Translate
Decode a stream containing references.
DECODE_LINE_BY_LINE - Static variable in class sage.media.rss.Translate
If this member is set true, decoding of streams is done line by line in order to reduce the maximum memory required.
DeleteAllSystemMessages() - Method in class sage.api.SystemMessageAPI
Deletes all the SystemMessages from the queue.
DeleteAllUserRecords(String) - Method in class sage.api.UserRecordAPI
Deletes the all the UserRecords from the database under the specified Store.
DeleteFile(MediaFile) - Method in class sage.api.MediaFileAPI
Deletes the files that correspond to this MediaFile from disk and also deletes the MediaFile object from the database.
DeleteFilePath(File) - Method in class sage.api.Utility
Deletes the file/directory at the corresponding file path (directories must be empty first)
DeleteFileWithoutPrejudice(MediaFile) - Method in class sage.api.MediaFileAPI
Deletes the files that correspond to this MediaFile from disk and also deletes the MediaFile object from the database.
DeleteLocalFilePath(File) - Method in class sage.api.Utility
Deletes the file/directory at the corresponding local file path (directories must be empty first)
DeleteSystemMessage(SystemMessage) - Method in class sage.api.SystemMessageAPI
Deletes the specified SystemMessage from the queue.
DeleteUserRecord(UserRecord) - Method in class sage.api.UserRecordAPI
Deletes the specified UserRecord object from the database.
description - Variable in class sage.media.rss.RSSObject
 
DESCRIPTION_TAG - Static variable in class sage.media.rss.RSSHandler
 
DidImageLoadFail(Object) - Method in class sage.api.Utility
Checks whether the passed in MetaImage (from an API call that returns MetaImage), MediaFile, File, URL or Album failed to load successfully.
DirectoryListing(File) - Method in class sage.api.Utility
Returns a list of the files in the specified directory
DirectoryListing(File, String) - Method in class sage.api.Utility
Returns a list of the files in the specified directory.
DirectPlaybackControl(int, long, long) - Method in class sage.api.MediaPlayerAPI
Submits an explicit playback control request to the MediaPlayer if it supports it.
DisablePlugin(Plugin) - Method in class sage.api.PluginAPI
Disables the specified Plugin if it can be disabled.
DiscoverSageTVServers(long) - Method in class sage.api.Global
Returns a list of the SageTV servers on the network.
DOCS_TAG - Static variable in class sage.media.rss.RSSHandler
 
DoesCurrentMediaFileHaveVideo() - Method in class sage.api.MediaPlayerAPI
Returns true if the MediaPlayer has a file loading or loaded that has video content in it
DoesFavoriteMatchAiring(Favorite, Airing) - Method in class sage.api.FavoriteAPI
Returns true if the specified Favorite object matches the specified Airing object.
DoesPlaylistHaveVideo(Playlist) - Method in class sage.api.PlaylistAPI
Returns true if the specified Playlist contains any video files, false otherwise
DumpServerThreadStates() - Method in class sage.api.Utility
Dumps all the java stack information on the SageTV server process to the server's debug output stream
DurFormat(String, long) - Method in class sage.api.Utility
Returns a formatted duration String for a period of time in milliseconds.
DVDAngleChange(int) - Method in class sage.api.MediaPlayerAPI
Sets the 'Angle' for playback of the current DVD content.
DVDAudioChange(int) - Method in class sage.api.MediaPlayerAPI
Sets the audio language that should be used in the current DVD content.
DVDBurnTheBurnList(Playlist) - Method in class sage.api.Global
Instructs the DVD burning engine inside SageTV to start prepping the specified Playlist to be burned to a DVD, and then perform the actual burn.
DVDCancelBurn() - Method in class sage.api.Global
Cancels a previous request that was made to perform DVD burning.
DVDChapterNext() - Method in class sage.api.MediaPlayerAPI
Informs the MediaPlayer to start playback of the next chapter in the current DVD content.
DVDChapterPrevious() - Method in class sage.api.MediaPlayerAPI
Informs the MediaPlayer to start playback of the previous chapter in the current DVD content.
DVDChapterSet(int) - Method in class sage.api.MediaPlayerAPI
Informs the MediaPlayer to start playback of the specified chapter in the current DVD content.
DVDEnter() - Method in class sage.api.MediaPlayerAPI
Performs the 'Enter' operation when using a menu system in DVD content.
DVDGetCurrentBurnStatus() - Method in class sage.api.Global
Gets the current status of a previously invoked DVD burning process.
DVDMenu() - Method in class sage.api.MediaPlayerAPI
Performs the 'Menu' operation when playing back a DVD which should bring up the root menu of the DVD
DVDReturn() - Method in class sage.api.MediaPlayerAPI
Performs the 'Return' operation when playing back a DVD which should bring the user back to the last DVD menu they were at
DVDSubtitleChange(int) - Method in class sage.api.MediaPlayerAPI
Sets the subtitle that should be displayed in the current DVD content.
DVDSubtitleToggle() - Method in class sage.api.MediaPlayerAPI
Toggles the state for subtitle display in the DVD content being played back.
DVDTitleMenu() - Method in class sage.api.MediaPlayerAPI
Performs the 'Menu' operation when playing back a DVD which should bring up the title menu of the DVD
DVDTitleNext() - Method in class sage.api.MediaPlayerAPI
Informs the MediaPlayer to start playback of the next title in the current DVD content.
DVDTitlePrevious() - Method in class sage.api.MediaPlayerAPI
Informs the MediaPlayer to start playback of the previous title in the current DVD content.

E

EnablePlugin(Plugin) - Method in class sage.api.PluginAPI
Enables the specified Plugin if it can be enabled/disabled.
ENCLOSURE_TAG - Static variable in class sage.media.rss.RSSHandler
 
encode(int) - Static method in class sage.media.rss.Translate
Convert a character to a numeric character reference.
encode(String) - Static method in class sage.media.rss.Translate
Encode a string to use references.
encode(InputStream, PrintStream) - Static method in class sage.media.rss.Translate
Encode a stream to use references.
ENCODE_HEXADECIMAL - Static variable in class sage.media.rss.Translate
If this member is set true, encoding of numeric character references uses hexadecimal digits, i.e.
endElement(String, String, String) - Method in class sage.media.rss.RSSHandler
Receive notification of the end of an element
EnsureVisibilityForVariable(String, Object, int) - Method in class sage.api.Global
Searches the tables in the current menu for a cell that matches the passed in name/value pair; if found it will ensure that it is currently visible in the UI at the specified visual index of the table.
EvaluateExpression(String) - Method in class sage.api.WidgetAPI
Evaluates the passed in expression and returns the result.
ExecuteProcess(String, Object, File, boolean) - Method in class sage.api.Utility
Executes a new process on the system
ExecuteProcessReturnOutput(String, Object, File, boolean, boolean) - Method in class sage.api.Utility
Executes a new process on the system and returns as a String the output of the process
ExecuteWidgetChain(Widget) - Method in class sage.api.WidgetAPI
Executes a Widget and the chain of child Widgets underneath it
ExecuteWidgetChainInCurrentMenuContext(Widget) - Method in class sage.api.WidgetAPI
Executes a Widget and the chain of child Widgets underneath it.
Exit() - Method in class sage.api.Global
Causes the SageTV application to terminate.

F

FavoriteAPI - Class in sage.api
Favorites are objects which are used for repeated recording in SageTV
FavoriteAPI() - Constructor for class sage.api.FavoriteAPI
 
FilterByBoolMethod(Object, String, boolean) - Method in class sage.api.Database
Filters data by a boolean method.
FilterByMethod(Object, String, Object, boolean) - Method in class sage.api.Database
Filters data by a method.
FilterByMethodRegex(Object, String, Pattern, boolean, boolean) - Method in class sage.api.Database
Filters data by a method.
FilterByRange(Object, String, Comparable, Comparable, boolean) - Method in class sage.api.Database
Filters data by a comparable range.
FindComparativeElement(Object, Comparable, String) - Method in class sage.api.Utility
Searches a sorted list of data to find the index that the specified criteria exists at; or if it doesn't exist in the data it will use the index that would be the appropriate insertion point for the criteria in the data in order to maintain sort order.
FindElementIndex(Object, Object) - Method in class sage.api.Utility
Returns the index in the data that the specified element is found at.
FindWidgetBySymbol(String) - Method in class sage.api.WidgetAPI
Returns the Widget represented by the specified UID symbol
FlipPictureFile(MediaFile, boolean) - Method in class sage.api.MediaFileAPI
Performs a lossless flip of the specified JPEG picture file.
Fork() - Method in class sage.api.Global
Spawns a new thread of execution that will be used for further processing of Widget chain.
free() - Method in class sage.media.rss.RSSParser
Call it at the end of the work to preserve memory

G

GenerateThumbnail(MediaFile, float, int, int, File) - Method in class sage.api.MediaFileAPI
Generates a thumbnail for the specified MediaFile at the requested offset time in the file using the desired width & height.
GENERATOR_TAG - Static variable in class sage.media.rss.RSSHandler
 
getAboutAttribute() - Method in class sage.media.rss.RSSObject
Get about attribute of element
GetAbsoluteFilePath(File) - Method in class sage.api.Utility
Returns the full path name from the specified file path..
GetActiveCaptureDevices() - Method in class sage.api.CaptureDeviceAPI
Returns all of the CaptureDevices that are currently configured for use by SageTV
GetActiveSecurityProfile() - Method in class sage.api.Security
Returns the name of the current security profile for the UI client making the API call.
GetAiringAttributeList(Airing) - Method in class sage.api.AiringAPI
Gets a list of attributes that are set for this Airing.
GetAiringChannelName(Airing) - Method in class sage.api.AiringAPI
Gets the name of the Channel that this Airing is on
GetAiringChannelNumber(Airing) - Method in class sage.api.AiringAPI
Gets the channel number that this Airing is on
GetAiringDuration(Airing) - Method in class sage.api.AiringAPI
Gets the duration of this Airing in milliseconds
GetAiringEndTime(Airing) - Method in class sage.api.AiringAPI
Gets the end time of this Airing.
GetAiringForID(int) - Method in class sage.api.AiringAPI
Returns the Airing object that corresponds to the passed in ID.
GetAiringID(Airing) - Method in class sage.api.AiringAPI
Returns the unique ID used to identify this Airing.
GetAiringOnAfter(Airing) - Method in class sage.api.AiringAPI
Returns the Airing on the same Channel that is on immediately after the passed in Airing
GetAiringOnBefore(Airing) - Method in class sage.api.AiringAPI
Returns the Airing on the same Channel that is on immediately before the passed in Airing
GetAiringPartNumber(Airing) - Method in class sage.api.AiringAPI
Returns the part number for this Airing if it is a multi-part Airing.
GetAiringPremiereFinaleInfo(Airing) - Method in class sage.api.AiringAPI
Returns a String which describes any kind of Premiere, Finale info for this Airing
GetAiringRatings(Airing) - Method in class sage.api.AiringAPI
Gets the list of the field values which correspond to parental ratings control for this Airing
GetAiringsForShow(Show, long) - Method in class sage.api.ShowAPI
Returns a list of all of the Airings for the specified Show starting after the specified time.
GetAiringsOnChannelAtTime(Channel, long, long, boolean) - Method in class sage.api.Database
Returns all of the Airing objects in the database that are on the specified channel during the specified time span.
GetAiringsOnViewableChannelsAtTime(long, long, boolean) - Method in class sage.api.Database
Returns all of the Airing objects in the database on all of the channels that are viewable during the specified time span.
GetAiringStartTime(Airing) - Method in class sage.api.AiringAPI
Gets the start time of this Airing.
GetAiringsThatWontBeRecorded(boolean) - Method in class sage.api.Global
Returns all of the Airings that the user has requested to record that SageTV will not be recording.
GetAiringTitle(Airing) - Method in class sage.api.AiringAPI
Gets the title of this Airing.
GetAiringTotalParts(Airing) - Method in class sage.api.AiringAPI
Returns the number of parts for this Airing if it is a multi-part Airing.
GetAlbumArt(Album) - Method in class sage.api.AlbumAPI
Returns the album art for this Album.
GetAlbumArtist(Album) - Method in class sage.api.AlbumAPI
Returns the artist for this Album.
GetAlbumForFile(MediaFile) - Method in class sage.api.MediaFileAPI
Gets the Album object that corresponds to this MediaFile.
GetAlbumGenre(Album) - Method in class sage.api.AlbumAPI
Returns the genre for this Album
GetAlbumName(Album) - Method in class sage.api.AlbumAPI
Returns the name/title for this Album
GetAlbums() - Method in class sage.api.AlbumAPI
Returns all of the Album objects in the library.
GetAlbumTracks(Album) - Method in class sage.api.AlbumAPI
Gets all of the Airings (a 'meta' object referring to the music file in this case) that are on this Album in the library.
GetAlbumYear(Album) - Method in class sage.api.AlbumAPI
Returns the year this Album was recorded in
GetAllAvailablePlugins() - Method in class sage.api.PluginAPI
Returns an array of Plugin objects which represent all the plugins available in the plugin repository.
GetAllCategories() - Method in class sage.api.Database
Gets all of the categories that are in the database.
GetAllCategories(String) - Method in class sage.api.Database
Gets all of the categories that are in the database.
GetAllChannels() - Method in class sage.api.ChannelAPI
Returns all of the Channels that are defined in the system
GetAllGroupingCategories() - Method in class sage.api.Database
Gets all of the categories that are in the database.
GetAllGroupingCategories(String) - Method in class sage.api.Database
Gets all of the categories that are in the database.
GetAllLineups() - Method in class sage.api.Global
Returns the name of all the EPG lineups in the system
GetAllMusicArtists() - Method in class sage.api.AlbumAPI
Returns all of the artists for the music files in the library
GetAllMusicForArtist(String) - Method in class sage.api.AlbumAPI
Gets all of the Airings (a 'meta' object referring to the music file in this case) that have an artist that matches the passed in artist
GetAllMusicForGenre(String) - Method in class sage.api.AlbumAPI
Gets all of the Airings (a 'meta' object referring to the music file in this case) that have a genre that matches the passed in genre
GetAllMusicGenres() - Method in class sage.api.AlbumAPI
Returns all of the genres for the music files in the library
GetAllNodeDescendants(MediaNode) - Method in class sage.api.MediaNodeAPI
Returns the data set that represents all the children under the specified MediaNode if that data set has already been realized.
GetAllNonMusicWithPerson(String) - Method in class sage.api.Database
Deprecated.  
GetAllNonMusicWithTitle(String) - Method in class sage.api.Database
Deprecated.  
GetAllPeople() - Method in class sage.api.Database
Gets all of the people that are in the database.
GetAllPeople(String) - Method in class sage.api.Database
Gets all of the people that are in the database.
GetAllPluginVersions(Object) - Method in class sage.api.PluginAPI
Returns an array of Plugin objects which represent all of the versions available of the specified plugin in the repository
GetAllSeriesInfo() - Method in class sage.api.SeriesInfoAPI
Returns a list of all of the SeriesInfo which is information about television series
GetAllTimeZones() - Method in class sage.api.Configuration
Gets the list of all of the valid time zone names
GetAllTitles() - Method in class sage.api.Database
Gets all of the titles that are in the database.
GetAllTitles(String) - Method in class sage.api.Database
Gets all of the titles that are in the database.
GetAllTVEditorials() - Method in class sage.api.TVEditorialAPI
Returns a list of all of the 'TV Editorials' which are stories about TV shows
GetAllUserRecords(String) - Method in class sage.api.UserRecordAPI
Gets all existing UserRecord objects that exist under the specified data Store.
GetAllUserStores() - Method in class sage.api.UserRecordAPI
Gets all existing Stores that UserRecord objects have been created under in the database.
GetAllWidgets() - Method in class sage.api.WidgetAPI
Gets all of the Widgets that are in the currently loaded STV
GetAnalogVideoFormat() - Method in class sage.api.Configuration
Gets the analog video format that should be used for capture and playback.
GetApplicationLaunchTime() - Method in class sage.api.Global
Returns the time that the SageTV application was instantiated.
GetAspectRatioMode() - Method in class sage.api.Configuration
Returns the localized name of the aspect ratio mode currently in use.
GetAspectRatioModes() - Method in class sage.api.Configuration
Gets the list of localized names for the aspect ratio modes
GetAudioCaptureSources() - Method in class sage.api.CaptureDeviceAPI
Returns an array of all the audio capture sources in the system, used with SetCaptureDeviceAudioSource(CaptureDevice, AudioSource)
GetAudioDecoderFilter() - Method in class sage.api.Configuration
Gets the name of the DirectShow audio decoder filter that's used for MPEG2 playback (Windows only)
GetAudioDecoderFilters() - Method in class sage.api.Configuration
Gets the list of the audio decoder filters that are available in the system for MPEG2 playback (Windows only)
GetAudioDelay() - Method in class sage.api.Configuration
Gets the audio delay in milliseconds to apply when playing back MPEG2 files (Windows only)
GetAudioOutput() - Method in class sage.api.Configuration
Returns a string describing the currently selected audio output (empty string if this can't be configured)
GetAudioOutputOptions() - Method in class sage.api.Configuration
Returns a list of the possible audio outputs.
GetAudioRendererFilters() - Method in class sage.api.Configuration
Gets the list of DirectShow audio renderer filters that are available on the system (Windows Only).
GetAudioRenderFilter() - Method in class sage.api.Configuration
Gets the name of the DirectShow audio renderer filter that's used for all playback except DVDs (Windows only)
getAuthor() - Method in class sage.media.rss.RSSItem
Get the item's author
GetAutodialForInternet() - Method in class sage.api.Configuration
Returns true if SageTV should attempt to autodial before accessing the Internet
GetAvailableCountries() - Method in class sage.api.Configuration
Gets the names of the countries that can be used in the SetCountry() call.
GetAvailablePluginForID(String) - Method in class sage.api.PluginAPI
Returns the plugin in the repository for the specified plugin ID
GetAvailableSeekingEnd() - Method in class sage.api.MediaPlayerAPI
Gets the latest time that the current media can be seeked to using the Seek() call.
GetAvailableSeekingStart() - Method in class sage.api.MediaPlayerAPI
Gets the earliest time that the current media can be seeked to using the Seek() call.
GetAvailableUILanguages() - Method in class sage.api.Configuration
Gets the list of languages that are available to be used for the user interface.
GetBackgroundFileDownloadStatus(File) - Method in class sage.api.Global
Gets the current status of a previously invoked file background download process.
GetBackgroundFileDownloadStreamTime(File) - Method in class sage.api.Global
Gets the current stream time of a previously invoked file download process.
GetBackgroundFileDownloadTotalSize(File) - Method in class sage.api.Global
Gets the total size of the specified background download target.
GetBitTimeForInfraredTuningPlugin(String, int, String) - Method in class sage.api.Configuration
Gets the 'bit time' detected by this plugin for the specified remote
GetBluRayTitleDescription(int) - Method in class sage.api.MediaPlayerAPI
Returns a description of the specified title number if playing back a BluRay.
GetButtonDelayForInfraredTuningPlugin(String, int, String) - Method in class sage.api.Configuration
Gets the minimum delay in milliseconds that is required between sending consecutive commands using the specified 'Remote Control'.
GetCaptureBrightness(String) - Method in class sage.api.CaptureDeviceInputAPI
Gets the brightness level for this CaptureDeviceInput.
GetCaptureContrast(String) - Method in class sage.api.CaptureDeviceInputAPI
Gets the contrast level for this CaptureDeviceInput.
GetCaptureDeviceAudioSource(String) - Method in class sage.api.CaptureDeviceAPI
Gets the audio capture source for a corresponding CaptureDevice.
GetCaptureDeviceBroadcastStandard(String) - Method in class sage.api.CaptureDeviceAPI
Returns the name of the broadcast standard used for reception on this capture device.
GetCaptureDeviceCurrentRecordFile(String) - Method in class sage.api.CaptureDeviceAPI
Returns the file that is currently being recorded by this capture device
GetCaptureDeviceDefaultQuality(String) - Method in class sage.api.CaptureDeviceAPI
Returns the default recording qualities for this CaptureDevice.
GetCaptureDeviceForInput(String) - Method in class sage.api.CaptureDeviceInputAPI
Returns the CaptureDevice for this CaptureDeviceInput
GetCaptureDeviceInputBeingViewed() - Method in class sage.api.CaptureDeviceInputAPI
Returns the CaptureDeviceInput that is recording the MediaFile that is currently loaded by the MediaPlayer
GetCaptureDeviceInputBroadcastStandard(String) - Method in class sage.api.CaptureDeviceInputAPI
Returns the name of the broadcast standard used for reception on this capture device input (can be different per-input)
GetCaptureDeviceInputName(String) - Method in class sage.api.CaptureDeviceInputAPI
Returns the name of this CaptureDeviceInput connection without the CaptureDevice name prefixing it.
GetCaptureDeviceInputRecordingMediaFile(MediaFile) - Method in class sage.api.CaptureDeviceInputAPI
Returns the CaptureDeviceInput that is recording the specified MediaFile
GetCaptureDeviceInputs(String) - Method in class sage.api.CaptureDeviceAPI
Returns all of the CaptureDeviceInputs for a given CaptureDevice.
GetCaptureDeviceMerit(String) - Method in class sage.api.CaptureDeviceAPI
Gets the encoder merit for a CaptureDevice.
GetCaptureDeviceQualities(String) - Method in class sage.api.CaptureDeviceAPI
Returns the recording qualities which are supported by this CaptureDevice
GetCaptureDevices() - Method in class sage.api.CaptureDeviceAPI
Returns all of the CaptureDevices in the system that SageTV can use
GetCaptureHue(String) - Method in class sage.api.CaptureDeviceInputAPI
Gets the hue level for this CaptureDeviceInput.
GetCaptureSaturation(String) - Method in class sage.api.CaptureDeviceInputAPI
Gets the saturation level for this CaptureDeviceInput.
GetCaptureSharpness(String) - Method in class sage.api.CaptureDeviceInputAPI
Gets the sharpness level for this CaptureDeviceInput.
GetCarrierFrequencyForInfraredTuningPlugin(String, int, String) - Method in class sage.api.Configuration
Gets the carrier frequency detected by this plugin for the specified remote
GetChannel(Airing) - Method in class sage.api.AiringAPI
Gets the Channel that this Airing is on
GetChannelDescription(Channel) - Method in class sage.api.ChannelAPI
Gets the descriptive name for this Channel.
GetChannelForStationID(int) - Method in class sage.api.ChannelAPI
Returns the Channel object that has the corresponding station ID.
GetChannelLogo(Channel) - Method in class sage.api.ChannelAPI
Gets the logo image for the specified Channel if one exists
GetChannelLogo(Channel, String, int, boolean) - Method in class sage.api.ChannelAPI
Returns a Channel logo for the requested Channel if one exists.
GetChannelLogoCount(Channel) - Method in class sage.api.ChannelAPI
Returns a count of logos for this channel.
GetChannelLogoURL(Channel) - Method in class sage.api.ChannelAPI
Gets the URL of the logo image for the specified Channel if one exists
GetChannelLogoURL(Channel, String, int, boolean) - Method in class sage.api.ChannelAPI
Returns a Channel logo URL for the requested Channel if one exists.
GetChannelName(Channel) - Method in class sage.api.ChannelAPI
Gets the name for this Channel.
GetChannelNetwork(Channel) - Method in class sage.api.ChannelAPI
Gets the name of the associated network for this Channel.
GetChannelNumber(Channel) - Method in class sage.api.ChannelAPI
Gets the channel number to tune to for this Channel.
GetChannelNumberForLineup(Channel, String) - Method in class sage.api.ChannelAPI
Gets the channel number to tune to for this Channel on the specified lineup.
GetChannelNumbersForLineup(Channel, String) - Method in class sage.api.ChannelAPI
Gets the channel numbers which can be used to tune this Channel on the specified lineup.
GetChannelsOnLineup(String) - Method in class sage.api.Database
Returns all of the Channel objects in the database that are on the specified Lineup.
getCharacter() - Method in class sage.media.rss.CharacterReference
Get the character needing translation.
GetChildrenCheckedCount(MediaNode, boolean) - Method in class sage.api.MediaNodeAPI
Returns the number of children of the specified MediaNode that are in the specified checked state.
GetChildrenCheckedNodes(MediaNode, boolean) - Method in class sage.api.MediaNodeAPI
Returns the children of the specified MediaNode that are in the specified checked state.
GetChildUIComponentForVariable(Object, String, Object) - Method in class sage.api.Global
Searches all child UI elements in of the specified UIComponent until it finds one that has a variable with the specified name matching the specified value.
getCleanDescription() - Method in class sage.media.rss.RSSItem
 
GetClientPluginIncompatabilityReason(Plugin) - Method in class sage.api.PluginAPI
Returns the reason why the specified Plugin object is incompatible and cannot be installed.
GetClientPluginProgress() - Method in class sage.api.PluginAPI
Returns a progress based status message regarding any current plugin installation.
GetClientServerConnectionProgress() - Method in class sage.api.Global
Returns a string describing the state of the client/server connection process.
GetCommandsForInfraredTuningPlugin(String, int, String) - Method in class sage.api.Configuration
Gets the list of commands for the specified 'Remote Control' for the specified plugin
getComments() - Method in class sage.media.rss.RSSItem
Get the comments url
GetConfiguredCaptureDeviceInputs() - Method in class sage.api.CaptureDeviceAPI
Returns all of the CaptureDeviceInputs that are currently configured for use by SageTV.
GetConfirmCommandForInfraredTuningPlugin(String, int, String) - Method in class sage.api.Configuration
Gets the command that is to be sent as the last command to complete a channel change sequence.
GetConnectedClients() - Method in class sage.api.Global
Returns a list of all the clients that are currently connected to this server.
GetConstantRFChannelInput(String) - Method in class sage.api.CaptureDeviceInputAPI
Returns the RF channel number that is used to receive the source signal.
getContent() - Method in class sage.media.rss.RSSMediaGroup
 
getContentEncoded() - Method in class sage.media.rss.RSSItem
 
getCopyright() - Method in class sage.media.rss.RSSChannel
Get the chyannel's copyright
GetCountry() - Method in class sage.api.Configuration
Gets the country that SageTV is configured for.
GetCurrentlyAiringProgramsStartLive() - Method in class sage.api.Configuration
Returns true if the system is configured to start any program that is currently airing from live, false otherwise
GetCurrentlyRecordingMediaFiles() - Method in class sage.api.Global
Returns a list of all of the files that SageTV is currently recording
GetCurrentMediaFile() - Method in class sage.api.MediaPlayerAPI
Returns the MediaFile object that is currently loaded (or loading) by the MediaPlayer
GetCurrentMediaTitle() - Method in class sage.api.MediaPlayerAPI
Returns the title of the content that is currently loaded by the MediaPlayer.
GetCurrentMenuWidget() - Method in class sage.api.WidgetAPI
Gets the Widget the defines the menu that is currently loaded by the system
GetCurrentPlaylist() - Method in class sage.api.MediaPlayerAPI
Returns the current Playlist that is being played back by the MediaPlayer.
GetCurrentPlaylistIndex() - Method in class sage.api.MediaPlayerAPI
Returns the 0-based index into the root Playlist that is currently being played back by the MediaPlayer.
GetCurrentSTVFile() - Method in class sage.api.WidgetAPI
Gets the STV file that is currently loaded by the system
GetDatabaseLastModifiedTime(String) - Method in class sage.api.Database
Returns the last modification time for objects that match anything in the specified MediaMask.
GetDataFromTableFocusedOffset(Object, int, boolean) - Method in class sage.api.Global
Gets the data value for the table that is used for the cell at the specified position relative to what is currently focused for the table.
GetDataFromTableVisiblePosition(Object, int, boolean) - Method in class sage.api.Global
Gets the data value for the table that is used for the cell at the specified position relative to what is currently visible for the table.
getDate() - Method in class sage.media.rss.RSSItem
Get the date
getDcContributor() - Method in class sage.media.rss.RSSDoublinCoreModule
Get the contributor
getDcCoverage() - Method in class sage.media.rss.RSSDoublinCoreModule
Get the coverage
getDcCreator() - Method in class sage.media.rss.RSSDoublinCoreModule
Get the creator
getDcDate() - Method in class sage.media.rss.RSSDoublinCoreModule
Get the date
getDcDescription() - Method in class sage.media.rss.RSSDoublinCoreModule
Get description
getDcFormat() - Method in class sage.media.rss.RSSDoublinCoreModule
The format
getDcIdentifier() - Method in class sage.media.rss.RSSDoublinCoreModule
Get the identifier
getDcLanguage() - Method in class sage.media.rss.RSSDoublinCoreModule
Get the language
getDcPublisher() - Method in class sage.media.rss.RSSDoublinCoreModule
Get the publischer
getDcRelation() - Method in class sage.media.rss.RSSDoublinCoreModule
Get the declaration
getDcRight() - Method in class sage.media.rss.RSSDoublinCoreModule
The Right
getDcSource() - Method in class sage.media.rss.RSSDoublinCoreModule
Get the source
getDcSubject() - Method in class sage.media.rss.RSSDoublinCoreModule
Get the subject
getDcTitle() - Method in class sage.media.rss.RSSDoublinCoreModule
Get the title
getDcType() - Method in class sage.media.rss.RSSDoublinCoreModule
Get the type
GetDefaultAudioLanguage() - Method in class sage.api.Configuration
Gets the name of the preferred default language when selecting which audio stream to playback.
GetDefaultRecordingQuality() - Method in class sage.api.Configuration
Gets the name of the default quality that is used to record television.
GetDefaultSecurityProfile() - Method in class sage.api.Security
Returns the name of the default security profile to use when a new client connects that does not have an associated security profile.
GetDefaultSTVFile() - Method in class sage.api.WidgetAPI
Returns the file path for the default STV file
GetDefaultSubpicLanguage() - Method in class sage.api.Configuration
Gets the name of the preferred default language when selecting which subpicture stream to playback.
getDescription() - Method in class sage.media.rss.RSSObject
Get the element's description
GetDiskFreeSpace(String) - Method in class sage.api.Utility
Returns the amount of disk free space in bytes at the specified path
GetDiskspaceRuleForVideoDirectory(File) - Method in class sage.api.Configuration
Returns the diskspace rule that SageTV should use when managing the disk space in a given directory.
GetDiskspaceSizeForVideoDirectory(File) - Method in class sage.api.Configuration
Returns the size (in bytes) that should be applied to the specified directory for its configured diskspace rule
GetDiskTotalSpace(String) - Method in class sage.api.Utility
Returns the amount of total disk space in bytes at the specified path
GetDisplayAspectRatio() - Method in class sage.api.Configuration
Returns the display aspect ratio that is set for the current display device being used
GetDisplayResolution() - Method in class sage.api.Global
Returns a string describing the current display resolution set
GetDisplayResolutionDetails(String) - Method in class sage.api.Global
Returns the detailed format description for the specific resolution returned from GetDisplayResolutionOptions() NOTE: This API call is only valid on embedded platforms.
GetDisplayResolutionHeight() - Method in class sage.api.Global
Returns the height in pixels of the current display resolution set
GetDisplayResolutionOptions() - Method in class sage.api.Global
Returns a list of the possible display resolutions.
GetDisplayResolutionWidth() - Method in class sage.api.Global
Returns the width in pixels of the current display resolution set
GetDNSAddress() - Method in class sage.api.Utility
Returns the DNS address for the currently configured network adapter.
getDocs() - Method in class sage.media.rss.RSSChannel
Get the docs url about Rss specifications
getDoublinCoreElements() - Method in class sage.media.rss.RSSObject
Get DC element by hashtable
GetDscalerMode() - Method in class sage.api.Configuration
Gets the mode that DScaler is currently configured to run in when it is used (Windows only)
GetDscalerModes() - Method in class sage.api.Configuration
Gets the list of the available modes that DScaler can be run in
GetDscalerPlugin() - Method in class sage.api.Configuration
Gets the plugin that DScaler is currently configured to use when it is in "Plugin" mode.
GetDscalerPlugins() - Method in class sage.api.Configuration
Returns the list of plugins that are supported by DScaler.
getDuration() - Method in class sage.media.rss.RSSItem
 
getDuration() - Method in class sage.media.rss.RSSMediaContent
 
GetDurationForSegment(MediaFile, int) - Method in class sage.api.MediaFileAPI
Returns the duration in milliseconds for the specified segment number in this MediaFile.
GetDVBCRegion() - Method in class sage.api.Configuration
Gets the the provider within the current country that the user has for DVB-C tuning purposes.
GetDVBCRegions() - Method in class sage.api.Configuration
Gets the names of the DVB-C providers for the configured country which are used for dividing it up into different areas for DVB-C reception.
GetDVBSRegion() - Method in class sage.api.Configuration
Gets the the provider within the current country that the user has for DVB-S tuning purposes.
GetDVBSRegions() - Method in class sage.api.Configuration
Gets the names of the providers for the configured country which are used for dividing it up into different areas for DVB-S reception.
GetDVBTRegion() - Method in class sage.api.Configuration
Gets the the region within the current country that the user is in for DVB-T tuning purposes.
GetDVBTRegions() - Method in class sage.api.Configuration
Gets the names of the regions for the configured country which are used for dividing it up into different areas for DVB-T reception.
GetDVDAudioDecoderFilter() - Method in class sage.api.Configuration
Gets the name of the DirectShow audio decoder filter that's used for DVD playback (Windows only)
GetDVDAudioRenderFilter() - Method in class sage.api.Configuration
Gets the name of the DirectShow audio renderer filter that's used for DVD playback (Windows only)
GetDVDAvailableLanguages() - Method in class sage.api.MediaPlayerAPI
Gets a list of all of the audio languages that are currently available in the current DVD content
GetDVDAvailableSubpictures() - Method in class sage.api.MediaPlayerAPI
Gets a list of all of the subtitles that are currently available in the current DVD content
GetDVDCurrentAngle() - Method in class sage.api.MediaPlayerAPI
Gets the current angle number that is being played back for DVD content
GetDVDCurrentChapter() - Method in class sage.api.MediaPlayerAPI
Gets the current chapter number that is being played back for DVD content.
GetDVDCurrentDomain() - Method in class sage.api.MediaPlayerAPI
Gets the current 'domain' that the DVD playback is in.
GetDVDCurrentLanguage() - Method in class sage.api.MediaPlayerAPI
Gets the current audio playback language that is being used for the current DVD content
GetDVDCurrentSubpicture() - Method in class sage.api.MediaPlayerAPI
Gets the current subtitle that is being used for the current DVD content
GetDVDCurrentTitle() - Method in class sage.api.MediaPlayerAPI
Gets the current title number that is being played back for DVD content.
GetDVDDXVADeinterlaceMode() - Method in class sage.api.Configuration
Gets the preferred DXVA Deinterlacing configuration setting (Windows only).
GetDVDDXVAMpegMode() - Method in class sage.api.Configuration
Gets the preferred DXVA MPEG Mode configuration setting (Windows only).
GetDVDNumberOfAngles() - Method in class sage.api.MediaPlayerAPI
Gets the total number of angles that are currently available to select from in the current DVD content
GetDVDNumberOfChapters() - Method in class sage.api.MediaPlayerAPI
Gets the total number of chapters in the current title in the current DVD content
GetDVDNumberOfTitles() - Method in class sage.api.MediaPlayerAPI
Gets the total number of titles in the current DVD content
GetDVDVideoDecoderFilter() - Method in class sage.api.Configuration
Gets the name of the DirectShow video decoder filter that's used for DVD playback (Windows only)
GetDVDVideoRenderFilter() - Method in class sage.api.Configuration
Gets the video renderer filter that should be used for DVD playback.
GetDXVADeinterlaceMode() - Method in class sage.api.Configuration
Gets the preferred DXVA Deinterlacing configuration setting (Windows only).
GetDXVADeinterlaceModes() - Method in class sage.api.Configuration
Gets the list of potential DXVA Deinterlacing Capabilities (Widows only)
GetDXVAMpegMode() - Method in class sage.api.Configuration
Gets the preferred DXVA MPEG Mode configuration setting (Windows only).
GetDXVAMpegModes() - Method in class sage.api.Configuration
Gets the list of available DXVA MPEG Modes.
GetEditorialAirDate(TVEditorial) - Method in class sage.api.TVEditorialAPI
Returns a String representing the airing date for the content the editorial is about
GetEditorialImage(TVEditorial) - Method in class sage.api.TVEditorialAPI
Returns the image that corresponds to this editorial if there is one
GetEditorialNetwork(TVEditorial) - Method in class sage.api.TVEditorialAPI
Returns the network that the Show for this editorial is broadcast on
GetEditorialShow(TVEditorial) - Method in class sage.api.TVEditorialAPI
Returns the Show for the specified TVEditorial
GetEditorialText(TVEditorial) - Method in class sage.api.TVEditorialAPI
Returns the text for the specified TVEditorial
GetEditorialTitle(TVEditorial) - Method in class sage.api.TVEditorialAPI
Returns the title for the specified TVEditorial
GetElement(Object, int) - Method in class sage.api.Utility
Returns the element at the specified index in this data; works for arrays and java.util.List implementations (i.e.
getElementList() - Method in class sage.media.rss.RSSSequence
Return the element of a squence into a LinkedList
GetEmbeddedPanel() - Method in class sage.api.Global
Gets a java.awt.Panel which can be used for embedding Java UI elements directly into SageTV
getEnclosure() - Method in class sage.media.rss.RSSItem
 
GetEndForSegment(MediaFile, int) - Method in class sage.api.MediaFileAPI
Gets the ending time for a specified segment number in this MediaFile.
GetEPGUpdateState() - Method in class sage.api.Global
Returns a string describing the state of the epg system.
getExpression() - Method in class sage.media.rss.RSSMediaContent
 
GetExtraAiringDetails(Airing) - Method in class sage.api.AiringAPI
Gets miscellaneous information about this Airing.
GetFavoriteAirings(Favorite) - Method in class sage.api.FavoriteAPI
Returns a list of all of the Airings in the database that match this Favorite.
GetFavoriteAutomaticConversionDestination(Favorite) - Method in class sage.api.FavoriteAPI
Gets the directory that automatic conversions of this favorite should be saved to.
GetFavoriteAutomaticConversionFormat(Favorite) - Method in class sage.api.FavoriteAPI
Gets the name of the format that recordings of this Favorite will automatically be converted to when they have completed recording.
GetFavoriteCategory(Favorite) - Method in class sage.api.FavoriteAPI
Returns the category that an Airing must match to be included in this Favorite.
GetFavoriteChannel(Favorite) - Method in class sage.api.FavoriteAPI
Returns the channel name (call sign) that an Airing must be on to be included in this Favorite.
GetFavoriteDescription(Favorite) - Method in class sage.api.FavoriteAPI
Returns a String that describes this Favorite.
GetFavoriteForAiring(Airing) - Method in class sage.api.FavoriteAPI
Gets the Favorite that matches this Airing if one exists.
GetFavoriteForID(int) - Method in class sage.api.FavoriteAPI
Gets the Favorite object with the corresponding ID from the database.
GetFavoriteID(Favorite) - Method in class sage.api.FavoriteAPI
Gets a unique ID for this Favorite which can be used with GetFavoriteForID() for retrieving the object later.
GetFavoriteKeyword(Favorite) - Method in class sage.api.FavoriteAPI
Returns the keyword string that an Airing must match to be included in this Favorite.
GetFavoriteNetwork(Favorite) - Method in class sage.api.FavoriteAPI
Returns the network name that an Airing must be on to be included in this Favorite.
GetFavoriteParentalRating(Favorite) - Method in class sage.api.FavoriteAPI
Returns the parental rating that an Airing must match to be included in this Favorite.
GetFavoritePerson(Favorite) - Method in class sage.api.FavoriteAPI
Returns the person that an Airing must have to be included in this Favorite.
GetFavoritePersonRole(Favorite) - Method in class sage.api.FavoriteAPI
Returns the role that an Airing must have the Favorite Person in to be included in this Favorite.
GetFavoritePresentationName(Favorite) - Method in class sage.api.FavoriteAPI
Returns a String that describes this Favorite in a 'clean' way.
GetFavoritePresentationPrefix(Favorite) - Method in class sage.api.FavoriteAPI
Returns a String that describes this type of Favorite this is, such as Show, Keyword, Person, etc.
GetFavoriteProperties(Favorite) - Method in class sage.api.FavoriteAPI
Returns a java.util.Properties object that has all of the user-set properties for this Favorite in it.
GetFavoriteProperty(Favorite, String) - Method in class sage.api.FavoriteAPI
Returns a property value for a specified Favorite.
GetFavoriteQuality(Favorite) - Method in class sage.api.FavoriteAPI
Gets the name of the recording quality that should be used when recording this Favorite.
GetFavoriteRated(Favorite) - Method in class sage.api.FavoriteAPI
Returns the rating that an Airing must match to be included in this Favorite.
GetFavorites() - Method in class sage.api.FavoriteAPI
Gets all of the Favorite objects from the database
GetFavoritesForAiring(Airing) - Method in class sage.api.FavoriteAPI
Gets the list of all Favorites that match this Airing
GetFavoriteSubCategory(Favorite) - Method in class sage.api.FavoriteAPI
Returns the subcategory that an Airing must match to be included in this Favorite.
GetFavoriteTimeslot(Favorite) - Method in class sage.api.FavoriteAPI
Returns the timeslot that an Airing must be in to be included in this Favorite.
GetFavoriteTitle(Favorite) - Method in class sage.api.FavoriteAPI
Returns the title that an Airing must match to be included in this Favorite.
GetFavoriteYear(Favorite) - Method in class sage.api.FavoriteAPI
Returns the year that an Airing must match to be included in this Favorite.
GetFileAsString(File) - Method in class sage.api.Utility
Opens the file at the specified path and reads the entire contents of it and returns it as a String.
GetFileCopyStatus() - Method in class sage.api.Global
Gets the current status of a previously invoked file copy process.
GetFileDownloadStatus() - Method in class sage.api.Global
Gets the current status of a previously invoked file download process.
GetFileDownloadStreamTime() - Method in class sage.api.Global
Gets the current stream time of a previously invoked file download process.
GetFileDuration(MediaFile) - Method in class sage.api.MediaFileAPI
Returns the total duration of the content in this MediaFile
GetFileEndTime(MediaFile) - Method in class sage.api.MediaFileAPI
Returns the ending time for the content in ths specified MediaFile.
GetFileExtensionFromPath(String) - Method in class sage.api.Utility
Returns the file name extension from the specified file path (not including the '.')
GetFileForSegment(MediaFile, int) - Method in class sage.api.MediaFileAPI
Gets the file that represents the specified segment number in this MediaFile
GetFileNameFromPath(File) - Method in class sage.api.Utility
Returns the file name from the specified file path; this just returns the filename without any path information.
GetFilePathSize(File) - Method in class sage.api.Utility
Returns the size in bytes of the specified file path
GetFileStartTime(MediaFile) - Method in class sage.api.MediaFileAPI
Returns the starting time for the content in ths specified MediaFile.
GetFilesWithImportPrefix(Object, String, boolean, boolean, boolean) - Method in class sage.api.Database
Returns a list of java.io.File objects w/ the specified MediaMask whos import prefix matches that of the argument
GetFileSystemRoots() - Method in class sage.api.Utility
Returns the root directories of the file systems (on Linux this'll just be / and on Windows it'll be the drive letters)
GetFileSystemType(String) - Method in class sage.api.Utility
Gets the name of the filesystem type at the specified path
GetFocusContext() - Method in class sage.api.Global
Copies all variables from the currently focused UI element's variable context to the current context of the calling Action.
getFormAction() - Method in class sage.media.rss.RSSTextInput
Get the form action
GetFullImage(MediaFile) - Method in class sage.api.MediaFileAPI
Returns the MetaImage object which represents the picture file for this MediaFile.
GetFullUIHeight() - Method in class sage.api.Global
Returns the height in pixels of the user interface for the calling SageTV UI context.
GetFullUIWidth() - Method in class sage.api.Global
Returns the width in pixels of the user interface for the calling SageTV UI context.
GetGatewayAddress() - Method in class sage.api.Utility
Returns the gateway address for the currently configured network adapter.
getGenerator() - Method in class sage.media.rss.RSSChannel
Get the generator program's channel
GetHDMIAutodetectedConnector() - Method in class sage.api.Configuration
Returns a string describing the type of connection autodetected on HDMI (currently only used on media extenders)
getHeight() - Method in class sage.media.rss.RSSImage
Get the image's height
getHeight() - Method in class sage.media.rss.RSSMediaContent
 
GetHotplugStorageMap() - Method in class sage.api.Global
Returns a map of name->file for any hotplug storage devies on the system.
GetImageAsBufferedImage(Object) - Method in class sage.api.Utility
Returns a java.awt.image.BufferedImage object.
GetInactivityTimeout() - Method in class sage.api.Configuration
Gets the inactivity timeout in milliseconds.
GetInfraredReceiverPort() - Method in class sage.api.Configuration
Gets the name of the port that the infrared receiver is connected to.
GetInfraredTunerRemoteName(String) - Method in class sage.api.CaptureDeviceInputAPI
Returns the name of the device that is passed to the IR Tuner plugin for tuning control.
GetInfraredTuningPlugin(String) - Method in class sage.api.CaptureDeviceInputAPI
Gets the name of the tuning plugin used for this CaptureDeviceInput
GetInfraredTuningPluginPortNumber(String) - Method in class sage.api.CaptureDeviceInputAPI
Gets the port number used by the tuning plugin for this CaptureDeviceInput
GetInfraredTuningPlugins() - Method in class sage.api.Configuration
Gets the list of infrared tuning plugins that are available for use with SageTV
GetInputMaximumChannelNumber(String) - Method in class sage.api.CaptureDeviceInputAPI
Returns the maximum channel number that this CaptureDeviceInput can tune to
GetInputMinimumChannelNumber(String) - Method in class sage.api.CaptureDeviceInputAPI
Returns the minimum channel number that this CaptureDeviceInput can tune to
getInputName() - Method in class sage.media.rss.RSSTextInput
Get the form input name
GetInstalledClientPlugins() - Method in class sage.api.PluginAPI
Returns an array of Plugin objects which represent all the plugins that have been installed on the local client (enabled or disabled).
GetInstalledPlugins() - Method in class sage.api.PluginAPI
Returns an array of Plugin objects which represent all the plugins that have been installed on this SageTV system (enabled or disabled).
getInstance() - Static method in class sage.media.rss.RSSFactory
 
GetIRCodesLinkedToSageCommand(String) - Method in class sage.api.Configuration
Returns the infrared codes that are linked to the given SageTV Command.
getItems() - Method in class sage.media.rss.RSSChannel
Get a linkedList wich contains the Channel's RSSItem
getItemsSequence() - Method in class sage.media.rss.RSSChannel
Get the sequnce from the channel
This element should be always present
GetKeepAtMost(Favorite) - Method in class sage.api.FavoriteAPI
Returns the maximum number of recordings that match this Favorite that should be kept on disk.
getKernel() - Method in class sage.media.rss.CharacterReference
Get this CharacterReference's kernel.
getKernel() - Method in class sage.media.rss.CharacterReferenceEx
Get this CharacterReference's kernel.
GetKeystrokesLinkedToSageCommand(String) - Method in class sage.api.Configuration
Returns the keystroke names that are linked to the given SageTV Command.
getLanguage() - Method in class sage.media.rss.RSSChannel
Get the language of channell
getLastBuildDate() - Method in class sage.media.rss.RSSChannel
Get channel's lastBuildDate
GetLastEPGDownloadTime() - Method in class sage.api.Global
Returns the last time that SageTV did an EPG update.
GetLastUsedCaptureDevice() - Method in class sage.api.CaptureDeviceAPI
Returns the last CaptureDevice that was accessed by SageTV.
GetLastUsedCaptureDeviceInput(String) - Method in class sage.api.CaptureDeviceAPI
Returns the last CaptureDeviceInput that was used by SageTV on the given CaptureDevice
GetLatestWatchedTime(Airing) - Method in class sage.api.AiringAPI
Gets the time that viewing should resume from for this Airing if it is selected to view
getLength() - Method in class sage.media.rss.RSSEnclosure
 
GetLibraryImportPaths() - Method in class sage.api.Configuration
Returns all of the library import paths that are currently configured for all media types
GetLineupForCaptureDeviceInput(String) - Method in class sage.api.CaptureDeviceInputAPI
Returns the name of the lineup that this CaptureDeviceInput is configured to use
GetLineupsForZipCodeFromEPGServer(String) - Method in class sage.api.Global
Gets a list from the EPG server of all the possible EPG Lineups that are available in a given zip code
getLink() - Method in class sage.media.rss.RSSObject
Get the element's link
getListSize() - Method in class sage.media.rss.RSSSequence
Return the size of a sequence
GetLocalFileAsString(File) - Method in class sage.api.Utility
Opens the file at the specified path and reads the entire contents of it and returns it as a String.
GetLocalFilePathSize(File) - Method in class sage.api.Utility
Returns the size in bytes of the specified local file path
GetLocalFileSystemRoots() - Method in class sage.api.Utility
Returns the root directories of the local file systems (on Linux this'll just be / and on Windows it'll be the drive letters)
GetLocalIPAddress() - Method in class sage.api.Utility
Returns the IP address of the machine
GetLocalMarketsFromEPGServer() - Method in class sage.api.Global
Gets a list of all the possible United States local broadcast markets from the EPG server
GetLocalPathLastModifiedTime(File) - Method in class sage.api.Utility
Returns the last modified time of the specified local file path
GetLogo(String) - Method in class sage.api.Global
Gets an Image object that represents the specified name.
GetManualRecordProperty(Airing, String) - Method in class sage.api.AiringAPI
Returns a property value for a specified ManualRecord.
GetMaxChannelDigitsForInfraredTuningPlugin(String, int, String) - Method in class sage.api.Configuration
Gets the maximum number of digits that are needed to tune a channel on the device that corresponds to the specified 'Remote Control'.
GetMediaDuration() - Method in class sage.api.MediaPlayerAPI
Returns the duration of the currently loaded MediaFile in milliseconds.
GetMediaFileAiring(MediaFile) - Method in class sage.api.MediaFileAPI
Gets the Airing object that represents the content metadata for this MediaFile
GetMediaFileEncoding(MediaFile) - Method in class sage.api.MediaFileAPI
Gets the encoding that was used to record this file.
GetMediaFileForAiring(Airing) - Method in class sage.api.AiringAPI
Gets the MediaFile object which corresponds to this Airing object
GetMediaFileForFilePath(File) - Method in class sage.api.MediaFileAPI
Returns the MediaFile from the database that corresponds to a specified file on disk
GetMediaFileForID(int) - Method in class sage.api.MediaFileAPI
Returns the MediaFile object that corresponds to the passed in ID.
GetMediaFileFormatDescription(MediaFile) - Method in class sage.api.MediaFileAPI
Returns a string that provides a description of this MediaFile's format, i.e.
GetMediaFileID(MediaFile) - Method in class sage.api.MediaFileAPI
Returns the unique ID used to identify this MediaFile.
GetMediaFileMetadata(MediaFile, String) - Method in class sage.api.MediaFileAPI
Returns a string for the corresponding metadata property in the MediaFile's format.
GetMediaFileMetadataProperties(MediaFile) - Method in class sage.api.MediaFileAPI
Returns a java.util.Properties object that contains all of the metadata properties for a MediaFile object.
GetMediaFileRelativePath(MediaFile) - Method in class sage.api.MediaFileAPI
Returns the path of this MediaFile object relative to the root of the import directory it is in.
GetMediaFiles() - Method in class sage.api.MediaFileAPI
Returns all of the MediaFile objects in the database.
GetMediaFiles(String) - Method in class sage.api.MediaFileAPI
Returns all of the MediaFile objects in the database The content it references must also match one of the media types specified in the MediaMask.
GetMediaFilesWithImportPrefix(Object, String, boolean, boolean, boolean) - Method in class sage.api.Database
Returns a list or map of MediaFile objects w/ the specified MediaMask whos import prefix matches that of the argument
getMediaGroup() - Method in class sage.media.rss.RSSItem
 
GetMediaMask(DBObject) - Method in class sage.api.Database
Returns a string which represents the different media categories the specified DBObject belongs to.
GetMediaPlayerClosedCaptionState() - Method in class sage.api.MediaPlayerAPI
Gets the current state that MediaPlayer close captioning is set to use.
GetMediaSource(String) - Method in class sage.api.MediaNodeAPI
Retrieves a MediaNode which is the root of the specified 'Media Source'.
GetMediaTime() - Method in class sage.api.MediaPlayerAPI
Gets the current playback time of the MediaPlayer.
GetMediaTitle(MediaFile) - Method in class sage.api.MediaFileAPI
Returns the title for the specified MediaFile object
GetMediaView(String, Object) - Method in class sage.api.MediaNodeAPI
Similar to the GetMediaSource API call; but the second argument allows specifying the actual data set to be used for the view.
getMedium() - Method in class sage.media.rss.RSSMediaContent
 
GetMetaImageAspectRatio(MetaImage) - Method in class sage.api.Utility
Returns the aspect ratio of an image as a floating point number of width/height, zero if the image was a failed load or has not been loaded yet
GetMetaImageBytes(MetaImage) - Method in class sage.api.Utility
Returns a byte array which is the contents of the MetaImage source's data (i.e.
GetMetaImageSourceFile(MetaImage) - Method in class sage.api.Utility
Returns the file path that a MetaImage was loaded from.
GetMixerAudioInputPaths() - Method in class sage.api.Configuration
Gets the different input connectors that are available on the system sound mixer (Windows Only)
GetMovieImage(Show, boolean) - Method in class sage.api.ShowAPI
Returns a MetaImage for an image that's representative of this Movie
GetMovieImageAtIndex(Show, int, boolean) - Method in class sage.api.ShowAPI
Returns the image at the specified index for a Show that represents a Movie
GetMovieImageCount(Show) - Method in class sage.api.ShowAPI
Returns the number of images available for a Show that represents a Movie
GetMovieImageURL(Show, boolean) - Method in class sage.api.ShowAPI
Returns an image URL that's representative of this Movie
GetMovieImageURLAtIndex(Show, int, boolean) - Method in class sage.api.ShowAPI
Returns the image URL at the specified index for a Show that represents a Movie
GetMovieStarRating(Show) - Method in class sage.api.ShowAPI
Returns the star rating for a Movie as a floating point number.
GetMusicLibraryImportPaths() - Method in class sage.api.Configuration
Returns the library import paths that are currently configured for music files
GetName(Playlist) - Method in class sage.api.PlaylistAPI
Gets the name of the specified Playlist
GetNameForIRCode(long) - Method in class sage.api.Configuration
Gets the name that is associated with an IR code.
GetNodeChildAt(MediaNode, int) - Method in class sage.api.MediaNodeAPI
Returns the child of the specified MediaNode at the given index
GetNodeChildren(MediaNode) - Method in class sage.api.MediaNodeAPI
Returns an array of the children of the specified MediaNode
GetNodeDataObject(MediaNode) - Method in class sage.api.MediaNodeAPI
Returns the Object that is wrapped by the specified MediaNode
GetNodeDataType(MediaNode) - Method in class sage.api.MediaNodeAPI
Returns the type of the Object that is wrapped by the specified MediaNode
GetNodeFilterTechnique(MediaNode, int) - Method in class sage.api.MediaNodeAPI
Returns the name of the current filtering technique used by the specified MediaNode hierarchy.
GetNodeFullPath(MediaNode) - Method in class sage.api.MediaNodeAPI
Returns a string which represents the hierarchical path to this MediaNode.
GetNodeIcon(MediaNode) - Method in class sage.api.MediaNodeAPI
Returns the icon image associated with the specified MediaNode.
GetNodeNumChildren(MediaNode) - Method in class sage.api.MediaNodeAPI
Returns the number of children of the specified MediaNode
GetNodeNumFilters(MediaNode) - Method in class sage.api.MediaNodeAPI
Gets the number of filters that are currently set for the specified MediaNode.
GetNodeParent(MediaNode) - Method in class sage.api.MediaNodeAPI
Returns the MediaNode parent of the specified MediaNode
GetNodePrimaryLabel(MediaNode) - Method in class sage.api.MediaNodeAPI
Returns a string representation of the primary data associated with the specified MediaNode suitable for display in the UI.
GetNodeProperty(MediaNode, String) - Method in class sage.api.MediaNodeAPI
Returns a specific property associated with this MediaNode.
GetNodeSecondaryLabel(MediaNode) - Method in class sage.api.MediaNodeAPI
Returns a string representation of the secondary data associated with the specified MediaNode suitable for display in the UI.
GetNodeSortTechnique(MediaNode) - Method in class sage.api.MediaNodeAPI
Returns the name of the current sorting technique used by the specified MediaNode hierarchy.
GetNodeThumbnail(MediaNode) - Method in class sage.api.MediaNodeAPI
Returns the thumbnail image associated with the specified MediaNode.
GetNodeTypePath(MediaNode) - Method in class sage.api.MediaNodeAPI
Returns a string which represents the hierarchical path to this MediaNode with type information only.
GetNowPlayingList() - Method in class sage.api.PlaylistAPI
Returns the 'Now Playing' playlist.
GetNumberOfCharactersInSeries(SeriesInfo) - Method in class sage.api.SeriesInfoAPI
Returns the number of characters that we have information on for the specified series
GetNumberOfPlaylistItems(Playlist) - Method in class sage.api.PlaylistAPI
Gets the number of items in the specified Playlist
GetNumberOfSegments(MediaFile) - Method in class sage.api.MediaFileAPI
Returns the number of segments in ths specified MediaFile.
GetNumberOfTracks(Album) - Method in class sage.api.AlbumAPI
Returns the number of tracks that are on this Album
GetOriginalAiringDate(Show) - Method in class sage.api.ShowAPI
Gets the date that this Show was originally aired at.
GetOS() - Method in class sage.api.Global
Gets the name of the operating system that is being used.
GetOverscanInsetBottom() - Method in class sage.api.Configuration
Returns a floating point value which specifies the percent of the UI that is taken up by overscan on the bottom Equivalent to (1.0 - (GetOverscanOffsetY() * 1.0 / GetFullUIHeight()) - GetOverscanScaleHeight())/GetOverscanScaleHeight()
GetOverscanInsetLeft() - Method in class sage.api.Configuration
Returns a floating point value which specifies the percent of the UI that is taken up by overscan on the left side.
GetOverscanInsetRight() - Method in class sage.api.Configuration
Returns a floating point value which specifies the percent of the UI that is taken up by overscan on the right side.
GetOverscanInsets() - Method in class sage.api.Configuration
Returns a length 4 array of floating point values which specifies the percent of the UI that is taken up by overscan on the 4 sides.
GetOverscanInsetTop() - Method in class sage.api.Configuration
Returns a floating point value which specifies the percent of the UI that is taken up by overscan on the top Equivalent to (GetOverscanOffsetY() * 1.0 / (GetFullUIHeight() * GetOverscanScaleHeight())))
GetOverscanOffsetX() - Method in class sage.api.Configuration
Returns the horizontal offset in pixels that should be applied to the UI to account for overscan.
GetOverscanOffsetY() - Method in class sage.api.Configuration
Returns the vertical offset in pixels that should be applied to the UI to account for overscan.
GetOverscanScaleHeight() - Method in class sage.api.Configuration
Returns the vertical scale factor that should be applied to the UI to account for overscan.
GetOverscanScaleWidth() - Method in class sage.api.Configuration
Returns the horizontal scale factor that should be applied to the UI to account for overscan.
GetParentalLimitsExceeded(Airing) - Method in class sage.api.AiringAPI
Checks the airing for exceeding parental ratings and return a string array filled with each rating.
GetParentalRating(Airing) - Method in class sage.api.AiringAPI
Gets the parental rating information associated with this Airing.
GetParentDirectory(MediaFile) - Method in class sage.api.MediaFileAPI
Gets the directory that the files for this MediaFile are in.
GetPathLastModifiedTime(File) - Method in class sage.api.Utility
Returns the last modified time of the specified file path
GetPathParentDirectory(File) - Method in class sage.api.Utility
Returns the parent directory for the specified file path
GetPeopleAndCharacterInShowInRole(Show, String) - Method in class sage.api.ShowAPI
Gets the people in the specified Show in the specified Role.
GetPeopleAndCharacterInShowInRoles(Show, String[]) - Method in class sage.api.ShowAPI
Gets the people in the specified Show in the specified Roles.
GetPeopleAndCharacterListInShow(Show) - Method in class sage.api.ShowAPI
Gets a list of all of the people involved in this Show and the character each of them plays if known.
GetPeopleAndCharacterListInShowInRole(Show, String) - Method in class sage.api.ShowAPI
Gets the people in the specified Show in the specified Role.
GetPeopleAndCharacterListInShowInRoles(Show, String[]) - Method in class sage.api.ShowAPI
Gets the people in the specified Show in the specified Roles.
GetPeopleInShow(Show) - Method in class sage.api.ShowAPI
Gets a list of all of the people involved in this Show.
GetPeopleInShowInRole(Show, String) - Method in class sage.api.ShowAPI
Gets the people in the specified Show in the specified Role.
GetPeopleInShowInRoles(Show, String[]) - Method in class sage.api.ShowAPI
Gets the people in the specified Show in the specified Roles.
GetPeopleListInShow(Show) - Method in class sage.api.ShowAPI
Gets a list of all of the people involved in this Show.
GetPeopleListInShowInRole(Show, String) - Method in class sage.api.ShowAPI
Gets the people in the specified Show in the specified Role.
GetPeopleListInShowInRoles(Show, String[]) - Method in class sage.api.ShowAPI
Gets the people in the specified Show in the specified Roles.
GetPersonBirthplace(Person) - Method in class sage.api.ShowAPI
Returns a String representing the birthplace of the specified person, empty string if unknown
GetPersonDateOfBirth(Person) - Method in class sage.api.ShowAPI
Returns a String representing the birthdate of the specified person, empty string if unknown
GetPersonDateOfDeath(Person) - Method in class sage.api.ShowAPI
Returns a String representing the date of the specified person's death, empty string if unknown
GetPersonForID(int) - Method in class sage.api.ShowAPI
Returns the Person object that corresponds to the passed in ID.
GetPersonID(Person) - Method in class sage.api.ShowAPI
Returns the unique ID used to identify this Person.
GetPersonImage(Person, boolean) - Method in class sage.api.ShowAPI
Returns the image for the specified person
GetPersonImageURL(Person, boolean) - Method in class sage.api.ShowAPI
Returns the image URL for the specified person
GetPersonListInShow(Show) - Method in class sage.api.ShowAPI
Gets a list of all of the people involved in this Show.
GetPersonListInShowInRole(Show, String) - Method in class sage.api.ShowAPI
Gets the people in the specified Show in the specified Role.
GetPersonListInShowInRoles(Show, String[]) - Method in class sage.api.ShowAPI
Gets the people in the specified Show in the specified Roles.
GetPhysicalChannelNumberForLineup(Channel, String) - Method in class sage.api.ChannelAPI
Gets the physical channel number to tune to for this Channel on the specified lineup.
GetPhysicalInputType(String) - Method in class sage.api.CaptureDeviceInputAPI
Returns the type of input this is, such as: S-Video, Composite, TV Tuner, etc.
GetPictureLibraryImportPaths() - Method in class sage.api.Configuration
Returns the library import paths that are currently configured for picture files
GetPlayableAiring(Airing) - Method in class sage.api.AiringAPI
Returns an Airing that correlates to the same content as the argument that is playable now.
GetPlaybackRate() - Method in class sage.api.MediaPlayerAPI
Returns the current playback rate as a floating point number.
getPlayerURL() - Method in class sage.media.rss.RSSMediaGroup
 
GetPlaylistItemAt(Playlist, int) - Method in class sage.api.PlaylistAPI
Gets the item in this Playlist at the specified index
GetPlaylistItems(Playlist) - Method in class sage.api.PlaylistAPI
Gets the list of items in the specified Playlist
GetPlaylistItemTypeAt(Playlist, int) - Method in class sage.api.PlaylistAPI
Gets the type of item in the Playlist at the specified index
GetPlaylistProperties(Playlist) - Method in class sage.api.PlaylistAPI
Returns a java.util.Properties object that has all of the user-set properties for this Playlist in it.
GetPlaylistProperty(Playlist, String) - Method in class sage.api.PlaylistAPI
Returns a property value for a specified Playlist.
GetPlaylists() - Method in class sage.api.PlaylistAPI
Gets a list of all of the Playlists in the database
GetPluginAuthor(Plugin) - Method in class sage.api.PluginAPI
Gets the author of the specified Plugin object
GetPluginConfigHelpText(Plugin, String) - Method in class sage.api.PluginAPI
Gets the help text to describe the specified configuration setting for the specified Plugin object.
GetPluginConfigLabel(Plugin, String) - Method in class sage.api.PluginAPI
Gets the label to describe the specified configuration setting for the specified Plugin object.
GetPluginConfigOptions(Plugin, String) - Method in class sage.api.PluginAPI
Gets all the options available for the specified configuration setting for the specified Plugin object.
GetPluginConfigSettings(Plugin) - Method in class sage.api.PluginAPI
Returns a list of the setting names for the specified Plugin object.
GetPluginConfigType(Plugin, String) - Method in class sage.api.PluginAPI
Gets the setting type for the specified configuration setting for the specified Plugin object.
GetPluginConfigValue(Plugin, String) - Method in class sage.api.PluginAPI
Gets the current value for the specified configuration setting for the specified Plugin object.
GetPluginConfigValues(Plugin, String) - Method in class sage.api.PluginAPI
Gets the current values for the specified configuration setting for the specified Plugin object.
GetPluginCreationDate(Plugin) - Method in class sage.api.PluginAPI
Gets the creation date of the specified Plugin object
GetPluginDemoVideos(Plugin) - Method in class sage.api.PluginAPI
Returns an array of URLs to demo videos for the specified plugin object
GetPluginDependencies(Plugin) - Method in class sage.api.PluginAPI
Returns an array of Strings which specifies the dependencies of this plugin.
GetPluginDescription(Plugin) - Method in class sage.api.PluginAPI
Gets the description of the specified Plugin object
GetPluginIdentifier(Plugin) - Method in class sage.api.PluginAPI
Gets the unique identifier of the specified Plugin object
GetPluginImplementation(Plugin) - Method in class sage.api.PluginAPI
Returns the actual object that implements the sage.SageTVPlugin interface for the specified Plugin.
GetPluginIncompatabilityReason(Plugin) - Method in class sage.api.PluginAPI
Returns the reason why the specified Plugin object is incompatible and cannot be installed.
GetPluginInstallDate(Plugin) - Method in class sage.api.PluginAPI
Gets the date the specified Plugin object was installed
GetPluginModificationDate(Plugin) - Method in class sage.api.PluginAPI
Gets the last modification date of the specified Plugin object
GetPluginName(Plugin) - Method in class sage.api.PluginAPI
Gets the displayable name of the specified Plugin object
GetPluginProgress() - Method in class sage.api.PluginAPI
Returns a progress based status message regarding any current plugin installation.
GetPluginReleaseNotes(Plugin) - Method in class sage.api.PluginAPI
Gets the release notes attached to this specific version of the specified Plugin object
GetPluginResourcePath(Plugin) - Method in class sage.api.PluginAPI
Gets the relative path to resources used by the specified Plugin object
GetPluginScreenshots(Plugin) - Method in class sage.api.PluginAPI
Returns an array of URLs to screenshots for the specified plugin object
GetPluginType(Plugin) - Method in class sage.api.PluginAPI
Returns the type of the specified plugin object.
GetPluginVersion(Plugin) - Method in class sage.api.PluginAPI
Gets the version of the specified Plugin object
GetPluginWebsites(Plugin) - Method in class sage.api.PluginAPI
Returns an array of URLs to websites for the specified plugin object
GetPredefinedPermissions() - Method in class sage.api.Security
Returns a list of all the predefined permission names.
GetPreferredDisplayResolutions() - Method in class sage.api.Global
Returns a list of the preferred display resolutions.
GetPrefixCommandForInfraredTuningPlugin(String, int, String) - Method in class sage.api.Configuration
Gets the command that is to be sent before a channel change sequence is started.
GetProperty(String, String) - Method in class sage.api.Configuration
Gets the property with the specified name.
getPubDate() - Method in class sage.media.rss.RSSObject
Get the publication date of the channel or of an item
GetRatingsUnderParentalLock() - Method in class sage.api.Configuration
Gets the list of content ratings that are under parental lock.
GetRawMediaTime() - Method in class sage.api.MediaPlayerAPI
Gets the current playback time of the MediaPlayer.
GetRealWatchedEndTime(Airing) - Method in class sage.api.AiringAPI
Gets the time the user finished watching this Airing, in real time.
GetRealWatchedStartTime(Airing) - Method in class sage.api.AiringAPI
Gets the time the user started watching this Airing, in real time.
GetRecentChannels() - Method in class sage.api.MediaPlayerAPI
Returns an array of recently viewed channels.
GetRecentlyWatched(long) - Method in class sage.api.Global
Gets a list of all of the Airings that have been watched within the specified amount of time
GetRecordingName(Airing) - Method in class sage.api.AiringAPI
Gets the name for this recording that was set via SetRecordingName(Airing, String)
GetRecordingQualities() - Method in class sage.api.Configuration
Returns a list of the different recording quality names available in the system
GetRecordingQuality(Airing) - Method in class sage.api.AiringAPI
Returns the recording quality that this Airing has been specifically set to record at.
GetRecordingQualityBitrate(String) - Method in class sage.api.Configuration
Gets the estimated overall bitrate for a given recording quality.
GetRecordingQualityFormat(String) - Method in class sage.api.Configuration
Gets the format for a given recording quality.
GetRelativeMediaSource(String, Object) - Method in class sage.api.MediaNodeAPI
Creates a MediaNode view with a relative root for a specified media source.
GetRemoteClientVersion() - Method in class sage.api.Global
Returns the version string for this connected remote client
GetRemotesForInfraredTuningPlugin(String, int) - Method in class sage.api.Configuration
Gets the names of the 'Remote Controls' which correspond to external devices that can be controlled with the specified plugin
GetRemoteUIType() - Method in class sage.api.Global
Returns the type of client that is connected on this remote interface
getResource() - Method in class sage.media.rss.RSSSequenceElement
Get the resource
GetRolesInShow(Show) - Method in class sage.api.ShowAPI
Gets a list of the roles for each of the people in the specified Show.
GetRoleTypes() - Method in class sage.api.ShowAPI
Gets a list of all of the valid roles that people can have in a Show
getRSSChannel() - Method in class sage.media.rss.RSSHandler
Get the RSSChannel Object back from the parser
getRSSDoublinCoreModule() - Method in class sage.media.rss.RSSObject
Get the Roubin Core object from the RSS object
getRSSImage() - Method in class sage.media.rss.RSSChannel
Get a RSSImage from the channel
getRSSSyndicationModule() - Method in class sage.media.rss.RSSChannel
Get the syndication module object from the RSS object
getRSSTextInput() - Method in class sage.media.rss.RSSChannel
Get a RSSTextInput object from the channel
GetSageCommandLinkedToIRCode(long) - Method in class sage.api.Configuration
Returns the SageTV Command that is linked to the specified infrared code.
GetSageCommandLinkedToKeystroke(String) - Method in class sage.api.Configuration
Returns the SageTV Command that is linked to the specified keystroke.
GetSageCommandNames() - Method in class sage.api.Global
Gets the names of all of the SageTV commands that are available in the system
GetSageTVPluginRegistry() - Method in class sage.api.PluginAPI
Returns an object which implements the sage.SageTVPluginRegistry interface.
GetScaledImageAsBufferedImage(Object, int, int) - Method in class sage.api.Utility
Returns a java.awt.image.BufferedImage object.
GetScheduledRecordings() - Method in class sage.api.Global
Gets a list of all of the Airings that SageTV is planning to record in the future
GetScheduledRecordingsForDevice(String) - Method in class sage.api.Global
Gets a list of all of the Airings that SageTV is planning to record in the future on the specified CaptureDevice
GetScheduledRecordingsForDeviceForTime(String, long, long) - Method in class sage.api.Global
Gets a list of all of the Airings that SageTV is planning on recording during the specified time span on a specified CaptureDevice
GetScheduledRecordingsForTime(long, long) - Method in class sage.api.Global
Gets a list of all of the Airings that SageTV is planning on recording during the specified time span
GetScheduleDuration(Airing) - Method in class sage.api.AiringAPI
Get the duration for an airing accounting for any adjustments made due to Manual Recording stop/start time adjustments or adjustments due to favorite padding.
GetScheduleEndTime(Airing) - Method in class sage.api.AiringAPI
Get the end time for an airing accounting for any adjustments made due to Manual Recording stop/start time adjustments or adjustments due to favorite padding.
GetScheduleRecordingRecurrence(Airing) - Method in class sage.api.AiringAPI
If this Airing is a time-based recording this will get a description of the recurrence frequency for its recording recurrence
GetScheduleStartTime(Airing) - Method in class sage.api.AiringAPI
Get the start time for an airing accounting for any adjustments made due to Manual Recording stop/start time adjustments or adjustments due to favorite padding.
GetScreenSaverTimeout() - Method in class sage.api.Configuration
Gets the screen saver timeout in milliseconds.
GetSecurityProfiles() - Method in class sage.api.Security
Returns the names of the different security profiles.
GetSegmentFiles(MediaFile) - Method in class sage.api.MediaFileAPI
Returns the list of files that make up the specified MediaFile object.
GetSequenceDelayForInfraredTuningPlugin(String, int, String) - Method in class sage.api.Configuration
Gets the minimum delay in milliseconds that is required between the completion of a sequence of commands that represent a channel change and the start of a new sequence of commands that represent a channel change
GetSeriesActor(SeriesInfo, int) - Method in class sage.api.SeriesInfoAPI
Returns the name of the actor/actress for the specfied index in the specified SeriesInfo.
GetSeriesActorImage(SeriesInfo, Person, boolean) - Method in class sage.api.SeriesInfoAPI
Returns an image of the specified Person in their role in the specified Series
GetSeriesActorImageURL(SeriesInfo, Person, boolean) - Method in class sage.api.SeriesInfoAPI
Returns an image URL of the specified Person in their role in the specified Series
GetSeriesActorList(SeriesInfo) - Method in class sage.api.SeriesInfoAPI
Returns a list of the names of the actors/actresses in the specified SeriesInfo.
GetSeriesCategory(SeriesInfo) - Method in class sage.api.SeriesInfoAPI
Returns the category for the specified SeriesInfo
GetSeriesCharacter(SeriesInfo, int) - Method in class sage.api.SeriesInfoAPI
Returns the name of the character for the specfied index in the specified SeriesInfo.
GetSeriesCharacterForActor(SeriesInfo, String) - Method in class sage.api.SeriesInfoAPI
Returns the name of the character that the corresponding actor plays in this series
GetSeriesCharacterList(SeriesInfo) - Method in class sage.api.SeriesInfoAPI
Returns a list of the names of the characters in the specified SeriesInfo.
GetSeriesDayOfWeek(SeriesInfo) - Method in class sage.api.SeriesInfoAPI
Returns the name of the day of the week the specified SeriesInfo airs on
GetSeriesDescription(SeriesInfo) - Method in class sage.api.SeriesInfoAPI
Returns the description for the specified SeriesInfo
GetSeriesFinaleDate(SeriesInfo) - Method in class sage.api.SeriesInfoAPI
Returns a String describing the finale date for the specified SeriesInfo
GetSeriesHistory(SeriesInfo) - Method in class sage.api.SeriesInfoAPI
Returns the history description for the specified SeriesInfo
GetSeriesHourAndMinuteTimeslot(SeriesInfo) - Method in class sage.api.SeriesInfoAPI
Returns the hour/minute timeslot that the specified SeriesInfo airs at
GetSeriesID(SeriesInfo) - Method in class sage.api.SeriesInfoAPI
Returns the Series ID of the specified SeriesInfo NOTE: V8.0 IDs are not backwards compatible with prior versions
GetSeriesImage(SeriesInfo) - Method in class sage.api.SeriesInfoAPI
Returns the image that corresponds to this SeriesInfo if there is one
GetSeriesImage(SeriesInfo, boolean) - Method in class sage.api.SeriesInfoAPI
Returns the image that corresponds to this SeriesInfo if there is one
GetSeriesImageAtIndex(SeriesInfo, int, boolean) - Method in class sage.api.SeriesInfoAPI
Returns the image that corresponds to this SeriesInfo at the specified index (when there are multiple images)
GetSeriesImageCount(SeriesInfo) - Method in class sage.api.SeriesInfoAPI
Returns the number of images available that correspond to this SeriesInfo
GetSeriesImageURL(SeriesInfo) - Method in class sage.api.SeriesInfoAPI
Returns the URL of the image that corresponds to this SeriesInfo if there is one
GetSeriesImageURL(SeriesInfo, boolean) - Method in class sage.api.SeriesInfoAPI
Returns the image URL that corresponds to this SeriesInfo if there is one
GetSeriesImageURLAtIndex(SeriesInfo, int, boolean) - Method in class sage.api.SeriesInfoAPI
Returns the image URL that corresponds to this SeriesInfo at the specified index (when there are multiple images)
GetSeriesInfoForID(String) - Method in class sage.api.SeriesInfoAPI
Returns the SeriesInfo object for the specified Series ID NOTE: V8.0 IDs are not backwards compatible with prior versions
GetSeriesInfoProperty(SeriesInfo, String) - Method in class sage.api.SeriesInfoAPI
Returns a property value for a specified SeriesInfo object.
GetSeriesNetwork(SeriesInfo) - Method in class sage.api.SeriesInfoAPI
Returns the name of the network the specified SeriesInfo airs on
GetSeriesPremiereDate(SeriesInfo) - Method in class sage.api.SeriesInfoAPI
Returns a String describing the premiere date for the specified SeriesInfo
GetSeriesSubCategory(SeriesInfo) - Method in class sage.api.SeriesInfoAPI
Returns the subcategory for the specified SeriesInfo
GetSeriesTitle(SeriesInfo) - Method in class sage.api.SeriesInfoAPI
Returns the title for the specified SeriesInfo
GetServerAddress() - Method in class sage.api.Global
Gets the hostname of the SageTV server if this is a client, otherwise it returns the name of the host SageTV is running on
GetServerProperty(String, String) - Method in class sage.api.Configuration
Gets the property with the specified name.
GetServerSubpropertiesThatAreBranches(String) - Method in class sage.api.Configuration
Returns the list of properties underneath the specified property that themselves contain further subproperties.
GetServerSubpropertiesThatAreLeaves(String) - Method in class sage.api.Configuration
Returns the list of properties underneath the specified property that do not contain further subproperties.
GetShow(Airing) - Method in class sage.api.AiringAPI
Gets the Show object for this Airing which describes it in further detail (Show contains the title, actors, category, description, etc.)
GetShowCategoriesList(Show) - Method in class sage.api.ShowAPI
Returns a String array of categories for the Show.
GetShowCategoriesString(Show) - Method in class sage.api.ShowAPI
Returns a String of categories for the Show, separated by '/' if there are multiple levels of categories.
GetShowCategoriesString(Show, String) - Method in class sage.api.ShowAPI
Returns a String of categories for the Show, separated by the specified delimiter if there are multiple levels of categories.
GetShowCategory(Show) - Method in class sage.api.ShowAPI
Returns the category for the specified Show.
GetShowDescription(Show) - Method in class sage.api.ShowAPI
Returns the description for the specified Show
GetShowDuration(Show) - Method in class sage.api.ShowAPI
Returns the duration of the specified Show.
GetShowEpisode(Show) - Method in class sage.api.ShowAPI
Returns the episode name for the specified Show.
GetShowEpisodeNumber(Show) - Method in class sage.api.ShowAPI
Returns the episode number of the specified Show.
GetShowExpandedRatings(Show) - Method in class sage.api.ShowAPI
Returns the epxanded ratings information for the specified Show.
GetShowExternalID(Show) - Method in class sage.api.ShowAPI
Gets the global unique ID which is used to identify Shows.
GetShowForExternalID(String) - Method in class sage.api.ShowAPI
Gets a Show based on the global unique ID which is used to identify Shows.
GetShowImage(Show, String, int, int) - Method in class sage.api.ShowAPI
Returns an image specific to this Show.
GetShowImageCount(Show, String) - Method in class sage.api.ShowAPI
Returns a count of images specific to this Show.
GetShowLanguage(Show) - Method in class sage.api.ShowAPI
Returns the language that the specified Show is in.
GetShowMisc(Show) - Method in class sage.api.ShowAPI
Returns the miscellaneous metadata for this Show.
GetShowParentalRating(Show) - Method in class sage.api.ShowAPI
Deprecated.  
GetShowRated(Show) - Method in class sage.api.ShowAPI
Returns the MPAA rating for the specified Show (only used for movies).
GetShowSeasonNumber(Show) - Method in class sage.api.ShowAPI
Returns the season number of the specified Show.
GetShowSeriesInfo(Show) - Method in class sage.api.ShowAPI
Gets the SeriesInfo object for a specified Show if that Show is for a television series and there is information on that series.
GetShowSubCategory(Show) - Method in class sage.api.ShowAPI
Returns the subcategory for the specified Show
GetShowTitle(Show) - Method in class sage.api.ShowAPI
Returns the title of the specified Show.
GetShowYear(Show) - Method in class sage.api.ShowAPI
Gets the year of the specified Show.
GetSignalStrength(String) - Method in class sage.api.CaptureDeviceInputAPI
Returns the current signal strength for this CaptureDeviceInput.
GetSize(MediaFile) - Method in class sage.api.MediaFileAPI
Gets the total size in bytes of the files on disk that represent this MediaFile
GetStartForSegment(MediaFile, int) - Method in class sage.api.MediaFileAPI
Gets the starting time for a specified segment number in this MediaFile.
GetStartPadding(Favorite) - Method in class sage.api.FavoriteAPI
Returns the amount of time any recording for this Favorite should start before the actual Airing begins.
GetStartTimesForSegments(MediaFile) - Method in class sage.api.MediaFileAPI
Returns a list of all of the start times of the segments in the specified MediaFile
GetStationID(Channel) - Method in class sage.api.ChannelAPI
Returns an ID which can be used with GetChannelForStationID() for doing keyed lookups of Channel objects
GetStopPadding(Favorite) - Method in class sage.api.FavoriteAPI
Returns the amount of time any recording for this Favorite should stop after the actual Airing ends.
GetSTVName() - Method in class sage.api.WidgetAPI
Returns the value of the 'STVName' Attribute under the Global Theme Widget.
GetSTVVersion() - Method in class sage.api.WidgetAPI
Returns the value of the 'STVVersion' Attribute under the Global Theme Widget.
GetSubgroup(Map, Object) - Method in class sage.api.Utility
Gets the value for the specified key out of a map.
GetSubnetMask() - Method in class sage.api.Utility
Returns the subnet mask for the currently configured network adapter.
GetSubpicAudioLanguageOptions() - Method in class sage.api.Configuration
Gets the list of languages that are available to be used as presets for Audio tracks or Subpicture.
GetSubpropertiesThatAreBranches(String) - Method in class sage.api.Configuration
Returns the list of properties underneath the specified property that themselves contain further subproperties.
GetSubpropertiesThatAreLeaves(String) - Method in class sage.api.Configuration
Returns the list of properties underneath the specified property that do not contain further subproperties.
GetSubtitleDelay() - Method in class sage.api.MediaPlayerAPI
Gets the delay in milliseconds that is applied to external subtitle files when they are used during playback (can be positive or negative)
GetSuggestedIntelligentRecordings() - Method in class sage.api.Global
Gets a list of all of the Airings that SageTV would record if Intelligent Recording was enabled.
GetSystemAlertLevel() - Method in class sage.api.SystemMessageAPI
Gets the global alert level in the system.
GetSystemMessageEndTime(SystemMessage) - Method in class sage.api.SystemMessageAPI
Gets the time when this SystemMessage was last posted.
GetSystemMessageLevel(SystemMessage) - Method in class sage.api.SystemMessageAPI
Returns the alert level for the SystemMessage that was specified.
GetSystemMessageRepeatCount(SystemMessage) - Method in class sage.api.SystemMessageAPI
Gets the number of times this message was repeated.
GetSystemMessages() - Method in class sage.api.SystemMessageAPI
Returns the list of SystemMessage objects currently in the queue.
GetSystemMessageString(SystemMessage) - Method in class sage.api.SystemMessageAPI
Gets the 'message string' associated with this SystemMessage.
GetSystemMessageTime(SystemMessage) - Method in class sage.api.SystemMessageAPI
Gets the time when this SystemMessage was first posted.
GetSystemMessageTypeCode(SystemMessage) - Method in class sage.api.SystemMessageAPI
Returns an integer which represents the type of SystemMessage that was specified.
GetSystemMessageTypeName(SystemMessage) - Method in class sage.api.SystemMessageAPI
Returns a localized string which represents the type of SystemMessage that was specified.
GetSystemMessageVariable(SystemMessage, String) - Method in class sage.api.SystemMessageAPI
Returns the SystemMessage variable property associated with the specified SystemMessage.
GetSystemMessageVariableNames(SystemMessage) - Method in class sage.api.SystemMessageAPI
Returns the names of the variables associated with the specified SystemMessage.
getSyUpdateBase() - Method in class sage.media.rss.RSSSyndicationModule
Get the date
getSyUpdateFrequency() - Method in class sage.media.rss.RSSSyndicationModule
Get the update frequecy
getSyUpdatePeriod() - Method in class sage.media.rss.RSSSyndicationModule
Get the period
GetTableFocusedPosition(Object) - Method in class sage.api.Global
Gets the table position that currently has focus in the specified table.
GetTableFocusedVisibleColumn(Object) - Method in class sage.api.Global
Gets the column number that currently has focus in the specified table.
GetTableFocusedVisiblePosition(Object) - Method in class sage.api.Global
Gets the visible table position that currently has focus in the specified table.
GetTableFocusedVisibleRow(Object) - Method in class sage.api.Global
Gets the row number that currently has focus in the specified table.
GetTextForUIComponent(Object) - Method in class sage.api.Global
Gets the value displayed for the textual component of the specified UI object.
getThumbHeight() - Method in class sage.media.rss.RSSMediaGroup
 
GetThumbnail(MediaFile) - Method in class sage.api.MediaFileAPI
Gets the representative thumbnail image which should be used for iconic display of this MediaFile.
getThumbURL() - Method in class sage.media.rss.RSSMediaGroup
 
getThumbWidth() - Method in class sage.media.rss.RSSMediaGroup
 
GetTimeSinceLastInput() - Method in class sage.api.Utility
Returns the amount of time in milliseconds since the last user input occurred for this UI (used for doing things while the user is idle)
GetTimeUntilNextEPGDownload() - Method in class sage.api.Global
The amount of time in milliseconds until SageTV will perform an EPG update again.
GetTimeZone() - Method in class sage.api.Configuration
Gets the name of the time zone that the application is currently configured to use
getTitle() - Method in class sage.media.rss.RSSObject
Get the element's title
GetTotalDiskspaceAvailable() - Method in class sage.api.Global
Gets the total diskspace available for television recording by SageTV.
GetTotalLibraryDuration() - Method in class sage.api.Global
Returns the total duration of all of the content in the media library
GetTotalVideoDuration() - Method in class sage.api.Global
Returns the total duration of all of the recorded television content
GetTrackNumber(Airing) - Method in class sage.api.AiringAPI
Returns the track number for the Airing if it's from a Music Album.
GetTranscodeFormatDetails(String) - Method in class sage.api.TranscodeAPI
Gets the format details for the specified format name
GetTranscodeFormats() - Method in class sage.api.TranscodeAPI
Gets the names of the different transcode formats
GetTranscodeJobClipDuration(int) - Method in class sage.api.TranscodeAPI
Returns the clip duration for the specified transcode job
GetTranscodeJobClipStart(int) - Method in class sage.api.TranscodeAPI
Returns the clip start time for the specified transcode job
GetTranscodeJobCompletePercent(int) - Method in class sage.api.TranscodeAPI
Gets the percent complete (between 0 and 1 as a float) for a transcode job
GetTranscodeJobDestFile(int) - Method in class sage.api.TranscodeAPI
Gets the destination file of the specified transcoding job
GetTranscodeJobFormat(int) - Method in class sage.api.TranscodeAPI
Gets the target format of the specified transcoding job
GetTranscodeJobs() - Method in class sage.api.TranscodeAPI
Returns a list of the job IDs for all the current jobs in the transcode queue.
GetTranscodeJobShouldKeepOriginal(int) - Method in class sage.api.TranscodeAPI
Returns whether or not the specified transcoding job retains the original source file
GetTranscodeJobSourceFile(int) - Method in class sage.api.TranscodeAPI
Gets the source file of the specified transcoding job
GetTranscodeJobStatus(int) - Method in class sage.api.TranscodeAPI
Gets the status of the specified transcoding job
getTTL() - Method in class sage.media.rss.RSSChannel
Return the TTL's channel
getType() - Method in class sage.media.rss.RSSEnclosure
 
getType() - Method in class sage.media.rss.RSSMediaContent
 
GetUIComponentContext() - Method in class sage.api.Global
Returns the UI component that this execution originated from.
GetUIComponentForVariable(String, Object) - Method in class sage.api.Global
Searches all UI elements in the current menu until it finds one that has a variable with the specified name matching the specified value.
GetUIComponentHeight(Object) - Method in class sage.api.Global
Returns the height in pixels in the UI of the specified UI component.
GetUIComponentHeightf(Object) - Method in class sage.api.Global
Returns the height in the UI of the specified UI component relative to the entire UI height.
GetUIComponentLastFocusedChild(Object) - Method in class sage.api.Global
If the specified component currently has a focused child; that child's UI object will be returned.
GetUIComponentPositionX(Object) - Method in class sage.api.Global
Returns the X position in pixels in the UI of the specified UI component.
GetUIComponentPositionXf(Object) - Method in class sage.api.Global
Returns the X position in the UI of the specified UI component.
GetUIComponentPositionY(Object) - Method in class sage.api.Global
Returns the Y position in pixels in the UI of the specified UI component.
GetUIComponentPositionYf(Object) - Method in class sage.api.Global
Returns the Y position in the UI of the specified UI component.
GetUIComponentWidth(Object) - Method in class sage.api.Global
Returns the width in pixels in the UI of the specified UI component.
GetUIComponentWidthf(Object) - Method in class sage.api.Global
Returns the width in the UI of the specified UI component relative to the entire UI width.
GetUIContextName() - Method in class sage.api.Global
Returns the name of the UI context that makes the API call.
GetUIContextNames() - Method in class sage.api.Global
Returns a list of the names of the different UI contexts that are available.
GetUILanguage() - Method in class sage.api.Configuration
Gets the language that the user interface should be displayed in.
GetUIRefreshLock() - Method in class sage.api.Utility
Acquires the lock for this user interface system to prevent other updates from occuring.
GetUIWidgetContext() - Method in class sage.api.WidgetAPI
Returns the Widget for the corresponding UI component that this execution originated from.
getUrl() - Method in class sage.media.rss.RSSEnclosure
 
getUrl() - Method in class sage.media.rss.RSSImage
Get the url of the image
getUrl() - Method in class sage.media.rss.RSSMediaContent
 
GetUsedLibraryDiskspace() - Method in class sage.api.Global
Returns the total number of bytes on disk used by the content in the imported video, picturees and music libraries
GetUsedVideoDiskspace() - Method in class sage.api.Global
Returns the total number of bytes on disk used by recorded television content
GetUserRecord(String, String) - Method in class sage.api.UserRecordAPI
Gets an existing UserRecord object in the database under the specified data 'Store' and with the specified 'Key'.
GetUserRecordData(UserRecord, String) - Method in class sage.api.UserRecordAPI
Gets the Value from the specified Name that's stored in the given UserRecord object.
GetUserRecordNames(UserRecord) - Method in class sage.api.UserRecordAPI
Gets a list of all the 'Name' values used in name->value pairs in this UserRecord object
GetVariableFromContext(String, Object, String) - Method in class sage.api.Global
Searches all UI elements in the current menu until it finds one that has a variable with the specified name matching the specified value.
GetVariableFromUIComponent(Object, String) - Method in class sage.api.Global
Retrieves the variable with the specified name from the context of the passed in UIComponent.
GetVideoBackgroundColor() - Method in class sage.api.Configuration
Returns the color that should be used for the video background.
GetVideoDecoderFilter() - Method in class sage.api.Configuration
Gets the name of the DirectShow video decoder filter that's used for MPEG2 playback (Windows only)
GetVideoDecoderFilters() - Method in class sage.api.Configuration
Gets the list of the video decoder filters that are available in the system for MPEG2 playback (Windows only)
GetVideoDirectories() - Method in class sage.api.Configuration
Gets the list of directories that SageTV is configured to record television to
GetVideoDiskspaceRules() - Method in class sage.api.Configuration
Returns the list of valid diskspace rules.
GetVideoLibraryImportPaths() - Method in class sage.api.Configuration
Returns the library import paths that are currently configured for video files
GetVideoOffsetX(String) - Method in class sage.api.Configuration
Gets of the offset in pixels that should be applied horizontally to the video.
GetVideoOffsetY(String) - Method in class sage.api.Configuration
Gets of the offset in pixels that should be applied vertically to the video.
GetVideoOrbitingDuration() - Method in class sage.api.Configuration
Gets the video orbiting duration in milliseconds.
GetVideoSnapshot() - Method in class sage.api.MediaPlayerAPI
Returns an image which is a frame grab of the currently rendered video frame.
GetVideoZoomX(String) - Method in class sage.api.Configuration
Gets the horizontal scale factor for the video for the specified aspect ratio mode.
GetVideoZoomY(String) - Method in class sage.api.Configuration
Gets the vertical scale factor for the video for the specified aspect ratio mode.
GetVisibilityForVariable(String, Object) - Method in class sage.api.Global
Searches all UI elements in the current menu until it finds one that has a variable with the specified name matching the specified value.
GetVolume() - Method in class sage.api.MediaPlayerAPI
Returns the current volume level of the MediaPlayer.
GetWatchedDuration(Airing) - Method in class sage.api.AiringAPI
Gets the duration of time of this Airing that has been watched already.
GetWatchedEndTime(Airing) - Method in class sage.api.AiringAPI
Gets the time the user finished watching this Airing.
GetWatchedStartTime(Airing) - Method in class sage.api.AiringAPI
Gets the time the user started watching this Airing.
getWebMaster() - Method in class sage.media.rss.RSSChannel
Get the webmaster email
GetWidgetChild(Widget, String, String) - Method in class sage.api.WidgetAPI
Searches the children of the specified Widget for one with the specified type and name.
GetWidgetChildren(Widget) - Method in class sage.api.WidgetAPI
Gets the list of Widgets that are children of the specified Widget.
GetWidgetMenuBackHistory() - Method in class sage.api.WidgetAPI
Gets a list of the Widgets that have defined the menus that were recently displayed in the UI.
GetWidgetMenuHistory() - Method in class sage.api.WidgetAPI
Gets a list of the Widgets that have defined the menus that were recently displayed in the UI
GetWidgetName(Widget) - Method in class sage.api.WidgetAPI
Returns the name of the specified Widget
GetWidgetParent(Widget, String, String) - Method in class sage.api.WidgetAPI
Searches the parents of the specified Widget for one with the specified type and name.
GetWidgetParents(Widget) - Method in class sage.api.WidgetAPI
Gets the list of Widgets that are parents of the specified Widget.
GetWidgetProperty(Widget, String) - Method in class sage.api.WidgetAPI
Returns the value for a specified property in a Widget
GetWidgetsByType(String) - Method in class sage.api.WidgetAPI
Gets all of the Widgets that are in the currently loaded STV that are of the specified type
GetWidgetSymbol(Widget) - Method in class sage.api.WidgetAPI
Returns the UID symbol for the specified Widget
GetWidgetType(Widget) - Method in class sage.api.WidgetAPI
Returns the type of a Widget
getWidth() - Method in class sage.media.rss.RSSImage
Get the image's width
getWidth() - Method in class sage.media.rss.RSSMediaContent
 
GetWindowsRegistryDWORDValue(String, String, String) - Method in class sage.api.Utility
Returns a DWORD value from the Windows registry for the specified root, key and name(Windows only) Acceptable values for the Root are: "HKCR", "HKEY_CLASSES_ROOT", "HKCC", "HKEY_CURRENT_CONFIG", "HKCU", "HKEY_CURRENT_USER", "HKU", "HKEY_USERS", "HKLM" or "HKEY_LOCAL_MACHINE" (HKLM is the default if nothing matches)
GetWindowsRegistryNames(String, String) - Method in class sage.api.Utility
Returns a list of the Windows registry names which exist under the specified root & key (Windows only) Acceptable values for the Root are: "HKCR", "HKEY_CLASSES_ROOT", "HKCC", "HKEY_CURRENT_CONFIG", "HKCU", "HKEY_CURRENT_USER", "HKU", "HKEY_USERS", "HKLM" or "HKEY_LOCAL_MACHINE" (HKLM is the default if nothing matches)
GetWindowsRegistryStringValue(String, String, String) - Method in class sage.api.Utility
Returns a string value from the Windows registry for the specified root, key and name(Windows only) Acceptable values for the Root are: "HKCR", "HKEY_CLASSES_ROOT", "HKCC", "HKEY_CURRENT_CONFIG", "HKCU", "HKEY_CURRENT_USER", "HKU", "HKEY_USERS", "HKLM" or "HKEY_LOCAL_MACHINE" (HKLM is the default if nothing matches)
GetWorkingDirectory() - Method in class sage.api.Utility
Returns the current working directory for the application (if this is a client; it'll be the working directory of the server)
Global - Class in sage.api
System methods used for dealing with Sage specifics
Global() - Constructor for class sage.api.Global
 
GroupByArrayMethod(Object, String) - Method in class sage.api.Database
Grouping method for data lists/maps.
GroupByMethod(Object, String) - Method in class sage.api.Database
Grouping method for data lists/maps.
GuessMajorFileType(String) - Method in class sage.api.Utility
Guesses what media type the specified filename corresponds to.

H

HasAlbumArt(Album) - Method in class sage.api.AlbumAPI
Returns true if there is album art for this Album
HasAnyThumbnail(MediaFile) - Method in class sage.api.MediaFileAPI
Returns true if this MediaFile object has a thumbnail representation of it.
HasDirectX9() - Method in class sage.api.Configuration
Returns true if the system has DirectX 9 installed (Windows Only)
HasEditorialImage(TVEditorial) - Method in class sage.api.TVEditorialAPI
Returns true if the specified editorial has an image that corresponds to it
HasEVRSupport() - Method in class sage.api.Configuration
Returns true if the system has support for the Enhanced Video Renderer (EVR) (Windows Only)
HasLocalFilesystem() - Method in class sage.api.Utility
Returns true if this client has a local file system that can be accessed.
HasMediaFile() - Method in class sage.api.MediaPlayerAPI
Returns true if the MediaPlayer currently has a file that is loading or loaded.
HasMediaMask(DBObject, String) - Method in class sage.api.Database
Tests whether the passed in DBObject matches any of the categories specified in the passed in MediaMask.
HasMovieImage(Show) - Method in class sage.api.ShowAPI
Returns true if the passed in Show that represents a Movie has any imagery associated with it
HasParentalLockCode() - Method in class sage.api.Configuration
Returns true if a parental lock code has been configured
HasPermission(String, String) - Method in class sage.api.Security
Returns true if the specified permission is allowed under the specified security profile.
HasPermission(String) - Method in class sage.api.Security
Returns true if the specified permission is allowed under the security profile active for the UI making this API call.
HasPersonImage(Person) - Method in class sage.api.ShowAPI
Returns true if the passed in Person has an image associated with them
HasPVR350TVOutput() - Method in class sage.api.Configuration
Returns true if the system has a Hauppauge WinTV PVR-350 card installed which can produce a TV output (Windows only)
HasSeriesActorImage(SeriesInfo, Person) - Method in class sage.api.SeriesInfoAPI
Returns true if the specified SeriesInfo has a corresponding image for it for the specified Person in it
HasSeriesImage(SeriesInfo) - Method in class sage.api.SeriesInfoAPI
Returns true if the specified SeriesInfo has a corresponding image for it
HasSpecificThumbnail(MediaFile) - Method in class sage.api.MediaFileAPI
Returns true if this MediaFile object has a thumbnail for it that is unique to the content itself.
HasWidgetProperty(Widget, String) - Method in class sage.api.WidgetAPI
Returns true if the specified Widget has a property defined with the specified name

I

If(boolean, Object, Object) - Method in class sage.api.Utility
Returns the second argument if the first argument is true, otherwise the third argument is returned.
IMAGE_H_TAG - Static variable in class sage.media.rss.RSSHandler
 
IMAGE_TAG - Static variable in class sage.media.rss.RSSHandler
 
IMAGE_W_TAG - Static variable in class sage.media.rss.RSSHandler
 
ImportSTVFile(File) - Method in class sage.api.WidgetAPI
Imports a SageTV Application Definition file into the current STV file that is loaded.
InsertIntoPlaylist(Playlist, int, Object) - Method in class sage.api.PlaylistAPI
Inserts a new item into the specified Playlist at the specified position.
InsertWidgetChild(Widget, Widget, int) - Method in class sage.api.WidgetAPI
Creates a parent-child relationship between two Widgets.
InstallClientPlugin(Plugin) - Method in class sage.api.PluginAPI
Installs or upgrades the specified Plugin.
InstallPlugin(Plugin) - Method in class sage.api.PluginAPI
Installs or upgrades the specified Plugin.
IsAcceleratedDrawingEnabled() - Method in class sage.api.Configuration
Returns true if 3D acceleration is enabled for the rendering engine.
IsAdvancedDeinterlacingEnabled() - Method in class sage.api.Configuration
Returns true if the client supports doing advanced deinterlacing and it is enabled.
IsAdvancedDeinterlacingSupported() - Method in class sage.api.Configuration
Returns true if the client supports doing advanced deinterlacing.
IsAiringAttributeSet(Airing, String) - Method in class sage.api.AiringAPI
Returns whether or not the specificed attibute is set for this Airing
IsAiringHDTV(Airing) - Method in class sage.api.AiringAPI
Returns true if this Airing is in HDTV
IsAiringObject(Airing) - Method in class sage.api.AiringAPI
Returns true if the argument is an Airing object.
IsAlbumObject(Object) - Method in class sage.api.AlbumAPI
Returns true if the argument is an Album object
IsAsleep() - Method in class sage.api.Global
Returns true if SageTV is in the Sleep state.
IsAutoDelete(Favorite) - Method in class sage.api.FavoriteAPI
Returns true if SageTV is allowed to automatically delete recordings of this Favorite when it needs more disk space.
IsBackgroundFileDownloadProgressivePlay(File) - Method in class sage.api.Global
Returns whether or not the current file being downloaded can be played back while being downloaded.
IsBluRay(MediaFile) - Method in class sage.api.MediaFileAPI
Returns true if this MediaFile represents BluRay content.
IsCaptureDeviceANetworkEncoder(String) - Method in class sage.api.CaptureDeviceAPI
Returns true if a CaptureDevice is a Network Encoder
IsCaptureDeviceFunctioning(String) - Method in class sage.api.CaptureDeviceAPI
Returns whether or not a CaptureDevice is functioning (i.e.
IsCaptureDeviceHardwareEncoder(String) - Method in class sage.api.CaptureDeviceAPI
Returns true if the CaptureDevice is a hardware encoder
IsCaptureDeviceInputAudioVideo(String) - Method in class sage.api.CaptureDeviceInputAPI
Returns whether or not this CaptureDeviceInput captures both audio and video
IsCaptureDeviceInUseByALiveClient(String) - Method in class sage.api.CaptureDeviceAPI
Returns true if the CaptureDevice is currently under control of a client who is (or was) watching live TV
IsChannelDownloadComplete(String) - Method in class sage.api.Global
Returns true if the channel download has been completed on the specified lineup
IsChannelObject(Channel) - Method in class sage.api.ChannelAPI
Returns true if the argument is a Channel object.
IsChannelRemappedOnLineup(Channel, String) - Method in class sage.api.ChannelAPI
Returns true if the user has remapped this Channel to a different number than it's default on the specified Lineup
IsChannelViewable(Channel) - Method in class sage.api.ChannelAPI
Returns true if there is a configured lineup for which this channel is viewable.
IsChannelViewableOnLineup(Channel, String) - Method in class sage.api.ChannelAPI
Returns true if this Channel is viewable on the specified Lineup
IsChannelViewableOnNumberOnLineup(Channel, String, String) - Method in class sage.api.ChannelAPI
Returns true if this Channel is viewable on the specified Lineup on the specified channel number
IsClient() - Method in class sage.api.Global
Returns true if this is an instance of SageTV Client
IsClientDisconnected() - Method in class sage.api.Global
Returns true if this is an instance of SageTVClient (or a remote client connected via SageTVClient) and there is currently not a connection to the server.
IsClientPluginCompatible(Plugin) - Method in class sage.api.PluginAPI
Returns whether or not the specified Plugin object is compatible and can be installed.
IsClientPluginInstalled(Plugin) - Method in class sage.api.PluginAPI
Returns true if the specified plugin has already been installed into the locally running SageTVClient
IsClientPluginInstalledSameVersion(Plugin) - Method in class sage.api.PluginAPI
Returns true if the specified plugin has already been installed into the locally running SageTVClient and is the same version as this one
IsCompleteRecording(MediaFile) - Method in class sage.api.MediaFileAPI
Returns true if SageTV considers this MediaFile a 'complete' recording.
IsCorrectParentalLockCode(String) - Method in class sage.api.MediaPlayerAPI
Returns true if the argument passed in matches the parental lock code in the system
IsCurrentMediaFileDVD() - Method in class sage.api.MediaPlayerAPI
Returns true if the MediaPlayer has a file loading or loaded, and that file is a DVD
IsCurrentMediaFileMusic() - Method in class sage.api.MediaPlayerAPI
Returns true if the MediaPlayer has a file loading or loaded, and that file is a music file
IsCurrentMediaFileRecording() - Method in class sage.api.MediaPlayerAPI
Returns true if the MediaPlayer has a file loading or loaded, and that file is currently being recorded
IsDatabaseMemoryMaxed() - Method in class sage.api.Database
Returns true if the database has maxed out its memory usage and cannot add more content
IsDeleteAfterAutomaticConversion(Favorite) - Method in class sage.api.FavoriteAPI
If an automatic conversion quality is set for this Favorite; then this will return true if the original file will be deleted after that conversion is performed
IsDesktopUI() - Method in class sage.api.Global
Returns true if this UI is being run in a desktop environment.
IsDirectoryPath(String) - Method in class sage.api.Utility
Returns true if the specified path denotes a directory that exists
IsDoingLibraryImportScan() - Method in class sage.api.Global
Returns true if the server is currently scanning the import directories for new files
IsDontLike(Airing) - Method in class sage.api.AiringAPI
Returns true if this Airing has been set as content the user "Doesn't Like"
IsDscalerDoubleRefresh() - Method in class sage.api.Configuration
Returns true if DScaler is set to double the refresh rate when used.
IsDscalerEnabled() - Method in class sage.api.Configuration
Returns true if the DScaler deinterlacing filter is enabled (Windows only)
IsDscalerOddFieldFirst() - Method in class sage.api.Configuration
Returns true if DScaler is configured to display the odd field first (fields are even or odd)
IsDVD(MediaFile) - Method in class sage.api.MediaFileAPI
Returns true if this MediaFile represents DVD content.
IsDVDDrive(MediaFile) - Method in class sage.api.MediaFileAPI
Returns true if this MediaFile represents the physical DVD drive in the system.
IsEmbeddedServer() - Method in class sage.api.Global
Returns true if running on an 'embedded' platform in standalone mode or running as a SageTV Client that is connected to a server running on an embedded platform.
IsEmbeddedSystem() - Method in class sage.api.Global
Returns true if running on an 'embedded' platform.
IsEmpty(Object) - Method in class sage.api.Utility
Returns true if the argument is null, zero, an empty string or a failed image load
IsExternallyTunedRFInput(String) - Method in class sage.api.CaptureDeviceInputAPI
Returns true if this input was created using AddInputForRFChannel() method call
IsFavorite(Airing) - Method in class sage.api.AiringAPI
Returns true if this Airing matches one of the Favorites the user has setup
IsFavoriteEnabled(Favorite) - Method in class sage.api.FavoriteAPI
Returns true if SageTV considers this favorite when performing scheduling.
IsFavoriteObject(Object) - Method in class sage.api.FavoriteAPI
Returns true if the argument is a Favorite object, false otherwise
IsFileCurrentlyRecording(MediaFile) - Method in class sage.api.MediaFileAPI
Returns true if this MediaFile is currently in the process of recording.
IsFileDownloadProgressivePlay() - Method in class sage.api.Global
Returns whether or not the current file being downloaded can be played back while being downloaded.
IsFilePath(String) - Method in class sage.api.Utility
Returns true if the specified file path denotes a file that exists and is not a directory
IsFilePathHidden(String) - Method in class sage.api.Utility
Returns true if the specified file path is marked as a hidden file
IsFirstRuns(Favorite) - Method in class sage.api.FavoriteAPI
Returns true if this Favorite is configured to record first runs (it may or may not record reruns)
IsFirstRunsAndReRuns(Favorite) - Method in class sage.api.FavoriteAPI
Returns true if this Favorite is configured to record both first runs and reruns.
IsFirstRunsOnly(Favorite) - Method in class sage.api.FavoriteAPI
Returns true if this Favorite is configured to record first runs but not reruns.
IsFullScreen() - Method in class sage.api.Global
Returns whether or not SageTV is in full screen mode
IsImageLoaded(Object) - Method in class sage.api.Utility
Checks whether the passed in MetaImage (from an API call that returns MetaImage), MediaFile, File, URL or Album is loaded into system memory or into the VRAM cache of the corresponding UI making the call.
IsImportableFileType(String) - Method in class sage.api.Utility
Returns true if the specified file path has a file extension which would be imported by SageTV into its library.
IsIntelligentRecordingDisabled() - Method in class sage.api.Configuration
Returns true if the 'Intelligent Recording' feature of SageTV is disabled.
IsLibraryFile(MediaFile) - Method in class sage.api.MediaFileAPI
Returns true if the specified MediaFile has been either imported using a library path or if this is a television recording that has had the 'Move to Library' operation performed on it.
IsLinuxOS() - Method in class sage.api.Global
Returns true if SageTV is currently running on a Linux operating system.
IsLocalDirectoryPath(String) - Method in class sage.api.Utility
Returns true if the specified local path denotes a directory that exists
IsLocalFile(MediaFile) - Method in class sage.api.MediaFileAPI
Returns true if the specified MediaFile is local to this system (i.e.
IsLocalFilePath(String) - Method in class sage.api.Utility
Returns true if the specified local file path denotes a file that exists and is not a directory
IsLocalFilePathHidden(String) - Method in class sage.api.Utility
Returns true if the specified local file path is marked as a hidden file
IsLocalRestartNeeded() - Method in class sage.api.Utility
Returns true if the local instance of SageTV needs to be restarted due to a plugin install/uninstall
IsMacOS() - Method in class sage.api.Global
Returns true if SageTV is currently running on a Macintosh operating system.
IsMajorMinorDTVChannelTuningEnabled() - Method in class sage.api.Configuration
Deprecated.  
IsManualRecord(Airing) - Method in class sage.api.AiringAPI
Returns true if this Airing has been selected by the user to manually record Record()
IsMediaFileObject(Object) - Method in class sage.api.MediaFileAPI
Returns true if the specified object is a MediaFile object.
IsMediaNodeObject(Object) - Method in class sage.api.MediaNodeAPI
Returns true if the specified object is a MediaNode object.
IsMediaPlayerFullyLoaded() - Method in class sage.api.MediaPlayerAPI
Returns true if the MediaPlayer is fully loaded.
IsMediaPlayerLoading() - Method in class sage.api.MediaPlayerAPI
Returns true if the MediaPlayer is loading.
IsMediaPlayerSignalLost() - Method in class sage.api.MediaPlayerAPI
Returns true if the source the MediaPlayer is trying to playback from indicates a signal loss.
IsMetaImage(Object) - Method in class sage.api.Utility
Returns true if the argument is a MetaImage object.
IsMovie(Show) - Method in class sage.api.ShowAPI
Returns true if the specified Show object is a Movie.
IsMusicFile(MediaFile) - Method in class sage.api.MediaFileAPI
Returns true if this MediaFile's content is audio only.
IsMuted() - Method in class sage.api.MediaPlayerAPI
Returns true if the MediaPlayer is currently in a muted state.
IsMutedOnAlternateSpeedPlayback() - Method in class sage.api.Configuration
Returns true if SageTV should mute the volume when media is played back at speeds besides x1
IsNativeOutputResolutionEnabled() - Method in class sage.api.Configuration
Returns true if this device is configured to match the output resolution to the media format's resolution
IsNodeFilterMatching(MediaNode, int) - Method in class sage.api.MediaNodeAPI
Returns the match state of the current filtering technique used by the specified MediaNode hierarchy.
IsNodeFolder(MediaNode) - Method in class sage.api.MediaNodeAPI
Returns true if the specified MediaNode has children
IsNodeHierarchyRealized(MediaNode) - Method in class sage.api.MediaNodeAPI
Returns true if the entire set of data objects that back this MediaNode hierarchy has already been realized.
IsNodePlayable(MediaNode) - Method in class sage.api.MediaNodeAPI
Returns true if the Object that this MediaNode wraps is suitable for passing to the Watch API call.
IsNodeSortAscending(MediaNode) - Method in class sage.api.MediaNodeAPI
Returns true if the current sorting technique used by the specified MediaNode hierarchy is in ascending order, false otherwise
IsNodeVirtual(MediaNode) - Method in class sage.api.MediaNodeAPI
Returns true if the specified MediaNode doesn't wrap an actual data object; but just an abstraction of a hierarchy
IsNotManualOrFavorite(Airing) - Method in class sage.api.AiringAPI
Returns true if this Airing has NOT been selected by the user to manually record Record() and is also NOT a Favorite (i.e.
IsOptionsMenuOpen() - Method in class sage.api.Global
Returns true if an options menu is currently open in the UI.
IsParentalControlEnabled() - Method in class sage.api.Configuration
Returns true if parental controls are enabled on the system
IsPhysicalChannelRemappedOnLineup(Channel, String) - Method in class sage.api.ChannelAPI
Returns true if the user has remapped this physical Channel to a different physical number than it's default on the specified Lineup
IsPictureFile(MediaFile) - Method in class sage.api.MediaFileAPI
Returns true if this MediaFile's content represents a picture file
IsPlaceshifterLoginCachingAllowed() - Method in class sage.api.Configuration
Returns true if this server allows caching of placeshifter logins, false otherwise
IsPlaying() - Method in class sage.api.MediaPlayerAPI
Returns true if the MediaPlayer is currently playing back content (i.e.
IsPlaylistObject(Object) - Method in class sage.api.PlaylistAPI
Returns true if the passed in argument is a Playlist object
IsPluginBeta(Plugin) - Method in class sage.api.PluginAPI
Returns true if the specified plugin is tagged as a 'beta' version.
IsPluginCompatible(Plugin) - Method in class sage.api.PluginAPI
Returns whether or not the specified Plugin object is compatible and can be installed.
IsPluginConfigurable(Plugin) - Method in class sage.api.PluginAPI
Returns true if the specified plugin can be configured when enabled.
IsPluginDesktopOnly(Plugin) - Method in class sage.api.PluginAPI
Returns true if the specified plugin is only supported in desktop environments (i.e.
IsPluginEnabled(Plugin) - Method in class sage.api.PluginAPI
Returns true if the specified plugin has already been installed and is enabled.
IsPluginFailed(Plugin) - Method in class sage.api.PluginAPI
Returns true if the specified plugin has already been installed and is enabled; but the loading of it has failed.
IsPluginInstalled(Plugin) - Method in class sage.api.PluginAPI
Returns true if the specified plugin has already been installed
IsPluginInstalledSameVersion(Plugin) - Method in class sage.api.PluginAPI
Returns true if the specified plugin has already been installed and is the same version as this one
IsPluginObject(Object) - Method in class sage.api.PluginAPI
Returns true if the specified object is a Plugin object
IsPluginStartupComplete() - Method in class sage.api.PluginAPI
Returns true once all of the core plugins that are enabled have completed their startup process.
IsProvideoPentium4FixEnabled() - Method in class sage.api.Configuration
Deprecated.  
IsPVR() - Method in class sage.api.Global
Returns true if running on a system or connected to a server that has PVR functionality.
IsPVR350OSDEnabled() - Method in class sage.api.Configuration
Returns true if the user interface (OSD) display on a Hauppauge WinTV PVR-350 should be shown through the tv output (Windows only)
IsPVR350TVOutputEnabled() - Method in class sage.api.Configuration
Returns true if the TV output on a Hauppauge WinTV PVR-350 card is enabled (Windows only)
IsRatingUnderParentalLock(String) - Method in class sage.api.Configuration
Returns true if the specified rating is in the list that is under parental control
IsRemoteUI() - Method in class sage.api.Global
Returns true if this UI is being remoted onto another device such as a media extender.
IsReRuns(Favorite) - Method in class sage.api.FavoriteAPI
Returns true if this Favorite is configured to record reruns (it may or may not record first runs)
IsReRunsOnly(Favorite) - Method in class sage.api.FavoriteAPI
Returns true if this Favorite is configured to record reruns but not first runs.
IsRFSignalCableTV(String) - Method in class sage.api.CaptureDeviceInputAPI
Returns whether or not this CaptureDeviceInput tunes for Antenna or Cable if it's a TV Tuner input
IsSageTVServerEnabled() - Method in class sage.api.Configuration
Returns true if the SageTV server is enabled.
IsScreenSaverOnSleepEnabled() - Method in class sage.api.Configuration
Returns true if SageTV will go to its screen saver when it is put to sleep.
IsSeriesInfoObject(Object) - Method in class sage.api.SeriesInfoAPI
Returns true if the argument is a SeriesInfo object.
IsServerRestartNeeded() - Method in class sage.api.Utility
Returns true if the server instance of SageTV needs to be restarted due to a plugin install/uninstall
IsServerUI() - Method in class sage.api.Global
Returns true if this UI is being run on the same system as the SageTV Server it's connected to.
IsShowEPGDataUnique(Show) - Method in class sage.api.ShowAPI
If this is true, then two Airings that both represent this Show will contain the same content.
IsShowFirstRun(Airing) - Method in class sage.api.ShowAPI
Returns true if the specified Airing represents the first run of the Show content.
IsShowingDVDMenu() - Method in class sage.api.MediaPlayerAPI
Returns true if the MediaPlayer currently has DVD content loaded and that content is showing a DVD menu that can have user interaction
IsShowObject(Object) - Method in class sage.api.ShowAPI
Returns true if the passed in argument is a Show object.
IsShowReRun(Airing) - Method in class sage.api.ShowAPI
Returns true if the specified Airing represents a rerun of the Show content.
IsSoftwareDecodingDisabled() - Method in class sage.api.Configuration
Returns true if software decoding is disabled.
IsSTVModified() - Method in class sage.api.WidgetAPI
Returns true if the currently loaded STV has been modified at all since its last save
IsSyncSystemClockWithServerEnabled() - Method in class sage.api.Configuration
Returns true if SageTV should synchronize the system clock with the server.
IsSystemMessageObject(Object) - Method in class sage.api.SystemMessageAPI
Returns true if the passed in argument is a SystemMessage object
IsTableTransitionToNext(Object) - Method in class sage.api.Global
Returns true if the specified table argument (or the first table parent of the argument) is on the leading edge of a transition to a cell after the current one.
IsTableTransitionToPrevious(Object) - Method in class sage.api.Global
Returns true if the specified table argument (or the first table parent of the argument) is on the leading edge of a transition to a cell before the current one.
IsThumbnailLoaded(MediaFile) - Method in class sage.api.MediaFileAPI
Checks whether the passed thumbnail for the specified MediaFile is loaded into system memory or into the VRAM cache of the corresponding UI making the call.
IsTransitioningFromMenu(String) - Method in class sage.api.Global
Returns true if the specified menu name matches the name of the menu widget for the previously loaded menu.
IsTransitioningFromMenus(String[]) - Method in class sage.api.Global
Returns true if one of the specified menu names matches the name of the menu widget for the previously loaded menu.
IsTransitioningToMenu(String) - Method in class sage.api.Global
Returns true if the specified menu name matches the name of the menu widget that the UI is in the process of transitioning to.
IsTransitioningToMenus(String[]) - Method in class sage.api.Global
Returns true if one of the specified menu name matches the name of the menu widget that the UI is in the process of transitioning to.
IsTVFile(MediaFile) - Method in class sage.api.MediaFileAPI
Returns true if this MediaFile represents recorded television content
IsUserRecordObject(Object) - Method in class sage.api.UserRecordAPI
Returns true if the passed in argument is a UserRecord object
IsVideoFile(MediaFile) - Method in class sage.api.MediaFileAPI
Returns true if this MediaFile's content is an audio/video or video file (this will be false for DVD/BluRay content)
IsVideoRendererDefault() - Method in class sage.api.Configuration
Returns true if the video renderer is configured to use the Default renderer (Windows Only).
IsVideoRendererEVR() - Method in class sage.api.Configuration
Returns true if the video renderer is configured to use the Enhanced Video Renderer (Windows Only).
IsVideoRendererOverlay() - Method in class sage.api.Configuration
Returns true if the video renderer is configured to use the Overlay surface (Windows Only) Applies to all files except DVDs.
IsVideoRendererVMR9() - Method in class sage.api.Configuration
Returns true if the video renderer is configured to use the Video Mixing Renderer 9 (Windows Only).
IsWatched(Airing) - Method in class sage.api.AiringAPI
Returns true if this Airing's content has been completely watched already.
IsWatchedCompletely(Airing) - Method in class sage.api.AiringAPI
Returns true if this Airing has been completely watched already.
IsWidgetParentOf(Widget, Widget) - Method in class sage.api.WidgetAPI
Returns true if the specified Widgets have a parent-child relationship.
IsWindowsOS() - Method in class sage.api.Global
Returns true if SageTV is currently running on a Windows operating system.
ITEM_TAG - Static variable in class sage.media.rss.RSSHandler
 
ITUNES_AUTHOR - Static variable in class sage.media.rss.RSSHandler
 
ITUNES_DURATION - Static variable in class sage.media.rss.RSSHandler
 
ITUNES_IMAGE - Static variable in class sage.media.rss.RSSHandler
 
ITUNES_KEYWORDS - Static variable in class sage.media.rss.RSSHandler
 
ITUNES_SUMMARY - Static variable in class sage.media.rss.RSSHandler
 

K

Keystroke(String, boolean) - Method in class sage.api.Utility
Executes the specified keystroke in either the SageTV event system or by emulation in the operating system

L

LANGUAGE_TAG - Static variable in class sage.media.rss.RSSHandler
 
LAST_B_DATE_TAG - Static variable in class sage.media.rss.RSSHandler
 
LaunchMenuWidget(Widget) - Method in class sage.api.WidgetAPI
Launches a new menu in SageTV with the specified Widget as the menu's definition.
LearnCommandForInfraredTuningPlugin(String, int, String, String) - Method in class sage.api.Configuration
Informs an infrared tuning plugin that it should go into the learn mode to learn a new command.
link - Variable in class sage.media.rss.RSSObject
 
LINK_TAG - Static variable in class sage.media.rss.RSSHandler
 
LinkIRCodeToSageCommand(long, String) - Method in class sage.api.Configuration
Links an infrared code to a SageTV Command.
LinkKeystrokeToSageCommand(String, String) - Method in class sage.api.Configuration
Links a keystroke to a SageTV Command.
LoadImage(Object) - Method in class sage.api.Utility
Returns a MetaImage object that refers to a specified image resource.
LoadImageFile(File) - Method in class sage.api.Utility
Returns a MetaImage object that refers to the specified image file.
LoadSTVFile(File) - Method in class sage.api.WidgetAPI
Loads a new SageTV Application Definition file that defines the entire user interface for SageTV
LocalDirectoryListing(File) - Method in class sage.api.Utility
Returns a list of the files in the specified directory on the local filesystem
LocalizeString(String) - Method in class sage.api.Utility
Returns a localized version of the specified string.
LockTuner(String) - Method in class sage.api.MediaPlayerAPI
Instructs SageTV to take control of the specified CaptureDeviceInput.
lookup(CharacterReference[], char, int, int) - Static method in class sage.media.rss.Translate
Binary search for a reference.
lookup(char) - Static method in class sage.media.rss.Translate
Look up a reference by character.
lookup(CharacterReference) - Static method in class sage.media.rss.Translate
Look up a reference by kernel.
lookup(String, int, int) - Static method in class sage.media.rss.Translate
Look up a reference by kernel.
LookupIPForLocatorID(String) - Method in class sage.api.Utility
Connects to the SageTV Locator server and submits the specified Locator ID for a IP lookup.

M

main(String[]) - Static method in class sage.media.rss.Translate
Numeric character reference and character entity reference to unicode codec.
MANAGING_TAG - Static variable in class sage.media.rss.RSSHandler
 
Max(Number, Number) - Method in class sage.api.Utility
Returns the maximum of the two arguments; the type of the returned argument will be the same as the highest precision argument
mCharacter - Variable in class sage.media.rss.CharacterReference
The character value as an integer.
mCharacterList - Static variable in class sage.media.rss.Translate
List of references sorted by character.
mCharacterReferences - Static variable in class sage.media.rss.Translate
Table mapping entity reference kernel to character.
MEDIA_CONTENT_TAG - Static variable in class sage.media.rss.RSSHandler
 
MEDIA_DESCRIPTION_TAG - Static variable in class sage.media.rss.RSSHandler
 
MEDIA_GROUP_TAG - Static variable in class sage.media.rss.RSSHandler
 
MEDIA_PLAYER_TAG - Static variable in class sage.media.rss.RSSHandler
 
MEDIA_THUMBNAIL_TAG - Static variable in class sage.media.rss.RSSHandler
 
MEDIA_TITLE_TAG - Static variable in class sage.media.rss.RSSHandler
 
MediaFileAPI - Class in sage.api
A MediaFile represents a physical file or a group of files that represent the same content.
MediaFileAPI() - Constructor for class sage.api.MediaFileAPI
 
MediaNodeAPI - Class in sage.api
Virtual content directory abstraction.
MediaNodeAPI() - Constructor for class sage.api.MediaNodeAPI
 
MediaPlayerAPI - Class in sage.api
Calls for playing back media in SageTV and for controlling that playback
MediaPlayerAPI() - Constructor for class sage.api.MediaPlayerAPI
 
mEnd - Variable in class sage.media.rss.CharacterReferenceEx
The ending point in the string.
Min(Number, Number) - Method in class sage.api.Utility
Returns the minimum of the two arguments; the type of the returned argument will be the same as the highest precision argument
mKernel - Variable in class sage.media.rss.CharacterReference
This entity reference kernel.
MoveFileToLibrary(MediaFile) - Method in class sage.api.MediaFileAPI
Marks a MediaFile object as being 'Moved to Library' which means the IsLibraryFile() call will now return true.
MovePlaylistItemDown(Playlist, int) - Method in class sage.api.PlaylistAPI
Swaps the position of the item at the specified index in the Playlist with the item at the position (Index + 1)
MovePlaylistItemUp(Playlist, int) - Method in class sage.api.PlaylistAPI
Swaps the position of the item at the specified index in the Playlist with the item at the position (Index - 1)
MoveTVFileOutOfLibrary(MediaFile) - Method in class sage.api.MediaFileAPI
Un-marks a MediaFile object as being 'Moved to Library' which means the IsLibraryFile() call will no longer return true.
mStart - Variable in class sage.media.rss.CharacterReferenceEx
The starting point in the string.

N

NAME_TAG - Static variable in class sage.media.rss.RSSHandler
 
NumberFormat(String, float) - Method in class sage.api.Utility
Returns a formatted numeric string for the specified number.

P

parse() - Method in class sage.media.rss.RSSParser
Parse the documen
parseXmlFile(String, DefaultHandler, boolean) - Static method in class sage.media.rss.RSSParser
Parse rss file
parseXmlFile(URL, DefaultHandler, boolean) - Static method in class sage.media.rss.RSSParser
Parse rss file from a url
PassiveListen() - Method in class sage.api.Global
Should only be used in the Action chain from a Listener Widget.
Pause() - Method in class sage.api.MediaPlayerAPI
Pauses playback in the MediaPlayer.
pdate - Variable in class sage.media.rss.RSSObject
 
Play() - Method in class sage.api.MediaPlayerAPI
Resumes playback in the MediaPlayer.
PlayFaster() - Method in class sage.api.MediaPlayerAPI
Sets the playback rate of the MediaPlayer to be twice the current playback rate.
PlaylistAPI - Class in sage.api
Calls for creating, editing, removing and querying playlists in the system
PlaylistAPI() - Constructor for class sage.api.PlaylistAPI
 
PlayPause() - Method in class sage.api.MediaPlayerAPI
Pauses playback of the MediaPlayer if it is currently playing or resumes playback of the MediaPlayer if it is currently paused.
PlaySlower() - Method in class sage.api.MediaPlayerAPI
Sets the playback rate of the MediaPlayer to be half the current playback rate.
PlaySound(String) - Method in class sage.api.Utility
Plays the specified sound file (used for sound effects, don't use for music playback)
PluginAPI - Class in sage.api
API calls to be used for downloading, enabling and disabling of SageTV Plugins from the central repository.
PluginAPI() - Constructor for class sage.api.PluginAPI
 
PostSystemMessage(int, int, String, Properties) - Method in class sage.api.SystemMessageAPI
Creates a new SystemMessage and posts it to the message queue.
PrepareForFirmwareLoad() - Method in class sage.api.Global
Prepares the device for a firmware download & flash.
PrintAiringLong(Airing) - Method in class sage.api.AiringAPI
Returns a lengthy string which is suitable for displaying information about this Airing.
PrintAiringMedium(Airing) - Method in class sage.api.AiringAPI
Returns a string which is suitable for displaying information about this Airing.
PrintAiringShort(Airing) - Method in class sage.api.AiringAPI
Returns a brief string which is suitable for displaying information about this Airing.
PrintCurrentTime() - Method in class sage.api.Utility
Returns a string that represents the current time.
PrintDate(long) - Method in class sage.api.Utility
Returns a formatted date string using the java.text.DateFormat.MEDIUM formatting technique
PrintDateFull(long) - Method in class sage.api.Utility
Returns a formatted date string using the java.text.DateFormat.FULL formatting technique
PrintDateLong(long) - Method in class sage.api.Utility
Returns a formatted date string using SageTV's default detailed date formatting
PrintDateShort(long) - Method in class sage.api.Utility
Returns a formatted date string using the java.text.DateFormat.SHORT formatting technique
PrintDuration(long) - Method in class sage.api.Utility
Returns a formatted duration string according to SageTV's verbose duration formating, minutes is the most detailed resolution of this format
PrintDurationShort(long) - Method in class sage.api.Utility
Returns a formatted duration string according to SageTV's concise duration formating, minutes is the most detailed resolution of this format
PrintDurationWithSeconds(long) - Method in class sage.api.Utility
Returns a formatted duration string according to SageTV's default duration formating, seconds is the most detailed resolution of this format
PrintTime(long) - Method in class sage.api.Utility
Returns a formatted time string using the java.text.DateFormat.MEDIUM formatting technique
PrintTimeFull(long) - Method in class sage.api.Utility
Returns a formatted time string using the java.text.DateFormat.FULL formatting technique
PrintTimeLong(long) - Method in class sage.api.Utility
Returns a formatted time string using the java.text.DateFormat.LONG formatting technique
PrintTimeShort(long) - Method in class sage.api.Utility
Returns a formatted time string using the java.text.DateFormat.SHORT formatting technique
PUB_DATE_TAG - Static variable in class sage.media.rss.RSSHandler
 

Q

QueryServerMacAddress(String) - Method in class sage.api.Utility
Gets the MAC address of the SageTV server at the specified hostname.

R

RATING_TAG - Static variable in class sage.media.rss.RSSHandler
 
Record(Airing) - Method in class sage.api.AiringAPI
Specifies that this Airing should be recorded.
ReformatDeviceAtPathAsEXT3(String) - Method in class sage.api.Utility
Determines the device that is mounted at the specified path, and then repartitions it to have a single EXT3 partition and then formats that partition.
Refresh() - Method in class sage.api.Global
Re-evaluates and redraws all UI elements on the current menu
RefreshArea(String) - Method in class sage.api.Global
Finds the Widget on the current menu who's name matches the argument and then re-evaluates and redraws all UI elements, and their children for this Widget
RefreshAreaForVariable(String, Object) - Method in class sage.api.Global
Searches all visible UI elements in the current menu finding any that have a variable with the specified name matching the specified value.
RefreshAvailablePlugins() - Method in class sage.api.PluginAPI
Refreshes the plugin repository list by contacting the server to ensure it is up to date (this is done automatically on a regular basis)
RefreshNode(MediaNode) - Method in class sage.api.MediaNodeAPI
Refreshes the hierarchy associated with the specified MediaNode.
RegeneratePictureThumbnail(MediaFile) - Method in class sage.api.MediaFileAPI
Regenerates the thumbnail associated with the specified picture file.
ReleaseCaptureDeviceInput(String) - Method in class sage.api.CaptureDeviceInputAPI
Releases this CaptureDeviceInput from its currently configured lineup.
ReleaseUIRefreshLock() - Method in class sage.api.Utility
Releases the lock for this user interface system to allow other updates to occur.
ReloadCurrentFile() - Method in class sage.api.MediaPlayerAPI
Reloads the current file that is loaded by the MediaPlayer.
ReloadNameserverCache() - Method in class sage.api.Utility
Reloads the name server cache.
ReloadSystemHooks() - Method in class sage.api.Global
This is a Windows only API call which tells SageTV to unload and then reload any system hooks it has installed.
RemoveCommandForInfraredTuningPlugin(String, int, String, String) - Method in class sage.api.Configuration
Removes a command from a 'Remote Control' for an infrared tuning plugin.
RemoveElement(Object, Object) - Method in class sage.api.Utility
Removes the element at with the specified value from this data.
RemoveElementAtIndex(List, int) - Method in class sage.api.Utility
Removes the element at the specified index in this data; works java.util.List implementations (i.e.
RemoveFavorite(Favorite) - Method in class sage.api.FavoriteAPI
Removes a Favorite object from the database.
RemoveLibraryImportPath(File) - Method in class sage.api.Configuration
Removes a path from the list of library import paths.
RemoveMusicLibraryImportPath(File) - Method in class sage.api.Configuration
Removes a path from the list of library import paths for music
RemovePictureLibraryImportPath(File) - Method in class sage.api.Configuration
Removes a path from the list of library import paths for pictures
RemovePlaylist(Playlist) - Method in class sage.api.PlaylistAPI
Removes a specified Playlist from the databse completely.
RemovePlaylistItem(Playlist, Object) - Method in class sage.api.PlaylistAPI
Removes the specified item from the Playlist.
RemovePlaylistItemAt(Playlist, int) - Method in class sage.api.PlaylistAPI
Removes the specified item at the specified index from the Playlist.
RemoveProperty(String) - Method in class sage.api.Configuration
Removes the specified property from the property map
RemovePropertyAndChildren(String) - Method in class sage.api.Configuration
Removes the specified property and any subproperties that start with the same prefix
RemoveRemoteForInfraredTuningPlugin(String, int, String) - Method in class sage.api.Configuration
Removes a 'Remote Control' from an infrared tuning plugin.
RemoveSecurityProfile(String) - Method in class sage.api.Security
Removes the security profile with the specified name.
RemoveServerProperty(String) - Method in class sage.api.Configuration
Removes the specified property from the property map.
RemoveServerPropertyAndChildren(String) - Method in class sage.api.Configuration
Removes the specified property and any subproperties that start with the same prefix.
RemoveTranscodeFormat(String) - Method in class sage.api.TranscodeAPI
Removed the specified transcode format to the list of available formats
RemoveUnusedLineups() - Method in class sage.api.Global
Removes all of the lineups from SageTV's configuration that are no longer in use by a CaptureDevice
RemoveVideoDirectory(File) - Method in class sage.api.Configuration
Removes a directory from SageTV's list of directories that it can record television to.
RemoveVideoLibraryImportPath(File) - Method in class sage.api.Configuration
Removes a path from the list of library import paths for videos
RemoveWidget(Widget) - Method in class sage.api.WidgetAPI
Removes a Widget from the STV
RemoveWidgetChild(Widget, Widget) - Method in class sage.api.WidgetAPI
Breaks a parent-child relationships between two Widgets.
RemoveWindowsRegistryValue(String, String, String) - Method in class sage.api.Utility
Removes a value from the Windows registry for the specified root, key and name(Windows only) Acceptable values for the Root are: "HKCR", "HKEY_CLASSES_ROOT", "HKCC", "HKEY_CURRENT_CONFIG", "HKCU", "HKEY_CURRENT_USER", "HKU", "HKEY_USERS", "HKLM" or "HKEY_LOCAL_MACHINE" (HKLM is the default if nothing matches)
RenameCommandForInfraredTuningPlugin(String, int, String, String, String) - Method in class sage.api.Configuration
Renames a command for a remote control on an infrared tuning plugin
RenameFilePath(File, File) - Method in class sage.api.Utility
Renames a file/directory
Repaint() - Method in class sage.api.Global
Redraws all UI elements on the current menu
RepaintArea(String) - Method in class sage.api.Global
Finds the Widget on the current menu who's name matches the argument and then redraws all UI elements, and their children for this Widget
ResetPluginConfiguration(Plugin) - Method in class sage.api.PluginAPI
Resets the configuration for the specified plugin.
ResetSystemAlertLevel() - Method in class sage.api.SystemMessageAPI
Resets the global alert level in the system back to zero.
Restart() - Method in class sage.api.Utility
Restarts the local instance of SageTV.
RotatePictureFile(MediaFile, int) - Method in class sage.api.MediaFileAPI
Performs a lossless rotation of the specified JPEG picture file (90, 180 or 270 degrees).
Round(Object) - Method in class sage.api.Utility
Rounds a floating point number to an integral value.
RSSChannel - Class in sage.media.rss
RSSChannel's definitions class.
RSSChannel() - Constructor for class sage.media.rss.RSSChannel
 
RSSDoublinCoreModule - Class in sage.media.rss
Handler for doublin core information.
RSSDoublinCoreModule() - Constructor for class sage.media.rss.RSSDoublinCoreModule
 
RSSEnclosure - Class in sage.media.rss
 
RSSEnclosure(String, String, String) - Constructor for class sage.media.rss.RSSEnclosure
Creates a new instance of RSSEnclosure
RSSException - Exception in sage.media.rss
RSSlib exception handler.
RSSException(String) - Constructor for exception sage.media.rss.RSSException
 
RSSFactory - Class in sage.media.rss
RSS Factory.
RSSFactory() - Constructor for class sage.media.rss.RSSFactory
 
RSSHandler - Class in sage.media.rss
Copyright 2015 The SageTV Authors.
RSSHandler() - Constructor for class sage.media.rss.RSSHandler
 
RSSImage - Class in sage.media.rss
RSS image's definitions class.
RSSImage() - Constructor for class sage.media.rss.RSSImage
 
RSSItem - Class in sage.media.rss
RSSItems's definitions class.
RSSItem() - Constructor for class sage.media.rss.RSSItem
 
RSSMediaContent - Class in sage.media.rss
 
RSSMediaContent(String, String, String, String, String, String, String) - Constructor for class sage.media.rss.RSSMediaContent
Creates a new instance of RSSMediaContent
RSSMediaGroup - Class in sage.media.rss
 
RSSMediaGroup() - Constructor for class sage.media.rss.RSSMediaGroup
Creates a new instance of RSSMediaGroup
RSSObject - Class in sage.media.rss
Handler for all common informations about rss elements.
RSSObject() - Constructor for class sage.media.rss.RSSObject
 
RSSParser - Class in sage.media.rss
Copyright 2015 The SageTV Authors.
RSSParser() - Constructor for class sage.media.rss.RSSParser
 
RSSSequence - Class in sage.media.rss
RSSSequences's definitions class.
RSSSequence() - Constructor for class sage.media.rss.RSSSequence
 
RSSSequenceElement - Class in sage.media.rss
RSSSequenceElement's definitions class.
RSSSequenceElement() - Constructor for class sage.media.rss.RSSSequenceElement
 
RSSSyndicationModule - Class in sage.media.rss
Handler for Syndycation information.
RSSSyndicationModule() - Constructor for class sage.media.rss.RSSSyndicationModule
 
RSSTextInput - Class in sage.media.rss
RSSTextInput's definitions class.
RSSTextInput() - Constructor for class sage.media.rss.RSSTextInput
 
RunFilterAutoconfiguration() - Method in class sage.api.Configuration
Deprecated.  
RunLibraryImportScan(boolean) - Method in class sage.api.Global
Tells SageTV to run a library import scan now.

S

sage.api - package sage.api
 
sage.media.rss - package sage.media.rss
 
SageCommand(String) - Method in class sage.api.Global
Causes the corresponding Sage Command to be executed just like it would be if the user performed it.
SageCommand(String, Object) - Method in class sage.api.Global
Causes the corresponding Sage Command to be executed just like it would be if the user performed it.
SaveImageToFile(MetaImage, File, int, int) - Method in class sage.api.Utility
Saves a MetaImage object to a file using the specified image size.
SaveProperties() - Method in class sage.api.Configuration
Saves the Sage.properties file to disk
SaveScreenshotToFile(File) - Method in class sage.api.Global
Takes a screenshot of the current UI and saves it to the specified file in PNG format.
SaveWidgetsAsXML(File, boolean) - Method in class sage.api.WidgetAPI
Saves all of the current Widgets as an XML file.
ScaleBufferedImage(BufferedImage, int, int, boolean) - Method in class sage.api.Utility
Scales a java.awt.image.BufferedImage object using optimized techniques
ScanWirelessAPs() - Method in class sage.api.Utility
Scans for wireless access points and returns the results as a map.
SearchByPerson(String) - Method in class sage.api.Database
Returns all Airings in the database that refer to content that is NOT a music file and includes the specified person in the list of people involved (i.e.
SearchByPerson(String, String) - Method in class sage.api.Database
Returns all Airings in the database that refer to content that includes the specified person in the list of people involved (i.e.
SearchByText(String) - Method in class sage.api.Database
Searches the descriptions and episode names of all of the content in the database for the specified search string.
SearchByText(String, String) - Method in class sage.api.Database
Searches the descriptions and episode names of all of the content in the database for the specified search string.
SearchByTitle(String) - Method in class sage.api.Database
Returns all Airings in the database that refer to content that is NOT a music file and has the specified title.
SearchByTitle(String, String) - Method in class sage.api.Database
Returns all Airings in the database that refer to content that has the specified title.
SearchForChannel(String) - Method in class sage.api.Database
Returns all Channels in the database (disabled or not) that match the SearchString in their channel number, name, callsign or network.
SearchForChannel(String, Boolean) - Method in class sage.api.Database
Returns all Channels in the database that match the SearchString in their channel number, name, callsign or network.
SearchForPeople(String) - Method in class sage.api.Database
Returns a list of all of the people in the database that include the search string in their name.
SearchForPeople(String, String) - Method in class sage.api.Database
Returns a list of all of the people in the database that include the search string in their name.
SearchForPeopleNTE(String) - Method in class sage.api.Database
Returns a list of all of the people in the database that match the passed in text, where the Unicode characters u2460-u2468 and u24EA (Unicode Circled Digits) in the text represent the numeric Text Keys 1-9 and 0.
SearchForPeopleNTE(String, String) - Method in class sage.api.Database
Returns a list of all of the people in the database that match the passed in text, where the Unicode characters u2460-u2468 and u24EA (Unicode Circled Digits) in the text represent the numeric Text Keys 1-9 and 0.
SearchForPeopleRegex(Pattern) - Method in class sage.api.Database
Returns a list of all of the people in the database that match the passed in regular expression.
SearchForPeopleRegex(Pattern, String) - Method in class sage.api.Database
Returns a list of all of the people in the database that match the passed in regular expression.
SearchForTitles(String) - Method in class sage.api.Database
Returns a list of all of the titles in the database that include the search string in them.
SearchForTitles(String, String) - Method in class sage.api.Database
Returns a list of all of the titles in the database that include the search string in them.
SearchForTitlesNTE(String) - Method in class sage.api.Database
Returns a list of all of the titles in the database that match the passed in text, where the Unicode characters u2460-u2468 and u24EA (Unicode Circled Digits) in the text represent the numeric Text Keys 1-9 and 0.
SearchForTitlesNTE(String, String) - Method in class sage.api.Database
Returns a list of all of the titles in the database that match the passed in text, where the Unicode characters u2460-u2468 and u24EA (Unicode Circled Digits) in the text represent the numeric Text Keys 1-9 and 0.
SearchForTitlesRegex(Pattern) - Method in class sage.api.Database
Returns a list of all of the titles in the database that match the passed in regular expression.
SearchForTitlesRegex(Pattern, String) - Method in class sage.api.Database
Returns a list of all of the titles in the database that match the passed in regular expression.
SearchSelectedExactFields(String, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean) - Method in class sage.api.Database
Searches the specified fields of all the Airings in the database for the specified search string.
SearchSelectedExactFields(String, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, String) - Method in class sage.api.Database
Searches the specified fields of all the Airings in the database for the specified search string.
SearchSelectedFields(String, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean) - Method in class sage.api.Database
Searches the specified fields of all the Airings in the database for the specified search string.
SearchSelectedFields(String, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, String) - Method in class sage.api.Database
Searches the specified fields of all the Airings in the database for the specified search string.
SearchSelectedFieldsNTE(String, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean) - Method in class sage.api.Database
Searches the specified fields of all the Airings in the database and tries to match them against the passed in text, where the Unicode characters u2460-u2468 and u24EA (Unicode Circled Digits) in the text represent the numeric Text Keys 1-9 and 0.
SearchSelectedFieldsNTE(String, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, String) - Method in class sage.api.Database
Searches the specified fields of all the Airings in the database and tries to match them against the passed in text where the Unicode characters u2460-u2468 and u24EA (Unicode Circled Digits) in the text represent the numeric Text Keys 1-9 and 0.
SearchSelectedFieldsRegex(Pattern, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean) - Method in class sage.api.Database
Searches the specified fields of all the Airings in the database and tries to match them against the passed in regular expression.
SearchSelectedFieldsRegex(Pattern, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, String) - Method in class sage.api.Database
Searches the specified fields of all the Airings in the database and tries to match them against the passed in regular expression.
Security - Class in sage.api
Calls for dealing with permission based access to various capabilities in the SageTV platform and UI.
Security() - Constructor for class sage.api.Security
 
Seek(long) - Method in class sage.api.MediaPlayerAPI
Performs a time seek in the MediaPlayer to the specified time.
SendEventToUIComponent(Object, String, int) - Method in class sage.api.Global
Sends an event to a specific UI component for processing.
SendNetworkCommand(String, int, Object) - Method in class sage.api.Utility
Opens a TCP/IP socket connection to the specified hostname on the specified port and then sends the specified command.
SEQ_ELEMENT_TAG - Static variable in class sage.media.rss.RSSHandler
 
SEQ_TAG - Static variable in class sage.media.rss.RSSHandler
 
SeriesInfoAPI - Class in sage.api
 
SeriesInfoAPI() - Constructor for class sage.api.SeriesInfoAPI
 
ServerRestart() - Method in class sage.api.Utility
Restarts the server instance of SageTV.
setAboutAttribute(String) - Method in class sage.media.rss.RSSObject
Set about attribute of the element (if have)
SetAcceleratedDrawingEnabled(boolean) - Method in class sage.api.Configuration
Specifies whether or not 3D acceleration should be enabled for the rendering engine.
SetActiveSecurityProfile(String) - Method in class sage.api.Security
Sets the name of the current security profile for the UI client making the API call.
SetAdvancedDeinterlacingEnabled(boolean) - Method in class sage.api.Configuration
Allows enabling/disabling of advanced deinterlacing support.
SetAllChildrenChecked(MediaNode, boolean) - Method in class sage.api.MediaNodeAPI
Sets a flag on all the children of this MediaNode to indicate they are in the checked state.
SetAllowPlaceshifterLoginCaching(boolean) - Method in class sage.api.Configuration
Sets whether or not placeshifter connections should be allowed to cache their login information.
SetAnalogVideoFormat(String) - Method in class sage.api.Configuration
Sets the analog video format that should be used for capture and playback.
SetAspectRatioMode(String) - Method in class sage.api.Configuration
Sets the aspect ratio mode that should currently be used.
SetAudioDecoderFilter(String) - Method in class sage.api.Configuration
Sets the name of the DirectShow audio decoder filter that's used for MPEG2 playback (Windows only)
SetAudioDelay(int) - Method in class sage.api.Configuration
Sets the audio delay in milliseconds to apply when playing back MPEG2 files (Windows only)
SetAudioOutput(String) - Method in class sage.api.Configuration
Sets the current audio output.
SetAudioRenderFilter(String) - Method in class sage.api.Configuration
Sets the name of the DirectShow audio renderer filter that's used for playback except DVDs (Windows only)
setAuthor(String) - Method in class sage.media.rss.RSSItem
Set the item's author
SetAutodialForInternet(boolean) - Method in class sage.api.Configuration
Sets whether or not SageTV should autodial before accessing the Internet
SetButtonDelayForInfraredTuningPlugin(String, int, String, int) - Method in class sage.api.Configuration
Sets the minimum delay in milliseconds that is required between sending consecutive commands using the specified 'Remote Control'.
SetCaptureBrightness(String, int) - Method in class sage.api.CaptureDeviceInputAPI
Sets the brightness for capture on this CaptureDeviceInput.
SetCaptureContrast(String, int) - Method in class sage.api.CaptureDeviceInputAPI
Sets the contrast for capture on this CaptureDeviceInput.
SetCaptureDeviceAudioSource(String, String) - Method in class sage.api.CaptureDeviceAPI
Sets the audio capture source for a corresponding CaptureDevice
SetCaptureDeviceDefaultQuality(String, String) - Method in class sage.api.CaptureDeviceAPI
Sets the default recording quality for a CaptureDevice
SetCaptureDeviceDTVStandard(String, String) - Method in class sage.api.CaptureDeviceAPI
Sets the TV standard to use for a capture device for devices that support multiple digital TV standards.
SetCaptureDeviceMerit(String, int) - Method in class sage.api.CaptureDeviceAPI
Sets the encoder merit for a CaptureDevice.
SetCaptureHue(String, int) - Method in class sage.api.CaptureDeviceInputAPI
Sets the hue for capture on this CaptureDeviceInput.
SetCaptureSaturation(String, int) - Method in class sage.api.CaptureDeviceInputAPI
Sets the saturation for capture on this CaptureDeviceInput.
SetCaptureSharpness(String, int) - Method in class sage.api.CaptureDeviceInputAPI
Sets the sharpness for capture on this CaptureDeviceInput.
SetChannelMappingForLineup(Channel, String, String) - Method in class sage.api.ChannelAPI
Maps a channel on a lineup to a new channel number.
SetChannelMappingsForLineup(Channel, String, String[]) - Method in class sage.api.ChannelAPI
Maps a channel on a lineup to a new channel number(s).
SetChannelViewabilityForChannelNumberOnLineup(Channel, String, String, boolean) - Method in class sage.api.ChannelAPI
Sets whether or not the specified Channel is viewable on the specified number on the specified Lineup
SetChannelViewabilityForChannelOnLineup(Channel, String, boolean) - Method in class sage.api.ChannelAPI
Sets whether or not the specified Channel is viewable on the specified Lineup.
setCharacter(int) - Method in class sage.media.rss.CharacterReference
Set the character.
setComments(String) - Method in class sage.media.rss.RSSItem
Set the item's comment
SetConfirmCommandForInfraredTuningPlugin(String, int, String, String) - Method in class sage.api.Configuration
Sets the command that is to be sent as the last command to complete a channel change sequence.
setContentEncoded(String) - Method in class sage.media.rss.RSSItem
 
setCopyright(String) - Method in class sage.media.rss.RSSChannel
Set channel's copyright
SetCoreAnimationsEnabled(boolean) - Method in class sage.api.Utility
Sets whether or not animation support is enabled (either layered or Effect based animations; depending upon the STV configuration)
SetCountry(String) - Method in class sage.api.Configuration
Sets the country that the user is in.
SetCurrentlyAiringProgramsStartLive(boolean) - Method in class sage.api.Configuration
Sets whether or not when playing back a program that is currently airing whether we should start from live TV or not
setDate(String) - Method in class sage.media.rss.RSSItem
Set the date of the item
setDcContributor(String) - Method in class sage.media.rss.RSSDoublinCoreModule
Set the Contributor
setDcCoverage(String) - Method in class sage.media.rss.RSSDoublinCoreModule
Set coverage
setDcCreator(String) - Method in class sage.media.rss.RSSDoublinCoreModule
Set the creator
setDcDate(String) - Method in class sage.media.rss.RSSDoublinCoreModule
Set the date
setDcDescription(String) - Method in class sage.media.rss.RSSDoublinCoreModule
Set the description
setDcFormat(String) - Method in class sage.media.rss.RSSDoublinCoreModule
Set the format
setDcIdentifier(String) - Method in class sage.media.rss.RSSDoublinCoreModule
Set the identifier
setDcLanguage(String) - Method in class sage.media.rss.RSSDoublinCoreModule
Set the language
setDcPublisher(String) - Method in class sage.media.rss.RSSDoublinCoreModule
Set the publiscer
setDcRelation(String) - Method in class sage.media.rss.RSSDoublinCoreModule
Set declaration
setDcRights(String) - Method in class sage.media.rss.RSSDoublinCoreModule
Set copy rights
setDcSource(String) - Method in class sage.media.rss.RSSDoublinCoreModule
Set the source
setDcSubject(String) - Method in class sage.media.rss.RSSDoublinCoreModule
Set subject
setDcTitle(String) - Method in class sage.media.rss.RSSDoublinCoreModule
Set the title
setDcType(String) - Method in class sage.media.rss.RSSDoublinCoreModule
Set the type
SetDefaultAudioLanguage(String) - Method in class sage.api.Configuration
Sets the name of the preferred default language when selecting which audio stream to playback.
SetDefaultRecordingQuality(String) - Method in class sage.api.Configuration
Sets the default quality that is used to record television
SetDefaultSecurityProfile(String) - Method in class sage.api.Security
Sets the name of the default security profile to use when a new client connects that does not have an associated security profile.
SetDefaultSubpicLanguage(String) - Method in class sage.api.Configuration
Sets the name of the preferred default language when selecting which subpicture stream to playback.
SetDeleteAfterAutomaticConversion(Favorite, boolean) - Method in class sage.api.FavoriteAPI
Sets whether or not SageTV should delete the original file after doing an automatic conversion for this Favorite
setDescription(String) - Method in class sage.media.rss.RSSObject
Set the descriprion of the element
SetDisplayAspectRatio(float) - Method in class sage.api.Configuration
Sets the aspect ratio of the current display device
SetDisplayResolution(String) - Method in class sage.api.Global
Sets the current output display resolution.
setDocs(String) - Method in class sage.media.rss.RSSChannel
Set the documentator
SetDontAutodelete(Favorite, boolean) - Method in class sage.api.FavoriteAPI
Sets whether or not SageTV is allowed to automatically delete recordings of this Favorite when it needs more disk space.
SetDontLike(Airing) - Method in class sage.api.AiringAPI
Called to indicate that the content in this Airing is "Not Liked" by the user
SetDscalerDoubleRefresh(boolean) - Method in class sage.api.Configuration
Sets whether or not DScaler should double the refresh rate.
SetDscalerEnabled(boolean) - Method in class sage.api.Configuration
Sets whether or not the DScaler deinterlacing filter should be used (Windows only)
SetDscalerMode(String) - Method in class sage.api.Configuration
Sets the mode that DScaler should be configured to run in when it is used (Windows only)
SetDscalerOddFieldFirst(boolean) - Method in class sage.api.Configuration
Sets if DScaler should display the odd field first (fields are even or odd)
SetDscalerPlugin(String) - Method in class sage.api.Configuration
Sets the plugin that should be used by DScaler.
setDuration(long) - Method in class sage.media.rss.RSSItem
 
setDuration(String) - Method in class sage.media.rss.RSSMediaContent
 
SetDVBCRegion(String) - Method in class sage.api.Configuration
Sets the the provider within the current country that the user has for DVBC reception.
SetDVBSRegion(String) - Method in class sage.api.Configuration
Sets the the provider within the current country that the user has for DVBS reception.
SetDVBTRegion(String) - Method in class sage.api.Configuration
Sets the the region within the current country that the user is in.
SetDVDAudioDecoderFilter(String) - Method in class sage.api.Configuration
Sets the name of the DirectShow audio decoder filter that's used for DVD playback (Windows only)
SetDVDAudioRenderFilter(String) - Method in class sage.api.Configuration
Sets the name of the DirectShow audio renderer filter that's used for DVD playback (Windows only)
SetDVDDXVADeinterlaceMode(String) - Method in class sage.api.Configuration
Sets the preferred DXVA Deinterlacing configuration setting (Windows only).
SetDVDDXVAMpegMode(String) - Method in class sage.api.Configuration
Sets the preferred DXVA MPEG Mode configuration setting (Windows only).
SetDVDVideoDecoderFilter(String) - Method in class sage.api.Configuration
Sets the name of the DirectShow video decoder filter that's used for DVD playback (Windows only)
SetDVDVideoRenderFilter(String) - Method in class sage.api.Configuration
Sets the video renderer filter that should be used for DVD playback.
SetDXVADeinterlaceMode(String) - Method in class sage.api.Configuration
Sets the preferred DXVA Deinterlacing configuration setting (Windows only).
SetDXVAMpegMode(String) - Method in class sage.api.Configuration
Sets the preferred DXVA MPEG Mode configuration setting (Windows only).
SetElement(Object, int, Object) - Method in class sage.api.Utility
Sets the element at the specified index in this data; works for arrays and java.util.List implementations (i.e.
SetEmbeddedPanelBounds(float, float, float, float) - Method in class sage.api.Global
Sets the bounding region to be used for the embedded panel.
setEnclosure(RSSEnclosure) - Method in class sage.media.rss.RSSItem
 
setEnd(int) - Method in class sage.media.rss.CharacterReferenceEx
Set the supposed ending point.
setExpression(String) - Method in class sage.media.rss.RSSMediaContent
 
SetFavoriteAutomaticConversionDestination(Favorite, File) - Method in class sage.api.FavoriteAPI
Sets the directory that automatic conversions of this favorite should be saved to.
SetFavoriteAutomaticConversionFormat(Favorite, String) - Method in class sage.api.FavoriteAPI
Sets the name of the format to transcode this Favorite to after a recording has been completed.
SetFavoriteCategories(Favorite, String, String) - Method in class sage.api.FavoriteAPI
Sets the category and optionally the subcategory that an Airing must match to be included in this Favorite.
SetFavoriteChannel(Favorite, Object) - Method in class sage.api.FavoriteAPI
Sets the channel name (call sign) that an Airing must be on to be included in this Favorite.
SetFavoriteEnabled(Favorite, boolean) - Method in class sage.api.FavoriteAPI
Sets whether or not SageTV will use this favorite when scheduling recordings
SetFavoriteKeyword(Favorite, String) - Method in class sage.api.FavoriteAPI
Sets the keyword string that an Airing must match to be included in this Favorite.
SetFavoriteNetwork(Favorite, String) - Method in class sage.api.FavoriteAPI
Sets the network name that an Airing must be on to be included in this Favorite.
SetFavoriteParentalRating(Favorite, String) - Method in class sage.api.FavoriteAPI
Sets the parental rating that an Airing must match to be included in this Favorite.
SetFavoritePerson(Favorite, Person, String) - Method in class sage.api.FavoriteAPI
Sets a person (and optionally the role the person must appear in) that must be in an Airing for it to be included in this Favorite
SetFavoriteProperty(Favorite, String, String) - Method in class sage.api.FavoriteAPI
Sets a property for this Favorite.
SetFavoriteQuality(Favorite, String) - Method in class sage.api.FavoriteAPI
Sets the name of the recording quality that should be used when recording this Favorite.
SetFavoriteRated(Favorite, String) - Method in class sage.api.FavoriteAPI
Sets the rating that an Airing must match to be included in this Favorite.
SetFavoriteTimeslot(Favorite, String) - Method in class sage.api.FavoriteAPI
Sets the timeslot that an Airing must be in to be included in this Favorite.
SetFavoriteTitle(Favorite, String) - Method in class sage.api.FavoriteAPI
Sets the title that an Airing must match to be included in this Favorite.
SetFavoriteYear(Favorite, String) - Method in class sage.api.FavoriteAPI
Sets the year that an Airing must match to be included in this Favorite.
SetFocusForVariable(String, Object) - Method in class sage.api.Global
Searches all UI elements in the current menu until it finds one that has a variable with the specified name matching the specified value.
SetFocusToUIComponent(Object) - Method in class sage.api.Global
Sets focus in the specified UI component.
SetFullScreen(boolean) - Method in class sage.api.Global
Sets SageTV to be in full or non-full screen mode
setGenerator(String) - Method in class sage.media.rss.RSSChannel
Set the gerator
setHandler(DefaultHandler) - Method in class sage.media.rss.RSSParser
Set the event handler
setHeight(String) - Method in class sage.media.rss.RSSImage
Set the image's height
setHeight(String) - Method in class sage.media.rss.RSSMediaContent
 
SetInactivityTimeout(int) - Method in class sage.api.Configuration
Sets the inactivity timeout in milliseconds.
SetInfraredReceiverPort(String) - Method in class sage.api.Configuration
Sets the name of the port that the infrared receiver is connected to.
SetInfraredTunerRemoteName(String, String) - Method in class sage.api.CaptureDeviceInputAPI
Sets the name of the device that is passed to the IR Tuner plugin for tuning control.
SetInfraredTuningPluginAndPort(String, String, int) - Method in class sage.api.CaptureDeviceInputAPI
Sets the name and port number for the tuning plugin for a CaptureDeviceInput
setInputName(String) - Method in class sage.media.rss.RSSTextInput
Set the input type name
SetIntelligentRecordingDisabled(boolean) - Method in class sage.api.Configuration
Sets whether or not 'Intelligent Recording' should be disabled.
SetKeepAtMost(Favorite, int) - Method in class sage.api.FavoriteAPI
Sets the maximum number of recordings that match this Favorite that should be kept on disk.
setKernel(String) - Method in class sage.media.rss.CharacterReference
Set this CharacterReference's kernel.
setLanguage(String) - Method in class sage.media.rss.RSSChannel
Set the language of channel
setLastBuildDate(String) - Method in class sage.media.rss.RSSChannel
Set the lastBuildDate
setLength(String) - Method in class sage.media.rss.RSSEnclosure
 
setLink(String) - Method in class sage.media.rss.RSSObject
Set the link of the resource
SetMajorMinorDTVChannelTuningEnabled(boolean) - Method in class sage.api.Configuration
Deprecated.  
setManagingEditor(String) - Method in class sage.media.rss.RSSChannel
Set the managingEditor
SetManualRecordProperty(Airing, String, String) - Method in class sage.api.AiringAPI
Sets a property for a specified ManualRecord.
SetMaxChannelDigitsForInfraredTuningPlugin(String, int, String, int) - Method in class sage.api.Configuration
Sets the maximum number of digits that are needed to tune a channel on the device that corresponds to the specified 'Remote Control'.
SetMediaFileAiring(MediaFile, Airing) - Method in class sage.api.MediaFileAPI
Sets a link between a MediaFile object which represents a file(s) on disk and an Airing object which represents metadata about the content.
SetMediaFileMetadata(MediaFile, String, String) - Method in class sage.api.MediaFileAPI
Sets the corresponding metadata property in the MediaFile's format.
SetMediaFileShow(MediaFile, Show) - Method in class sage.api.MediaFileAPI
Sets a link between a MediaFile object which represents a file(s) on disk and a Show object which represents metadata about the content.
setMediaGroup(RSSMediaGroup) - Method in class sage.media.rss.RSSItem
 
SetMediaPlayerClosedCaptionState(String) - Method in class sage.api.MediaPlayerAPI
Sets the current state that MediaPlayer close captioning should use.
setMedium(String) - Method in class sage.media.rss.RSSMediaContent
 
SetMute(boolean) - Method in class sage.api.MediaPlayerAPI
Sets the mute state for the MediaPlayer.
SetMuteOnAlternateSpeedPlayback(boolean) - Method in class sage.api.Configuration
Sets whether or not SageTV should mute the sound when media is played back at a speed other than x1
SetName(Playlist, String) - Method in class sage.api.PlaylistAPI
Sets the name for this Playlist
SetNameForIRCode(long, String) - Method in class sage.api.Configuration
Sets the name for a given IR code.
SetNativeOutputResolutionEnabled(boolean) - Method in class sage.api.Configuration
Sets whether or not this device should try to match its output resolution to the media format's resolution
SetNodeChecked(MediaNode, boolean) - Method in class sage.api.MediaNodeAPI
Sets a flag on this MediaNode to indicate it is in the checked state.
SetNodeFilter(MediaNode, String, boolean) - Method in class sage.api.MediaNodeAPI
Sets the filtering techniques used by the specified MediaNode hierarchy.
SetNodeSort(MediaNode, String, boolean) - Method in class sage.api.MediaNodeAPI
Sets the sorting technique used by the specified MediaNode hierarchy.
SetOverscanOffsetX(int) - Method in class sage.api.Configuration
Sets the horizontal offset in pixels that should be applied to the UI to account for overscan.
SetOverscanOffsetY(int) - Method in class sage.api.Configuration
Sets the vertical offset in pixels that should be applied to the UI to account for overscan.
SetOverscanScaleHeight(float) - Method in class sage.api.Configuration
Sets the vertical scale factor that should be applied to the UI to account for overscan.
SetOverscanScaleWidth(float) - Method in class sage.api.Configuration
Sets the horizontal scale factor that should be applied to the UI to account for overscan.
SetParentalControlEnabled(boolean) - Method in class sage.api.Configuration
Sets whether or not parental controls are enabled for the system
SetParentalLockCode(String) - Method in class sage.api.Configuration
Sets the code that is to be used in order to unlock the parental controls.
SetPermission(String, String, boolean) - Method in class sage.api.Security
Sets whether or not a permission is allowed under a specific security profile.
SetPhysicalChannelMappingForLineup(Channel, String, String) - Method in class sage.api.ChannelAPI
Maps a Channel on a lineup to a new physical channel number.
SetPlaybackRate(float) - Method in class sage.api.MediaPlayerAPI
Sets the playback rate of the MediaPlayer to the specified value.
setPlayerURL(String) - Method in class sage.media.rss.RSSMediaGroup
 
SetPlaylistProperty(Playlist, String, String) - Method in class sage.api.PlaylistAPI
Sets a property for this Playlist.
SetPluginConfigValue(Plugin, String, String) - Method in class sage.api.PluginAPI
Sets the value for the specified configuration setting for the specified Plugin object.
SetPluginConfigValues(Plugin, String, String[]) - Method in class sage.api.PluginAPI
Sets the values for the specified configuration setting for the specified Plugin object.
SetPrefixCommandForInfraredTuningPlugin(String, int, String, String) - Method in class sage.api.Configuration
Sets the command that is to be sent before a channel change sequence is started.
SetProperty(String, String) - Method in class sage.api.Configuration
Sets the property with the specified name to the specified value.
SetProvideoPentium4FixEnabled(boolean) - Method in class sage.api.Configuration
Deprecated.  
setPubDate(String) - Method in class sage.media.rss.RSSObject
The publication date for the content in the channel or in the items
SetPVR350OSDEnabled(boolean) - Method in class sage.api.Configuration
Sets whether or not the user interface (OSD) should be displayed on the TV output of a Hauppauge WinTV PVR-350 (Windows only)
SetPVR350TVOutputEnabled(boolean) - Method in class sage.api.Configuration
Sets whether or not the TV output on a Hauppauge WinTV PVR-350 should be enabled (Windows only)
SetRatingUnderParentalControl(String, boolean) - Method in class sage.api.Configuration
Sets whether or not a given rating should be restricted under parental control
SetRecordingName(Airing, String) - Method in class sage.api.AiringAPI
Sets the name for this recording.
SetRecordingQuality(Airing, String) - Method in class sage.api.AiringAPI
Sets the recording quality for this Airing if it has been selected by the user as a manual record
SetRecordingTimes(Airing, long, long) - Method in class sage.api.AiringAPI
Modifies or creates a time-based recording that is associated with this Airing.
SetRemoteEventEncryptionEnabled(boolean) - Method in class sage.api.Global
This is used to enable/disable encryption on the event channel for the SageTV MiniClient.
setResource(String) - Method in class sage.media.rss.RSSSequenceElement
Set the sequence element resource
SetRFSignalIsCableTV(String, boolean) - Method in class sage.api.CaptureDeviceInputAPI
Sets whether or not this CaptureDeviceInput tunes for Antenna or Cable if it's a TV Tuner input
setRSSDoublinCoreModule(RSSDoublinCoreModule) - Method in class sage.media.rss.RSSObject
Set the doublin core information if exist
setRSSImage(RSSImage) - Method in class sage.media.rss.RSSChannel
Set a RSSImage object associated to the channel
setRSSTextInput(RSSTextInput) - Method in class sage.media.rss.RSSChannel
Set a RSSTextInput object to a channel
SetRunStatus(Favorite, boolean, boolean) - Method in class sage.api.FavoriteAPI
Sets whether first runs, reruns or both types of airings should be recorded for this Favorite.
SetSageTVServerEnabled(boolean) - Method in class sage.api.Configuration
Sets whether or not the SageTV server should be enabled.
SetScreenSaverOnSleepEnabled(boolean) - Method in class sage.api.Configuration
Sets whether or not SageTV should go to its screen saver when put to sleep.
SetScreenSaverTimeout(int) - Method in class sage.api.Configuration
Sets the screen saver timeout in milliseconds.
SetScrollPosition(float, float) - Method in class sage.api.Utility
Scrolls the closest pageable UI parent component (or sibling of a parent) to the specified position.
SetSequenceDelayForInfraredTuningPlugin(String, int, String, int) - Method in class sage.api.Configuration
Sets the minimum delay in milliseconds that is required between the completion of a sequence of commands that represent a channel change and the start of a new sequence of commands that represent a channel change
SetSeriesInfoProperty(SeriesInfo, String, String) - Method in class sage.api.SeriesInfoAPI
Sets a property for this SeriesInfo object.
SetServerProperty(String, String) - Method in class sage.api.Configuration
Sets the property with the specified name to the specified value.
SetSoftwareDecodingDisabled(boolean) - Method in class sage.api.Configuration
Sets if software decoding is disabled.
setStart(int) - Method in class sage.media.rss.CharacterReferenceEx
Set the starting point of the kernel.
SetStartPadding(Favorite, long) - Method in class sage.api.FavoriteAPI
Sets the amount of time any recording for this Favorite should start before the actual Airing begins.
SetStopPadding(Favorite, long) - Method in class sage.api.FavoriteAPI
Sets the amount of time any recording for this Favorite should stop after the actual Airing ends.
SetSubtitleDelay(long) - Method in class sage.api.MediaPlayerAPI
Sets the delay in milliseconds that is applied to external subtitle files when they are used during playback (can be positive or negative)
SetSyncSystemClockWithServerEnabled(boolean) - Method in class sage.api.Configuration
Sets if SageTV should synchronize the system clock with the server.
setSyndicationModule(RSSSyndicationModule) - Method in class sage.media.rss.RSSChannel
Set syndication module for channel's
setSyUpdateBase(String) - Method in class sage.media.rss.RSSSyndicationModule
The date of updateBase
setSyUpdateFrequency(String) - Method in class sage.media.rss.RSSSyndicationModule
Set the update frequency
setSyUpdatePeriod(String) - Method in class sage.media.rss.RSSSyndicationModule
Set the feed update period
setThumbHeight(String) - Method in class sage.media.rss.RSSMediaGroup
 
setThumbURL(String) - Method in class sage.media.rss.RSSMediaGroup
 
setThumbWidth(String) - Method in class sage.media.rss.RSSMediaGroup
 
SetTimeZone(String) - Method in class sage.api.Configuration
Sets the name of the time zone that the application should use.
setTitle(String) - Method in class sage.media.rss.RSSObject
Set the element title
setTTL(String) - Method in class sage.media.rss.RSSChannel
Set the TTL time
setType(String) - Method in class sage.media.rss.RSSEnclosure
 
setType(String) - Method in class sage.media.rss.RSSMediaContent
 
SetUILanguage(String) - Method in class sage.api.Configuration
Sets the language that the user interface should be displayed in.
setUrl(String) - Method in class sage.media.rss.RSSEnclosure
 
setUrl(String) - Method in class sage.media.rss.RSSImage
Set url of the image
setUrl(String) - Method in class sage.media.rss.RSSMediaContent
 
SetUserRecordData(UserRecord, String, String) - Method in class sage.api.UserRecordAPI
Sets the Value for the specified Name that's stored in the given UserRecord object
setValidate(boolean) - Method in class sage.media.rss.RSSParser
set true if parse have to validate the document defoult is false
SetVariableForUIComponent(Object, String, Object) - Method in class sage.api.Global
Sets the variable with the specified name in the context of the passed in UIComponent.
SetVideoAlwaysOnTop(boolean) - Method in class sage.api.MediaPlayerAPI
Sets the video portion of SageTV to always be on top of other windows in the desktop (Windows only).
SetVideoBackgroundColor(Color) - Method in class sage.api.Configuration
Sets the color that should be used for the video background.
SetVideoDecoderFilter(String) - Method in class sage.api.Configuration
Sets the name of the DirectShow video decoder filter that's used for MPEG2 playback (Windows only)
SetVideoOffsetX(String, int) - Method in class sage.api.Configuration
Sets of the offset in pixels that should be applied horizontally to the video.
SetVideoOffsetY(String, int) - Method in class sage.api.Configuration
Sets of the offset in pixels that should be applied vertically to the video.
SetVideoOrbitingDuration(long) - Method in class sage.api.Configuration
Sets the video orbiting duration in milliseconds.
SetVideoRendererToDefault() - Method in class sage.api.Configuration
Sets the video renderer to use the default renderer (Windows Only).
SetVideoRendererToEVR() - Method in class sage.api.Configuration
Sets the video renderer to use the Enhanced Video Renderer (Windows Only).
SetVideoRendererToOverlay() - Method in class sage.api.Configuration
Sets the video renderer to use the video Overlay surface (Windows Only).
SetVideoRendererToVMR9() - Method in class sage.api.Configuration
Sets the video renderer to use the Video Mixing Renderer 9 (Windows Only).
SetVideoZoomX(String, float) - Method in class sage.api.Configuration
Sets the horizontal scale factor for the video for the specified aspect ratio mode.
SetVideoZoomY(String, float) - Method in class sage.api.Configuration
Sets the vertical scale factor for the video for the specified aspect ratio mode.
SetVolume(float) - Method in class sage.api.MediaPlayerAPI
Explicitly sets the volume in the MediaPlayer to be the specified amount.
SetWatched(Airing) - Method in class sage.api.AiringAPI
Sets the watched flag for this Airing to true as if the user watched the show from start to finish
SetWatchedTimes(Airing, long, long) - Method in class sage.api.AiringAPI
Updates the Watched information for this airing.
setWebMaster(String) - Method in class sage.media.rss.RSSChannel
Set the webMaster
SetWidgetName(Widget, String) - Method in class sage.api.WidgetAPI
Sets the name for a Widget
SetWidgetProperty(Widget, String, String) - Method in class sage.api.WidgetAPI
Sets a property in a Widget to a specified value.
setWidth(String) - Method in class sage.media.rss.RSSImage
Set the image's width
setWidth(String) - Method in class sage.media.rss.RSSMediaContent
 
SetWindowsRegistryDWORDValue(String, String, String, int) - Method in class sage.api.Utility
Sets a DWORD value in the Windows registry for the specified root, key and name(Windows only) The name will be created if it doesn't already exist.
SetWindowsRegistryStringValue(String, String, String, String) - Method in class sage.api.Utility
Sets a string value in the Windows registry for the specified root, key and name(Windows only) The name will be created if it doesn't already exist.
setXmlResource(String) - Method in class sage.media.rss.RSSParser
Set rss resource by local file name
setXmlResource(URL) - Method in class sage.media.rss.RSSParser
Set rss resource by URL
ShowAPI - Class in sage.api
Show represents detailed information about content.
ShowAPI() - Constructor for class sage.api.ShowAPI
 
Size(Object) - Method in class sage.api.Utility
Returns the size of the specified data.
SkipBackwards() - Method in class sage.api.MediaPlayerAPI
Performs a time seek backwards in the MediaPlayer.
SkipBackwards2() - Method in class sage.api.MediaPlayerAPI
Performs a time seek backwards in the MediaPlayer.
SKIPD_TAG - Static variable in class sage.media.rss.RSSHandler
 
SkipForward() - Method in class sage.api.MediaPlayerAPI
Performs a time seek forward in the MediaPlayer.
SkipForward2() - Method in class sage.api.MediaPlayerAPI
Performs a time seek forward in the MediaPlayer.
SKIPH_TAG - Static variable in class sage.media.rss.RSSHandler
 
Sort(Object, boolean, Object) - Method in class sage.api.Database
Sorts a list of data according to the specified sorting technique.
SortLexical(Object, boolean, String) - Method in class sage.api.Database
Sorts a list of data based on the result of calling the "SortByMethod" on each item and using toString on the return value of that method.
StartBackgroundFileDownload(String, String, File, Properties) - Method in class sage.api.Global
Instructs the file transfer engine to download the specified file from the server to the local destination file.
StartCircularFileDownload(String, String, File) - Method in class sage.api.Global
Instructs the file transfer engine to download the specified file from the server to the local destination file.
StartCircularFileDownload(String, String, File, Properties) - Method in class sage.api.Global
Instructs the file transfer engine to download the specified file from the server to the local destination file.
startElement(String, String, String, Attributes) - Method in class sage.media.rss.RSSHandler
Receive notification of the start of an element.
StartFileCopy(String, String, File) - Method in class sage.api.Global
Instructs the file transfer engine to copy the specified file(s) from the source directory to the destination directory.
StartFileDownload(String, String, File) - Method in class sage.api.Global
Instructs the file transfer engine to download the specified file from the server to the local destination file.
StartFileDownload(String, String, File, Properties) - Method in class sage.api.Global
Instructs the file transfer engine to download the specified file from the server to the local destination file.
StartPlaylist(Playlist) - Method in class sage.api.MediaPlayerAPI
Starts playback of the specified Playlist.
StartPlaylistAt(Playlist, int) - Method in class sage.api.MediaPlayerAPI
Starts playback of the specified Playlist.
StringEndsWith(String, String) - Method in class sage.api.Utility
Returns true if the first string ends with the second, uses java.lang.String.endsWith
StringIndexOf(String, String) - Method in class sage.api.Utility
Returns the index of the second string within the first string, -1 if it is not found.
StringIndexOfNTE(String, String) - Method in class sage.api.Utility
Returns the index of MatchStringNTE string within FullString, -1 if it is not found.
Search is case-insentive
The MatchStringNTE may contain the Unicode characters u2460-u2468 and u24EA (Unicode Circled Digits) representing numeric Text Keys 1-9 and 0.
StringLastIndexOf(String, String) - Method in class sage.api.Utility
Returns the last index of the second string within the first string, -1 if it is not found.
StringStartsWith(String, String) - Method in class sage.api.Utility
Returns true if the first string starts with the second, uses java.lang.String.startsWith
StringStartsWithNTE(String, String) - Method in class sage.api.Utility
Returns true if the Full String starts with characters matching MatchStringNTE
Search is case-insentive
The MatchStringNTE may contain the Unicode characters u2460-u2468 and u24EA (Unicode Circled Digits) representing numeric Text Keys 1-9 and 0.
StripLeadingArticles(String) - Method in class sage.api.Database
Strips any leading 'a, an or the' prefixes from the passed in string and returns the resulting string.
Substring(String, int, int) - Method in class sage.api.Utility
Returns the substring from a specified string.
SubstringBegin(String, int) - Method in class sage.api.Utility
Returns the substring from a specified string.
SwitchEmbeddedModeTo(String) - Method in class sage.api.Global
Executes a predefined application in the context of an embedded client.
SY_BASE_TAG - Static variable in class sage.media.rss.RSSHandler
 
SY_FREQ_TAG - Static variable in class sage.media.rss.RSSHandler
 
SY_PERIOD_TAG - Static variable in class sage.media.rss.RSSHandler
 
SystemMessageAPI - Class in sage.api
 
SystemMessageAPI() - Constructor for class sage.api.SystemMessageAPI
 

T

tagIsEqual(String, String) - Static method in class sage.media.rss.RSSHandler
Check against non-casesentive tag name
TestPlaceshifterConnectivity(String) - Method in class sage.api.Utility
Connects to the SageTV Locator server and submits the specified Locator ID for a 'ping'.
TEXTINPUT_TAG - Static variable in class sage.media.rss.RSSHandler
 
Time() - Method in class sage.api.Utility
Returns the current time; see java.lang.System.currentTimeMillis() for the explanation of the units.
title - Variable in class sage.media.rss.RSSObject
 
TITLE_TAG - Static variable in class sage.media.rss.RSSHandler
 
toDebugString() - Method in class sage.media.rss.RSSChannel
Useful for debug
toDebugString() - Method in class sage.media.rss.RSSDoublinCoreModule
A poor informational string
toDebugString() - Method in class sage.media.rss.RSSEnclosure
 
toDebugString() - Method in class sage.media.rss.RSSImage
Useful for debug
toDebugString() - Method in class sage.media.rss.RSSItem
Useful for debug
toDebugString() - Method in class sage.media.rss.RSSMediaGroup
 
toDebugString() - Method in class sage.media.rss.RSSObject
Each class have to implement this information method
toDebugString() - Method in class sage.media.rss.RSSSequence
Useful for debug
toDebugString() - Method in class sage.media.rss.RSSSequenceElement
For debug
toDebugString() - Method in class sage.media.rss.RSSSyndicationModule
Information string
toDebugString() - Method in class sage.media.rss.RSSTextInput
Info
toHTML() - Method in class sage.media.rss.RSSImage
Return a html img tag with link associated
toHTML() - Method in class sage.media.rss.RSSTextInput
A basic rendering in html
toString() - Method in class sage.media.rss.CharacterReference
Visualize this character reference as a string.
TranscodeAPI - Class in sage.api
 
TranscodeAPI() - Constructor for class sage.api.TranscodeAPI
 
Translate - Class in sage.media.rss
Translate numeric character references and character entity references to unicode characters.
TransmitCommandUsingInfraredTuningPlugin(String, int, String, String, int) - Method in class sage.api.Global
Causes SageTV to instruct the specified tuning plugin to send a command
TTL_TAG - Static variable in class sage.media.rss.RSSHandler
 
TVEditorialAPI - Class in sage.api
 
TVEditorialAPI() - Constructor for class sage.api.TVEditorialAPI
 

U

UninstallPlugin(Plugin) - Method in class sage.api.PluginAPI
Uninstalls the specified Plugin.
UnlinkIRCodeFromSageCommands(long) - Method in class sage.api.Configuration
Unlinks an infrared code from any SageTV commands it is linked to
UnlinkKeystrokeFromSageCommands(String) - Method in class sage.api.Configuration
Unlinks a keystroke from any SageTV commands it is linked to
UnloadImage(String) - Method in class sage.api.Utility
Unloads the specified image resource from memory.
UpdateFavorite(Favorite, String, boolean, boolean, String, String, Person, String, String, String, String, String, String, String, String) - Method in class sage.api.FavoriteAPI
Updates all of the fields of a Favorite that can be used to match.
UpdateLocatorServer() - Method in class sage.api.Global
This API call can be used to tell SageTV to do an update with the Locator server right now.
URL_TAG - Static variable in class sage.media.rss.RSSHandler
 
UserRecordAPI - Class in sage.api
API for plugins and other utilities to be able to store arbitrary name-value pairs in the database under a keyed object system.
UserRecordAPI() - Constructor for class sage.api.UserRecordAPI
 
Utility - Class in sage.api
Contains miscellaneous methods useful for a variety of purposes
Utility() - Constructor for class sage.api.Utility
 

V

VolumeAdjust(float) - Method in class sage.api.MediaPlayerAPI
Adjusts the volume in the MediaPlayer be the specified amount.
VolumeDown() - Method in class sage.api.MediaPlayerAPI
Decreases the volume in the MediaPlayer.
VolumeUp() - Method in class sage.api.MediaPlayerAPI
Increases the volume in the MediaPlayer.

W

Wait(long) - Method in class sage.api.Utility
Causes the currently executing thread to sleep for the specified amount of time in milliseconds.
Watch(Object) - Method in class sage.api.MediaPlayerAPI
Instructs SageTV to playback the specified media content.
WatchLive(String, long) - Method in class sage.api.MediaPlayerAPI
Instructs SageTV to begin playback of content streamed from the specified CaptureDeviceInput.
WatchLive(String, long, String) - Method in class sage.api.MediaPlayerAPI
Instructs SageTV to begin playback of content streamed from the specified CaptureDeviceInput.
WatchLocalFile(File) - Method in class sage.api.MediaPlayerAPI
Instructs SageTV to playback the specified file path that's local to this client
WidgetAPI - Class in sage.api
Widget reflection API
WidgetAPI() - Constructor for class sage.api.WidgetAPI
 
WMASTER_TAG - Static variable in class sage.media.rss.RSSHandler
 

A B C D E F G H I K L M N P Q R S T U V W
SageTV Platform
V9.0

SageTV is a trademark or registered trademark of Google, Inc. in the US and other countries.
Copyright 2000-2015 The SageTV Authors. All Rights Reserved.