java.lang.Object
- sage.api.Configuration

public class Configuration
extends java.lang.Object

Configuration and properties for the whole system

Constructor Summary

Constructors
Constructor Description

Configuration()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`AddLibraryImportPath(java.lang.String NewPath)`	Adds a new file path to the list of paths that SageTV checks for library import files.
`void`	`AddMusicLibraryImportPath(java.lang.String NewPath)`	Adds a new file path to the list of paths that SageTV checks for library import files.
`void`	`AddPictureLibraryImportPath(java.lang.String NewPath)`	Adds a new file path to the list of paths that SageTV checks for library import files.
`java.lang.String`	`AddRemoteForInfraredTuningPlugin(java.lang.String PluginName, int PluginPortNumber, java.lang.String RemoteName)`	Creates a new 'Remote Control' with the specified name for the specified plugin.
`void`	`AddVideoDirectory(java.lang.String Directory, java.lang.String Rule, long Size)`	Adds a new directory to SageTV's list of directories that it can record video to.
`void`	`AddVideoLibraryImportPath(java.lang.String NewPath)`	Adds a new file path to the list of paths that SageTV checks for library import files.
`boolean`	`CanDoNativeOutputResolution()`	Returns true if this device can do native output resolutions (where output resolution matches the format of the media being played)
`void`	`ChangeVideoDirectory(java.io.File OldDirectory, java.io.File NewDirectory, java.lang.String NewRule, long NewSize)`	Changes the location of a given video directory, or modifies the diskspace rule or diskspace rule size for a video directory.
`java.util.Vector`	`GetAllTimeZones()`	Gets the list of all of the valid time zone names
`java.lang.String`	`GetAnalogVideoFormat()`	Gets the analog video format that should be used for capture and playback.
`java.lang.String`	`GetAspectRatioMode()`	Returns the localized name of the aspect ratio mode currently in use.
`java.lang.String[]`	`GetAspectRatioModes()`	Gets the list of localized names for the aspect ratio modes
`java.lang.String`	`GetAudioDecoderFilter()`	Gets the name of the DirectShow audio decoder filter that's used for MPEG2 playback (Windows only)
`java.lang.String[]`	`GetAudioDecoderFilters()`	Gets the list of the audio decoder filters that are available in the system for MPEG2 playback (Windows only)
`int`	`GetAudioDelay()`	Gets the audio delay in milliseconds to apply when playing back MPEG2 files (Windows only)
`java.lang.String`	`GetAudioOutput()`	Returns a string describing the currently selected audio output (empty string if this can't be configured)
`java.lang.String[]`	`GetAudioOutputOptions()`	Returns a list of the possible audio outputs.
`java.util.Vector`	`GetAudioRendererFilters()`	Gets the list of DirectShow audio renderer filters that are available on the system (Windows Only).
`java.lang.String`	`GetAudioRenderFilter()`	Gets the name of the DirectShow audio renderer filter that's used for all playback except DVDs (Windows only)
`boolean`	`GetAutodialForInternet()`	Returns true if SageTV should attempt to autodial before accessing the Internet
`java.lang.String[]`	`GetAvailableCountries()`	Gets the names of the countries that can be used in the `SetCountry()` call.
`java.lang.String[]`	`GetAvailableUILanguages()`	Gets the list of languages that are available to be used for the user interface.
`long`	`GetBitTimeForInfraredTuningPlugin(java.lang.String PluginName, int PluginPortNumber, java.lang.String RemoteName)`	Gets the 'bit time' detected by this plugin for the specified remote
`int`	`GetButtonDelayForInfraredTuningPlugin(java.lang.String PluginName, int PluginPortNumber, java.lang.String RemoteName)`	Gets the minimum delay in milliseconds that is required between sending consecutive commands using the specified 'Remote Control'.
`long`	`GetCarrierFrequencyForInfraredTuningPlugin(java.lang.String PluginName, int PluginPortNumber, java.lang.String RemoteName)`	Gets the carrier frequency detected by this plugin for the specified remote
`java.util.Vector`	`GetCommandsForInfraredTuningPlugin(java.lang.String PluginName, int PluginPortNumber, java.lang.String RemoteName)`	Gets the list of commands for the specified 'Remote Control' for the specified plugin
`java.lang.String`	`GetConfirmCommandForInfraredTuningPlugin(java.lang.String PluginName, int PluginPortNumber, java.lang.String RemoteName)`	Gets the command that is to be sent as the last command to complete a channel change sequence.
`java.lang.String`	`GetCountry()`	Gets the country that SageTV is configured for.
`boolean`	`GetCurrentlyAiringProgramsStartLive()`	Returns true if the system is configured to start any program that is currently airing from live, false otherwise
`java.lang.String`	`GetDefaultAudioLanguage()`	Gets the name of the preferred default language when selecting which audio stream to playback.
`java.lang.String`	`GetDefaultRecordingQuality()`	Gets the name of the default quality that is used to record television.
`java.lang.String`	`GetDefaultSubpicLanguage()`	Gets the name of the preferred default language when selecting which subpicture stream to playback.
`java.lang.String`	`GetDiskspaceRuleForVideoDirectory(java.io.File Directory)`	Returns the diskspace rule that SageTV should use when managing the disk space in a given directory.
`long`	`GetDiskspaceSizeForVideoDirectory(java.io.File Directory)`	Returns the size (in bytes) that should be applied to the specified directory for its configured diskspace rule
`float`	`GetDisplayAspectRatio()`	Returns the display aspect ratio that is set for the current display device being used
`java.lang.String`	`GetDscalerMode()`	Gets the mode that DScaler is currently configured to run in when it is used (Windows only)
`java.lang.String[]`	`GetDscalerModes()`	Gets the list of the available modes that DScaler can be run in
`java.lang.String`	`GetDscalerPlugin()`	Gets the plugin that DScaler is currently configured to use when it is in "Plugin" mode.
`java.lang.String[]`	`GetDscalerPlugins()`	Returns the list of plugins that are supported by DScaler.
`java.lang.String`	`GetDVBCRegion()`	Gets the the provider within the current country that the user has for DVB-C tuning purposes.
`java.lang.String[]`	`GetDVBCRegions()`	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.
`java.lang.String`	`GetDVBSRegion()`	Gets the the provider within the current country that the user has for DVB-S tuning purposes.
`java.lang.String[]`	`GetDVBSRegions()`	Gets the names of the providers for the configured country which are used for dividing it up into different areas for DVB-S reception.
`java.lang.String`	`GetDVBTRegion()`	Gets the the region within the current country that the user is in for DVB-T tuning purposes.
`java.lang.String[]`	`GetDVBTRegions()`	Gets the names of the regions for the configured country which are used for dividing it up into different areas for DVB-T reception.
`java.lang.String`	`GetDVDAudioDecoderFilter()`	Gets the name of the DirectShow audio decoder filter that's used for DVD playback (Windows only)
`java.lang.String`	`GetDVDAudioRenderFilter()`	Gets the name of the DirectShow audio renderer filter that's used for DVD playback (Windows only)
`java.lang.String`	`GetDVDDXVADeinterlaceMode()`	Gets the preferred DXVA Deinterlacing configuration setting (Windows only).
`java.lang.String`	`GetDVDDXVAMpegMode()`	Gets the preferred DXVA MPEG Mode configuration setting (Windows only).
`java.lang.String`	`GetDVDVideoDecoderFilter()`	Gets the name of the DirectShow video decoder filter that's used for DVD playback (Windows only)
`java.lang.String`	`GetDVDVideoRenderFilter()`	Gets the video renderer filter that should be used for DVD playback.
`java.lang.String`	`GetDXVADeinterlaceMode()`	Gets the preferred DXVA Deinterlacing configuration setting (Windows only).
`java.lang.String[]`	`GetDXVADeinterlaceModes()`	Gets the list of potential DXVA Deinterlacing Capabilities (Widows only)
`java.lang.String`	`GetDXVAMpegMode()`	Gets the preferred DXVA MPEG Mode configuration setting (Windows only).
`java.lang.String[]`	`GetDXVAMpegModes()`	Gets the list of available DXVA MPEG Modes.
`java.lang.String`	`GetHDMIAutodetectedConnector()`	Returns a string describing the type of connection autodetected on HDMI (currently only used on media extenders)
`int`	`GetInactivityTimeout()`	Gets the inactivity timeout in milliseconds.
`java.lang.String`	`GetInfraredReceiverPort()`	Gets the name of the port that the infrared receiver is connected to.
`java.lang.String[]`	`GetInfraredTuningPlugins()`	Gets the list of infrared tuning plugins that are available for use with SageTV
`long[]`	`GetIRCodesLinkedToSageCommand(java.lang.String SageCommand)`	Returns the infrared codes that are linked to the given SageTV Command.
`java.lang.String[]`	`GetKeystrokesLinkedToSageCommand(java.lang.String SageCommand)`	Returns the keystroke names that are linked to the given SageTV Command.
`java.io.File[]`	`GetLibraryImportPaths()`	Returns all of the library import paths that are currently configured for all media types
`int`	`GetMaxChannelDigitsForInfraredTuningPlugin(java.lang.String PluginName, int PluginPortNumber, java.lang.String RemoteName)`	Gets the maximum number of digits that are needed to tune a channel on the device that corresponds to the specified 'Remote Control'.
`java.lang.String[]`	`GetMixerAudioInputPaths()`	Gets the different input connectors that are available on the system sound mixer (Windows Only)
`java.io.File[]`	`GetMusicLibraryImportPaths()`	Returns the library import paths that are currently configured for music files
`java.lang.String`	`GetNameForIRCode(long IRCode)`	Gets the name that is associated with an IR code.
`float`	`GetOverscanInsetBottom()`	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()
`float`	`GetOverscanInsetLeft()`	Returns a floating point value which specifies the percent of the UI that is taken up by overscan on the left side.
`float`	`GetOverscanInsetRight()`	Returns a floating point value which specifies the percent of the UI that is taken up by overscan on the right side.
`java.lang.Float[]`	`GetOverscanInsets()`	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.
`float`	`GetOverscanInsetTop()`	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())))
`int`	`GetOverscanOffsetX()`	Returns the horizontal offset in pixels that should be applied to the UI to account for overscan.
`int`	`GetOverscanOffsetY()`	Returns the vertical offset in pixels that should be applied to the UI to account for overscan.
`float`	`GetOverscanScaleHeight()`	Returns the vertical scale factor that should be applied to the UI to account for overscan.
`float`	`GetOverscanScaleWidth()`	Returns the horizontal scale factor that should be applied to the UI to account for overscan.
`java.io.File[]`	`GetPictureLibraryImportPaths()`	Returns the library import paths that are currently configured for picture files
`java.lang.String`	`GetPrefixCommandForInfraredTuningPlugin(java.lang.String PluginName, int PluginPortNumber, java.lang.String RemoteName)`	Gets the command that is to be sent before a channel change sequence is started.
`java.lang.String`	`GetProperty(java.lang.String PropertyName, java.lang.String DefaultValue)`	Gets the property with the specified name.
`java.lang.String[]`	`GetRatingsUnderParentalLock()`	Gets the list of content ratings that are under parental lock.
`java.lang.String[]`	`GetRecordingQualities()`	Returns a list of the different recording quality names available in the system
`long`	`GetRecordingQualityBitrate(java.lang.String Quality)`	Gets the estimated overall bitrate for a given recording quality.
`java.lang.String`	`GetRecordingQualityFormat(java.lang.String Quality)`	Gets the format for a given recording quality.
`java.lang.String[]`	`GetRemotesForInfraredTuningPlugin(java.lang.String PluginName, int PluginPortNumber)`	Gets the names of the 'Remote Controls' which correspond to external devices that can be controlled with the specified plugin
`java.lang.String`	`GetSageCommandLinkedToIRCode(long IRCode)`	Returns the SageTV Command that is linked to the specified infrared code.
`java.lang.String`	`GetSageCommandLinkedToKeystroke(java.lang.String Keystroke)`	Returns the SageTV Command that is linked to the specified keystroke.
`int`	`GetScreenSaverTimeout()`	Gets the screen saver timeout in milliseconds.
`int`	`GetSequenceDelayForInfraredTuningPlugin(java.lang.String PluginName, int PluginPortNumber, java.lang.String RemoteName)`	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
`java.lang.String`	`GetServerProperty(java.lang.String PropertyName, java.lang.String DefaultValue)`	Gets the property with the specified name.
`java.lang.String[]`	`GetServerSubpropertiesThatAreBranches(java.lang.String PropertyName)`	Returns the list of properties underneath the specified property that themselves contain further subproperties.
`java.lang.String[]`	`GetServerSubpropertiesThatAreLeaves(java.lang.String PropertyName)`	Returns the list of properties underneath the specified property that do not contain further subproperties.
`java.lang.String[]`	`GetSubpicAudioLanguageOptions()`	Gets the list of languages that are available to be used as presets for Audio tracks or Subpicture.
`java.lang.String[]`	`GetSubpropertiesThatAreBranches(java.lang.String PropertyName)`	Returns the list of properties underneath the specified property that themselves contain further subproperties.
`java.lang.String[]`	`GetSubpropertiesThatAreLeaves(java.lang.String PropertyName)`	Returns the list of properties underneath the specified property that do not contain further subproperties.
`java.lang.String`	`GetTimeZone()`	Gets the name of the time zone that the application is currently configured to use
`java.lang.String`	`GetUILanguage()`	Gets the language that the user interface should be displayed in.
`java.awt.Color`	`GetVideoBackgroundColor()`	Returns the color that should be used for the video background.
`java.lang.String`	`GetVideoDecoderFilter()`	Gets the name of the DirectShow video decoder filter that's used for MPEG2 playback (Windows only)
`java.lang.String[]`	`GetVideoDecoderFilters()`	Gets the list of the video decoder filters that are available in the system for MPEG2 playback (Windows only)
`java.io.File[]`	`GetVideoDirectories()`	Gets the list of directories that SageTV is configured to record television to
`java.lang.String[]`	`GetVideoDiskspaceRules()`	Returns the list of valid diskspace rules.
`java.io.File[]`	`GetVideoLibraryImportPaths()`	Returns the library import paths that are currently configured for video files
`int`	`GetVideoOffsetX(java.lang.String AspectRatioMode)`	Gets of the offset in pixels that should be applied horizontally to the video.
`int`	`GetVideoOffsetY(java.lang.String AspectRatioMode)`	Gets of the offset in pixels that should be applied vertically to the video.
`long`	`GetVideoOrbitingDuration()`	Gets the video orbiting duration in milliseconds.
`float`	`GetVideoZoomX(java.lang.String AspectRatioMode)`	Gets the horizontal scale factor for the video for the specified aspect ratio mode.
`float`	`GetVideoZoomY(java.lang.String AspectRatioMode)`	Gets the vertical scale factor for the video for the specified aspect ratio mode.
`boolean`	`HasDirectX9()`	Returns true if the system has DirectX 9 installed (Windows Only)
`boolean`	`HasEVRSupport()`	Returns true if the system has support for the Enhanced Video Renderer (EVR) (Windows Only)
`boolean`	`HasParentalLockCode()`	Returns true if a parental lock code has been configured
`boolean`	`HasPVR350TVOutput()`	Returns true if the system has a Hauppauge WinTV PVR-350 card installed which can produce a TV output (Windows only)
`boolean`	`IsAcceleratedDrawingEnabled()`	Returns true if 3D acceleration is enabled for the rendering engine.
`boolean`	`IsAdvancedDeinterlacingEnabled()`	Returns true if the client supports doing advanced deinterlacing and it is enabled.
`boolean`	`IsAdvancedDeinterlacingSupported()`	Returns true if the client supports doing advanced deinterlacing.
`boolean`	`IsDscalerDoubleRefresh()`	Returns true if DScaler is set to double the refresh rate when used.
`boolean`	`IsDscalerEnabled()`	Returns true if the DScaler deinterlacing filter is enabled (Windows only)
`boolean`	`IsDscalerOddFieldFirst()`	Returns true if DScaler is configured to display the odd field first (fields are even or odd)
`boolean`	`IsIntelligentRecordingDisabled()`	Returns true if the 'Intelligent Recording' feature of SageTV is disabled.
`boolean`	`IsMajorMinorDTVChannelTuningEnabled()`	Deprecated.
`boolean`	`IsMutedOnAlternateSpeedPlayback()`	Returns true if SageTV should mute the volume when media is played back at speeds besides x1
`boolean`	`IsNativeOutputResolutionEnabled()`	Returns true if this device is configured to match the output resolution to the media format's resolution
`boolean`	`IsParentalControlEnabled()`	Returns true if parental controls are enabled on the system
`boolean`	`IsPlaceshifterLoginCachingAllowed()`	Returns true if this server allows caching of placeshifter logins, false otherwise
`boolean`	`IsProvideoPentium4FixEnabled()`	Deprecated.
`boolean`	`IsPVR350OSDEnabled()`	Returns true if the user interface (OSD) display on a Hauppauge WinTV PVR-350 should be shown through the tv output (Windows only)
`boolean`	`IsPVR350TVOutputEnabled()`	Returns true if the TV output on a Hauppauge WinTV PVR-350 card is enabled (Windows only)
`boolean`	`IsRatingUnderParentalLock(java.lang.String Rating)`	Returns true if the specified rating is in the list that is under parental control
`boolean`	`IsSageTVServerEnabled()`	Returns true if the SageTV server is enabled.
`boolean`	`IsScreenSaverOnSleepEnabled()`	Returns true if SageTV will go to its screen saver when it is put to sleep.
`boolean`	`IsSoftwareDecodingDisabled()`	Returns true if software decoding is disabled.
`boolean`	`IsSyncSystemClockWithServerEnabled()`	Returns true if SageTV should synchronize the system clock with the server.
`boolean`	`IsVideoRendererDefault()`	Returns true if the video renderer is configured to use the Default renderer (Windows Only).
`boolean`	`IsVideoRendererEVR()`	Returns true if the video renderer is configured to use the Enhanced Video Renderer (Windows Only).
`boolean`	`IsVideoRendererOverlay()`	Returns true if the video renderer is configured to use the Overlay surface (Windows Only) Applies to all files except DVDs.
`boolean`	`IsVideoRendererVMR9()`	Returns true if the video renderer is configured to use the Video Mixing Renderer 9 (Windows Only).
`boolean`	`LearnCommandForInfraredTuningPlugin(java.lang.String PluginName, int PluginPortNumber, java.lang.String RemoteName, java.lang.String CommandName)`	Informs an infrared tuning plugin that it should go into the learn mode to learn a new command.
`void`	`LinkIRCodeToSageCommand(long IRCode, java.lang.String SageCommand)`	Links an infrared code to a SageTV Command.
`void`	`LinkKeystrokeToSageCommand(java.lang.String Keystroke, java.lang.String SageCommand)`	Links a keystroke to a SageTV Command.
`void`	`RemoveCommandForInfraredTuningPlugin(java.lang.String PluginName, int PluginPortNumber, java.lang.String RemoteName, java.lang.String CommandName)`	Removes a command from a 'Remote Control' for an infrared tuning plugin.
`void`	`RemoveLibraryImportPath(java.io.File RemovePath)`	Removes a path from the list of library import paths.
`void`	`RemoveMusicLibraryImportPath(java.io.File RemovePath)`	Removes a path from the list of library import paths for music
`void`	`RemovePictureLibraryImportPath(java.io.File RemovePath)`	Removes a path from the list of library import paths for pictures
`void`	`RemoveProperty(java.lang.String PropertyName)`	Removes the specified property from the property map
`void`	`RemovePropertyAndChildren(java.lang.String PropertyName)`	Removes the specified property and any subproperties that start with the same prefix
`void`	`RemoveRemoteForInfraredTuningPlugin(java.lang.String PluginName, int PluginPortNumber, java.lang.String RemoteName)`	Removes a 'Remote Control' from an infrared tuning plugin.
`void`	`RemoveServerProperty(java.lang.String PropertyName)`	Removes the specified property from the property map.
`void`	`RemoveServerPropertyAndChildren(java.lang.String PropertyName)`	Removes the specified property and any subproperties that start with the same prefix.
`void`	`RemoveVideoDirectory(java.io.File Directory)`	Removes a directory from SageTV's list of directories that it can record television to.
`void`	`RemoveVideoLibraryImportPath(java.io.File RemovePath)`	Removes a path from the list of library import paths for videos
`void`	`RenameCommandForInfraredTuningPlugin(java.lang.String PluginName, int PluginPortNumber, java.lang.String RemoteName, java.lang.String OldCommandName, java.lang.String NewCommandName)`	Renames a command for a remote control on an infrared tuning plugin
`void`	`RunFilterAutoconfiguration()`	Deprecated.
`void`	`SaveProperties()`	Saves the Sage.properties file to disk
`boolean`	`SetAcceleratedDrawingEnabled(boolean Enabled)`	Specifies whether or not 3D acceleration should be enabled for the rendering engine.
`void`	`SetAdvancedDeinterlacingEnabled(boolean Enabled)`	Allows enabling/disabling of advanced deinterlacing support.
`void`	`SetAllowPlaceshifterLoginCaching(boolean Enabled)`	Sets whether or not placeshifter connections should be allowed to cache their login information.
`void`	`SetAnalogVideoFormat(java.lang.String Format)`	Sets the analog video format that should be used for capture and playback.
`void`	`SetAspectRatioMode(java.lang.String AspectRatioMode)`	Sets the aspect ratio mode that should currently be used.
`void`	`SetAudioDecoderFilter(java.lang.String FilterName)`	Sets the name of the DirectShow audio decoder filter that's used for MPEG2 playback (Windows only)
`void`	`SetAudioDelay(int Delay)`	Sets the audio delay in milliseconds to apply when playing back MPEG2 files (Windows only)
`void`	`SetAudioOutput(java.lang.String AudioOutput)`	Sets the current audio output.
`void`	`SetAudioRenderFilter(java.lang.String FilterName)`	Sets the name of the DirectShow audio renderer filter that's used for playback except DVDs (Windows only)
`void`	`SetAutodialForInternet(boolean Autodial)`	Sets whether or not SageTV should autodial before accessing the Internet
`void`	`SetButtonDelayForInfraredTuningPlugin(java.lang.String PluginName, int PluginPortNumber, java.lang.String RemoteName, int MsecDelay)`	Sets the minimum delay in milliseconds that is required between sending consecutive commands using the specified 'Remote Control'.
`void`	`SetConfirmCommandForInfraredTuningPlugin(java.lang.String PluginName, int PluginPortNumber, java.lang.String RemoteName, java.lang.String Command)`	Sets the command that is to be sent as the last command to complete a channel change sequence.
`java.lang.String`	`SetCountry(java.lang.String Country)`	Sets the country that the user is in.
`void`	`SetCurrentlyAiringProgramsStartLive(boolean Enabled)`	Sets whether or not when playing back a program that is currently airing whether we should start from live TV or not
`void`	`SetDefaultAudioLanguage(java.lang.String Language)`	Sets the name of the preferred default language when selecting which audio stream to playback.
`void`	`SetDefaultRecordingQuality(java.lang.String Quality)`	Sets the default quality that is used to record television
`void`	`SetDefaultSubpicLanguage(java.lang.String Language)`	Sets the name of the preferred default language when selecting which subpicture stream to playback.
`void`	`SetDisplayAspectRatio(float DisplayAspectRatio)`	Sets the aspect ratio of the current display device
`void`	`SetDscalerDoubleRefresh(boolean Enabled)`	Sets whether or not DScaler should double the refresh rate.
`void`	`SetDscalerEnabled(boolean Enabled)`	Sets whether or not the DScaler deinterlacing filter should be used (Windows only)
`void`	`SetDscalerMode(java.lang.String DscalerMode)`	Sets the mode that DScaler should be configured to run in when it is used (Windows only)
`void`	`SetDscalerOddFieldFirst(boolean Enabled)`	Sets if DScaler should display the odd field first (fields are even or odd)
`void`	`SetDscalerPlugin(java.lang.String PluginName)`	Sets the plugin that should be used by DScaler.
`void`	`SetDVBCRegion(java.lang.String DVBCRegion)`	Sets the the provider within the current country that the user has for DVBC reception.
`void`	`SetDVBSRegion(java.lang.String DVBSRegion)`	Sets the the provider within the current country that the user has for DVBS reception.
`void`	`SetDVBTRegion(java.lang.String DVBTRegion)`	Sets the the region within the current country that the user is in.
`void`	`SetDVDAudioDecoderFilter(java.lang.String FilterName)`	Sets the name of the DirectShow audio decoder filter that's used for DVD playback (Windows only)
`void`	`SetDVDAudioRenderFilter(java.lang.String FilterName)`	Sets the name of the DirectShow audio renderer filter that's used for DVD playback (Windows only)
`void`	`SetDVDDXVADeinterlaceMode(java.lang.String DeinterlaceMode)`	Sets the preferred DXVA Deinterlacing configuration setting (Windows only).
`void`	`SetDVDDXVAMpegMode(java.lang.String DXVAMode)`	Sets the preferred DXVA MPEG Mode configuration setting (Windows only).
`void`	`SetDVDVideoDecoderFilter(java.lang.String FilterName)`	Sets the name of the DirectShow video decoder filter that's used for DVD playback (Windows only)
`void`	`SetDVDVideoRenderFilter(java.lang.String FilterName)`	Sets the video renderer filter that should be used for DVD playback.
`void`	`SetDXVADeinterlaceMode(java.lang.String DeinterlaceMode)`	Sets the preferred DXVA Deinterlacing configuration setting (Windows only).
`void`	`SetDXVAMpegMode(java.lang.String DXVAMode)`	Sets the preferred DXVA MPEG Mode configuration setting (Windows only).
`void`	`SetInactivityTimeout(int Timeout)`	Sets the inactivity timeout in milliseconds.
`boolean`	`SetInfraredReceiverPort(java.lang.String Port)`	Sets the name of the port that the infrared receiver is connected to.
`void`	`SetIntelligentRecordingDisabled(boolean Disabled)`	Sets whether or not 'Intelligent Recording' should be disabled.
`void`	`SetMajorMinorDTVChannelTuningEnabled(boolean Enabled)`	Deprecated.
`void`	`SetMaxChannelDigitsForInfraredTuningPlugin(java.lang.String PluginName, int PluginPortNumber, java.lang.String RemoteName, int NumberOfDigits)`	Sets the maximum number of digits that are needed to tune a channel on the device that corresponds to the specified 'Remote Control'.
`void`	`SetMuteOnAlternateSpeedPlayback(boolean Enabled)`	Sets whether or not SageTV should mute the sound when media is played back at a speed other than x1
`void`	`SetNameForIRCode(long IRCode, java.lang.String Name)`	Sets the name for a given IR code.
`void`	`SetNativeOutputResolutionEnabled(boolean Enabled)`	Sets whether or not this device should try to match its output resolution to the media format's resolution
`void`	`SetOverscanOffsetX(int Amount)`	Sets the horizontal offset in pixels that should be applied to the UI to account for overscan.
`void`	`SetOverscanOffsetY(int Amount)`	Sets the vertical offset in pixels that should be applied to the UI to account for overscan.
`void`	`SetOverscanScaleHeight(float Amount)`	Sets the vertical scale factor that should be applied to the UI to account for overscan.
`void`	`SetOverscanScaleWidth(float Amount)`	Sets the horizontal scale factor that should be applied to the UI to account for overscan.
`void`	`SetParentalControlEnabled(boolean Enabled)`	Sets whether or not parental controls are enabled for the system
`void`	`SetParentalLockCode(java.lang.String ParentalLockCode)`	Sets the code that is to be used in order to unlock the parental controls.
`void`	`SetPrefixCommandForInfraredTuningPlugin(java.lang.String PluginName, int PluginPortNumber, java.lang.String RemoteName, java.lang.String Command)`	Sets the command that is to be sent before a channel change sequence is started.
`void`	`SetProperty(java.lang.String PropertyName, java.lang.String PropertyValue)`	Sets the property with the specified name to the specified value.
`void`	`SetProvideoPentium4FixEnabled(boolean Enabled)`	Deprecated.
`void`	`SetPVR350OSDEnabled(boolean Enabled)`	Sets whether or not the user interface (OSD) should be displayed on the TV output of a Hauppauge WinTV PVR-350 (Windows only)
`void`	`SetPVR350TVOutputEnabled(boolean Enabled)`	Sets whether or not the TV output on a Hauppauge WinTV PVR-350 should be enabled (Windows only)
`void`	`SetRatingUnderParentalControl(java.lang.String Rating, boolean Restricted)`	Sets whether or not a given rating should be restricted under parental control
`void`	`SetSageTVServerEnabled(boolean Enabled)`	Sets whether or not the SageTV server should be enabled.
`void`	`SetScreenSaverOnSleepEnabled(boolean Enabled)`	Sets whether or not SageTV should go to its screen saver when put to sleep.
`void`	`SetScreenSaverTimeout(int Timeout)`	Sets the screen saver timeout in milliseconds.
`void`	`SetSequenceDelayForInfraredTuningPlugin(java.lang.String PluginName, int PluginPortNumber, java.lang.String RemoteName, int MsecDelay)`	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
`void`	`SetServerProperty(java.lang.String PropertyName, java.lang.String PropertyValue)`	Sets the property with the specified name to the specified value.
`void`	`SetSoftwareDecodingDisabled(boolean Disabled)`	Sets if software decoding is disabled.
`void`	`SetSyncSystemClockWithServerEnabled(boolean Enabled)`	Sets if SageTV should synchronize the system clock with the server.
`void`	`SetTimeZone(java.lang.String TimeZone)`	Sets the name of the time zone that the application should use.
`void`	`SetUILanguage(java.lang.String Language)`	Sets the language that the user interface should be displayed in.
`void`	`SetVideoBackgroundColor(java.awt.Color Color)`	Sets the color that should be used for the video background.
`void`	`SetVideoDecoderFilter(java.lang.String FilterName)`	Sets the name of the DirectShow video decoder filter that's used for MPEG2 playback (Windows only)
`void`	`SetVideoOffsetX(java.lang.String AspectRatioMode, int PixelOffset)`	Sets of the offset in pixels that should be applied horizontally to the video.
`void`	`SetVideoOffsetY(java.lang.String AspectRatioMode, int PixelOffset)`	Sets of the offset in pixels that should be applied vertically to the video.
`void`	`SetVideoOrbitingDuration(long Duration)`	Sets the video orbiting duration in milliseconds.
`void`	`SetVideoRendererToDefault()`	Sets the video renderer to use the default renderer (Windows Only).
`void`	`SetVideoRendererToEVR()`	Sets the video renderer to use the Enhanced Video Renderer (Windows Only).
`void`	`SetVideoRendererToOverlay()`	Sets the video renderer to use the video Overlay surface (Windows Only).
`void`	`SetVideoRendererToVMR9()`	Sets the video renderer to use the Video Mixing Renderer 9 (Windows Only).
`void`	`SetVideoZoomX(java.lang.String AspectRatioMode, float ScaleFactor)`	Sets the horizontal scale factor for the video for the specified aspect ratio mode.
`void`	`SetVideoZoomY(java.lang.String AspectRatioMode, float ScaleFactor)`	Sets the vertical scale factor for the video for the specified aspect ratio mode.
`void`	`UnlinkIRCodeFromSageCommands(long IRCode)`	Unlinks an infrared code from any SageTV commands it is linked to
`void`	`UnlinkKeystrokeFromSageCommands(java.lang.String Keystroke)`	Unlinks a keystroke from any SageTV commands it is linked to

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Configuration
```
public Configuration()
```
- Method Detail
  - SaveProperties
```
public void SaveProperties()
```
    Saves the Sage.properties file to disk
  - GetLibraryImportPaths
```
public java.io.File[] GetLibraryImportPaths()
```
    Returns all of the library import paths that are currently configured for all media types
    
    Returns:
    
    the library import paths that are currently configured for all media types
  - GetPictureLibraryImportPaths
```
public java.io.File[] GetPictureLibraryImportPaths()
```
    Returns the library import paths that are currently configured for picture files
    
    Returns:
    
    the library import paths that are currently configured for picture files
  - GetMusicLibraryImportPaths
```
public java.io.File[] GetMusicLibraryImportPaths()
```
    Returns the library import paths that are currently configured for music files
    
    Returns:
    
    the library import paths that are currently configured for music files
  - GetVideoLibraryImportPaths
```
public java.io.File[] GetVideoLibraryImportPaths()
```
    Returns the library import paths that are currently configured for video files
    
    Returns:
    
    the library import paths that are currently configured for video files
  - IsMajorMinorDTVChannelTuningEnabled
```
public boolean IsMajorMinorDTVChannelTuningEnabled()
```
    Deprecated.
    
    Returns true if the legacy major/minor channel tuning is enabled. Do not use anymore
    
    Returns:
    
    true if the legacy major/minor channel tuning is enabled
  - GetAutodialForInternet
```
public boolean GetAutodialForInternet()
```
    Returns true if SageTV should attempt to autodial before accessing the Internet
    
    Returns:
    
    true if SageTV should attempt to autodial before accessing the Internet
  - SetAutodialForInternet
```
public void SetAutodialForInternet(boolean Autodial)
```
    Sets whether or not SageTV should autodial before accessing the Internet
    
    Parameters:
    
    Autodial - true if SageTV should autodial before accessing the Internet
  - IsProvideoPentium4FixEnabled
```
public boolean IsProvideoPentium4FixEnabled()
```
    Deprecated.
    
    Returns true if the Provideo 256 Pentium 4 fix is enabled
    
    Returns:
    
    true if the Provideo 256 Pentium 4 fix is enabled
  - SetProvideoPentium4FixEnabled
```
public void SetProvideoPentium4FixEnabled(boolean Enabled)
```
    Deprecated.
    
    Sets whether or not the Provideo 256 Pentium 4 fix should be enabled
    
    Parameters:
    
    Enabled - true if the Provideo 256 Pentium 4 fix should be enabled
  - GetInfraredTuningPlugins
```
public java.lang.String[] GetInfraredTuningPlugins()
```
    Gets the list of infrared tuning plugins that are available for use with SageTV
    
    Returns:
    
    the list of infrared tuning plugins that are available for use with SageTV
  - GetRemotesForInfraredTuningPlugin
```
public java.lang.String[] GetRemotesForInfraredTuningPlugin(java.lang.String PluginName,
                                                            int PluginPortNumber)
```
    Gets the names of the 'Remote Controls' which correspond to external devices that can be controlled with the specified plugin
    
    Parameters:
    
    PluginName - the name of the infrared tuning plugin to get the remotes for
    
    PluginPortNumber - the port number of the tuning plugin, 0 if there is no port for it
    
    Returns:
    
    the names of the 'Remotes' which correspond to external devices that can be controlled by the specified plugin on the specified port
  - AddRemoteForInfraredTuningPlugin
```
public java.lang.String AddRemoteForInfraredTuningPlugin(java.lang.String PluginName,
                                                         int PluginPortNumber,
                                                         java.lang.String RemoteName)
```
    Creates a new 'Remote Control' with the specified name for the specified plugin. Depending upon the plugin, this may require the user to perform some interaction before it returns.
    
    Parameters:
    
    PluginName - the name of the infrared tuning plugin
    
    PluginPortNumber - the port number of the tuning plugin, 0 if there is no port for it
    
    RemoteName - the name to use for the newly created 'Remote Control'
    
    Returns:
    
    the RemoteName parameter will be returned if a new 'Remote Control' is created, null will be returned if one already exists with that name
  - LearnCommandForInfraredTuningPlugin
```
public boolean LearnCommandForInfraredTuningPlugin(java.lang.String PluginName,
                                                   int PluginPortNumber,
                                                   java.lang.String RemoteName,
                                                   java.lang.String CommandName)
```
    Informs an infrared tuning plugin that it should go into the learn mode to learn a new command. This call will return after the user has given the hardware the appropriate input it is looking for.
    
    Parameters:
    
    PluginName - the name of the infrared tuning plugin
    
    PluginPortNumber - the port number of the tuning plugin, 0 if there is no port for it
    
    RemoteName - the name of the 'Remote Control' that the command is being learned from
    
    CommandName - the name of the command being sent from the remote control
    
    Returns:
    
    true if the command was successfully learned, false otherwise
  - RenameCommandForInfraredTuningPlugin
```
public void RenameCommandForInfraredTuningPlugin(java.lang.String PluginName,
                                                 int PluginPortNumber,
                                                 java.lang.String RemoteName,
                                                 java.lang.String OldCommandName,
                                                 java.lang.String NewCommandName)
```
    Renames a command for a remote control on an infrared tuning plugin
    
    Parameters:
    
    PluginName - the name of the infrared tuning plugin
    
    PluginPortNumber - the port number of the tuning plugin, 0 if there is no port for it
    
    RemoteName - the name of the 'Remote Control' that the command is from
    
    OldCommandName - the current name of the command
    
    NewCommandName - the new name to rename this command to
  - RemoveRemoteForInfraredTuningPlugin
```
public void RemoveRemoteForInfraredTuningPlugin(java.lang.String PluginName,
                                                int PluginPortNumber,
                                                java.lang.String RemoteName)
```
    Removes a 'Remote Control' from an infrared tuning plugin. This will also delete all commands learned by that 'Remote Control'.
    
    Parameters:
    
    PluginName - the name of the infrared tuning plugin
    
    PluginPortNumber - the port number of the tuning plugin, 0 if there is no port for it
    
    RemoteName - the name of the 'Remote Control' to remove
  - RemoveCommandForInfraredTuningPlugin
```
public void RemoveCommandForInfraredTuningPlugin(java.lang.String PluginName,
                                                 int PluginPortNumber,
                                                 java.lang.String RemoteName,
                                                 java.lang.String CommandName)
```
    Removes a command from a 'Remote Control' for an infrared tuning plugin. If the command had a learned code, that code will be lost.
    
    Parameters:
    
    PluginName - the name of the infrared tuning plugin
    
    PluginPortNumber - the port number of the tuning plugin, 0 if there is no port for it
    
    RemoteName - the name of the 'Remote Control'
    
    CommandName - the name of the command to remove
  - SetMaxChannelDigitsForInfraredTuningPlugin
```
public void SetMaxChannelDigitsForInfraredTuningPlugin(java.lang.String PluginName,
                                                       int PluginPortNumber,
                                                       java.lang.String RemoteName,
                                                       int NumberOfDigits)
```
    Sets the maximum number of digits that are needed to tune a channel on the device that corresponds to the specified 'Remote Control'. For example, if you always need to push 3 numeric keys before the device would tune a channel (i.e. channels are from 1-999) then you would specify 3 here.
    
    Parameters:
    
    PluginName - the name of the infrared tuning plugin
    
    PluginPortNumber - the port number of the tuning plugin, 0 if there is no port for it
    
    RemoteName - the name of the 'Remote Control'
    
    NumberOfDigits - the maximum number of digits needed to tune a channel using the specified remote on this plugin
  - GetMaxChannelDigitsForInfraredTuningPlugin
```
public int GetMaxChannelDigitsForInfraredTuningPlugin(java.lang.String PluginName,
                                                      int PluginPortNumber,
                                                      java.lang.String RemoteName)
```
    Gets the maximum number of digits that are needed to tune a channel on the device that corresponds to the specified 'Remote Control'. For example, if you always need to push 3 numeric keys before the device would tune a channel (i.e. channels are from 1-999) then this should be 3.
    
    Parameters:
    
    PluginName - the name of the infrared tuning plugin
    
    PluginPortNumber - the port number of the tuning plugin, 0 if there is no port for it
    
    RemoteName - the name of the 'Remote Control'
    
    Returns:
    
    the maximum number of digits needed to tune a channel using the specified remote on this plugin
  - SetButtonDelayForInfraredTuningPlugin
```
public void SetButtonDelayForInfraredTuningPlugin(java.lang.String PluginName,
                                                  int PluginPortNumber,
                                                  java.lang.String RemoteName,
                                                  int MsecDelay)
```
    Sets the minimum delay in milliseconds that is required between sending consecutive commands using the specified 'Remote Control'.
    
    Parameters:
    
    PluginName - the name of the infrared tuning plugin
    
    PluginPortNumber - the port number of the tuning plugin, 0 if there is no port for it
    
    RemoteName - the name of the 'Remote Control'
    
    MsecDelay - the minimum required delay between commands in milliseconds
  - GetButtonDelayForInfraredTuningPlugin
```
public int GetButtonDelayForInfraredTuningPlugin(java.lang.String PluginName,
                                                 int PluginPortNumber,
                                                 java.lang.String RemoteName)
```
    Gets the minimum delay in milliseconds that is required between sending consecutive commands using the specified 'Remote Control'.
    
    Parameters:
    
    PluginName - the name of the infrared tuning plugin
    
    PluginPortNumber - the port number of the tuning plugin, 0 if there is no port for it
    
    RemoteName - the name of the 'Remote Control'
    
    Returns:
    
    the minimum required delay between commands in milliseconds
  - SetSequenceDelayForInfraredTuningPlugin
```
public void SetSequenceDelayForInfraredTuningPlugin(java.lang.String PluginName,
                                                    int PluginPortNumber,
                                                    java.lang.String RemoteName,
                                                    int MsecDelay)
```
    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
    
    Parameters:
    
    PluginName - the name of the infrared tuning plugin
    
    PluginPortNumber - the port number of the tuning plugin, 0 if there is no port for it
    
    RemoteName - the name of the 'Remote Control'
    
    MsecDelay - the minimum delay in milliseconds between finishing one channel change sequence and starting another when using the specified 'Remote Control'
  - GetSequenceDelayForInfraredTuningPlugin
```
public int GetSequenceDelayForInfraredTuningPlugin(java.lang.String PluginName,
                                                   int PluginPortNumber,
                                                   java.lang.String RemoteName)
```
    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
    
    Parameters:
    
    PluginName - the name of the infrared tuning plugin
    
    PluginPortNumber - the port number of the tuning plugin, 0 if there is no port for it
    
    RemoteName - the name of the 'Remote Control'
    
    Returns:
    
    the minimum delay in milliseconds between finishing one channel change sequence and starting another when using the specified 'Remote Control'
  - SetConfirmCommandForInfraredTuningPlugin
```
public void SetConfirmCommandForInfraredTuningPlugin(java.lang.String PluginName,
                                                     int PluginPortNumber,
                                                     java.lang.String RemoteName,
                                                     java.lang.String Command)
```
    Sets the command that is to be sent as the last command to complete a channel change sequence. This is for devices that require an 'Enter' or other type of confirmation key to be pressed after the numeric channel codes are sent.
    
    Parameters:
    
    PluginName - the name of the infrared tuning plugin
    
    PluginPortNumber - the port number of the tuning plugin, 0 if there is no port for it
    
    RemoteName - the name of the 'Remote Control'
    
    Command - the name of the command from this 'Remote Control' to use to confirm a channel change
  - SetPrefixCommandForInfraredTuningPlugin
```
public void SetPrefixCommandForInfraredTuningPlugin(java.lang.String PluginName,
                                                    int PluginPortNumber,
                                                    java.lang.String RemoteName,
                                                    java.lang.String Command)
```
    Sets the command that is to be sent before a channel change sequence is started. This is for devices that require a 'Power On' or 'Cancel' type of function to ensure the device is a responsive state.
    
    Parameters:
    
    PluginName - the name of the infrared tuning plugin
    
    PluginPortNumber - the port number of the tuning plugin, 0 if there is no port for it
    
    RemoteName - the name of the 'Remote Control'
    
    Command - the name of the command from this 'Remote Control' to use to prefix a channel change
    
    Since:
    
    6.2
  - GetConfirmCommandForInfraredTuningPlugin
```
public java.lang.String GetConfirmCommandForInfraredTuningPlugin(java.lang.String PluginName,
                                                                 int PluginPortNumber,
                                                                 java.lang.String RemoteName)
```
    Gets the command that is to be sent as the last command to complete a channel change sequence. This is for devices that require an 'Enter' or other type of confirmation key to be pressed after the numeric channel codes are sent.
    
    Parameters:
    
    PluginName - the name of the infrared tuning plugin
    
    PluginPortNumber - the port number of the tuning plugin, 0 if there is no port for it
    
    RemoteName - the name of the 'Remote Control'
    
    Returns:
    
    the name of the command from this 'Remote Control' to use to confirm a channel change
  - GetPrefixCommandForInfraredTuningPlugin
```
public java.lang.String GetPrefixCommandForInfraredTuningPlugin(java.lang.String PluginName,
                                                                int PluginPortNumber,
                                                                java.lang.String RemoteName)
```
    Gets the command that is to be sent before a channel change sequence is started. This is for devices that require a 'Power On' or 'Cancel' type of function to ensure the device is a responsive state.
    
    Parameters:
    
    PluginName - the name of the infrared tuning plugin
    
    PluginPortNumber - the port number of the tuning plugin, 0 if there is no port for it
    
    RemoteName - the name of the 'Remote Control'
    
    Returns:
    
    the name of the command from this 'Remote Control' to use to prefix a channel change
    
    Since:
    
    6.2
  - GetCarrierFrequencyForInfraredTuningPlugin
```
public long GetCarrierFrequencyForInfraredTuningPlugin(java.lang.String PluginName,
                                                       int PluginPortNumber,
                                                       java.lang.String RemoteName)
```
    Gets the carrier frequency detected by this plugin for the specified remote
    
    Parameters:
    
    PluginName - the name of the infrared tuning plugin
    
    PluginPortNumber - the port number of the tuning plugin, 0 if there is no port for it
    
    RemoteName - the name of the 'Remote Control'
    
    Returns:
    
    the carrier frequency of the specified 'Remote Control', or zero if the plugin doesn't have that information
  - GetBitTimeForInfraredTuningPlugin
```
public long GetBitTimeForInfraredTuningPlugin(java.lang.String PluginName,
                                              int PluginPortNumber,
                                              java.lang.String RemoteName)
```
    Gets the 'bit time' detected by this plugin for the specified remote
    
    Parameters:
    
    PluginName - the name of the infrared tuning plugin
    
    PluginPortNumber - the port number of the tuning plugin, 0 if there is no port for it
    
    RemoteName - the name of the 'Remote Control'
    
    Returns:
    
    the 'bit time' of the specified 'Remote Control', or zero if the plugin doesn't have that information
  - GetCommandsForInfraredTuningPlugin
```
public java.util.Vector GetCommandsForInfraredTuningPlugin(java.lang.String PluginName,
                                                           int PluginPortNumber,
                                                           java.lang.String RemoteName)
```
    Gets the list of commands for the specified 'Remote Control' for the specified plugin
    
    Parameters:
    
    PluginName - the name of the infrared tuning plugin
    
    PluginPortNumber - the port number of the tuning plugin, 0 if there is no port for it
    
    RemoteName - the name of the 'Remote Control'
    
    Returns:
    
    the list of commands for the specified 'Remote Control' for the specified plugin
  - GetSubpropertiesThatAreBranches
```
public java.lang.String[] GetSubpropertiesThatAreBranches(java.lang.String PropertyName)
```
    Returns the list of properties underneath the specified property that themselves contain further subproperties. For example, if the following were the properties: animal/pig=0 animal/fish/salmon=1 animal/fish/trout=2 animal/reptile/green/alligator=4 and this call was made with "animal" as the argument, then the returned values would be "fish" and "reptile"
    
    Parameters:
    
    PropertyName - the root property to check for subproperty branches under
    
    Returns:
    
    the list of properties underneath the specified property that themselves contain further subproperties.
  - GetSubpropertiesThatAreLeaves
```
public java.lang.String[] GetSubpropertiesThatAreLeaves(java.lang.String PropertyName)
```
    Returns the list of properties underneath the specified property that do not contain further subproperties. For example, if the following were the properties: animal/pig=0 animal/fish/salmon=1 animal/fish/trout=2 animal/reptile/green/alligator=4 and this call was made with "animal" as the argument, then the returned values would only be "pig"
    
    Parameters:
    
    PropertyName - the root property to check for subproperty leaves under
    
    Returns:
    
    the list of properties underneath the specified property that do not contain further subproperties
  - GetServerSubpropertiesThatAreBranches
```
public java.lang.String[] GetServerSubpropertiesThatAreBranches(java.lang.String PropertyName)
```
    Returns the list of properties underneath the specified property that themselves contain further subproperties. For example, if the following were the properties: animal/pig=0 animal/fish/salmon=1 animal/fish/trout=2 animal/reptile/green/alligator=4 and this call was made with "animal" as the argument, then the returned values would be "fish" and "reptile" If this is called from a client instance then it will use the properties on the server system for this call.
    
    Parameters:
    
    PropertyName - the root property to check for subproperty branches under
    
    Returns:
    
    the list of properties underneath the specified property that themselves contain further subproperties.
    
    Since:
    
    6.1
  - GetServerSubpropertiesThatAreLeaves
```
public java.lang.String[] GetServerSubpropertiesThatAreLeaves(java.lang.String PropertyName)
```
    Returns the list of properties underneath the specified property that do not contain further subproperties. For example, if the following were the properties: animal/pig=0 animal/fish/salmon=1 animal/fish/trout=2 animal/reptile/green/alligator=4 and this call was made with "animal" as the argument, then the returned values would only be "pig" If this is called from a client instance then it will use the properties on the server system for this call.
    
    Parameters:
    
    PropertyName - the root property to check for subproperty leaves under
    
    Returns:
    
    the list of properties underneath the specified property that do not contain further subproperties
    
    Since:
    
    6.1
  - GetProperty
```
public java.lang.String GetProperty(java.lang.String PropertyName,
                                    java.lang.String DefaultValue)
```
    Gets the property with the specified name. If the property is not set yet, it will be set to the DefaultValue that is passed in unless that value is null
    
    Parameters:
    
    PropertyName - the name of the property to retrieve
    
    DefaultValue - the default value to set the property to if it does not exist, null if it should not be set
    
    Returns:
    
    the value of the specified property, or the DefaultValue if the property was not set prior to this call
  - SetProperty
```
public void SetProperty(java.lang.String PropertyName,
                        java.lang.String PropertyValue)
```
    Sets the property with the specified name to the specified value.
    
    Parameters:
    
    PropertyName - the name of the property to set
    
    PropertyValue - the value to set the property to
  - GetServerProperty
```
public java.lang.String GetServerProperty(java.lang.String PropertyName,
                                          java.lang.String DefaultValue)
```
    Gets the property with the specified name. If the property is not set yet, it will be set to the DefaultValue that is passed in unless that value is null. If this is called from a client instance then it will use the properties on the server system for this call.
    
    Parameters:
    
    PropertyName - the name of the property to retrieve
    
    DefaultValue - the default value to set the property to if it does not exist, null if it should not be set
    
    Returns:
    
    the value of the specified property, or the DefaultValue if the property was not set prior to this call
  - SetServerProperty
```
public void SetServerProperty(java.lang.String PropertyName,
                              java.lang.String PropertyValue)
```
    Sets the property with the specified name to the specified value. If this is called from a client instance then it will use the properties on the server system for this call and the change will be made on the server system.
    
    Parameters:
    
    PropertyName - the name of the property to set
    
    PropertyValue - the value to set the property to
  - RemoveProperty
```
public void RemoveProperty(java.lang.String PropertyName)
```
    Removes the specified property from the property map
    
    Parameters:
    
    PropertyName - the name of the property to remove
  - RemovePropertyAndChildren
```
public void RemovePropertyAndChildren(java.lang.String PropertyName)
```
    Removes the specified property and any subproperties that start with the same prefix
    
    Parameters:
    
    PropertyName - the name of the property that should be removed along with all of its subproperties
  - RemoveServerProperty
```
public void RemoveServerProperty(java.lang.String PropertyName)
```
    Removes the specified property from the property map. If this is called from a client instance then it will use the properties on the server system for this call and the change will be made on the server system.
    
    Parameters:
    
    PropertyName - the name of the property to remove
    
    Since:
    
    6.1
  - RemoveServerPropertyAndChildren
```
public void RemoveServerPropertyAndChildren(java.lang.String PropertyName)
```
    Removes the specified property and any subproperties that start with the same prefix. If this is called from a client instance then it will use the properties on the server system for this call and the change will be made on the server system.
    
    Parameters:
    
    PropertyName - the name of the property that should be removed along with all of its subproperties
    
    Since:
    
    6.1
  - GetDefaultRecordingQuality
```
public java.lang.String GetDefaultRecordingQuality()
```
    Gets the name of the default quality that is used to record television.
    
    Returns:
    
    the name of the default quality that is used to record television
  - IsIntelligentRecordingDisabled
```
public boolean IsIntelligentRecordingDisabled()
```
    Returns true if the 'Intelligent Recording' feature of SageTV is disabled. The default is disabled.
    
    Returns:
    
    true if the 'Intelligent Recording' feature of SageTV is disabled, false otherwise
  - AddLibraryImportPath
```
public void AddLibraryImportPath(java.lang.String NewPath)
```
    Adds a new file path to the list of paths that SageTV checks for library import files. This path will be used to search for music, video and picture files.
    
    Parameters:
    
    NewPath - the file path to add to the list of library import paths
  - AddPictureLibraryImportPath
```
public void AddPictureLibraryImportPath(java.lang.String NewPath)
```
    Adds a new file path to the list of paths that SageTV checks for library import files. This path will be used to search for picture files only.
    
    Parameters:
    
    NewPath - the file path to add to the list of library import paths for picture files
  - AddMusicLibraryImportPath
```
public void AddMusicLibraryImportPath(java.lang.String NewPath)
```
    Adds a new file path to the list of paths that SageTV checks for library import files. This path will be used to search for music files only.
    
    Parameters:
    
    NewPath - the file path to add to the list of library import paths for music files
  - AddVideoLibraryImportPath
```
public void AddVideoLibraryImportPath(java.lang.String NewPath)
```
    Adds a new file path to the list of paths that SageTV checks for library import files. This path will be used to search for video files only.
    
    Parameters:
    
    NewPath - the file path to add to the list of library import paths for video files
  - RemoveLibraryImportPath
```
public void RemoveLibraryImportPath(java.io.File RemovePath)
```
    Removes a path from the list of library import paths. This will affect all import types.
    
    Parameters:
    
    RemovePath - the path to remove from the list of library import paths
  - RemovePictureLibraryImportPath
```
public void RemovePictureLibraryImportPath(java.io.File RemovePath)
```
    Removes a path from the list of library import paths for pictures
    
    Parameters:
    
    RemovePath - the path to remove from the list of library import paths for pictures
  - RemoveMusicLibraryImportPath
```
public void RemoveMusicLibraryImportPath(java.io.File RemovePath)
```
    Removes a path from the list of library import paths for music
    
    Parameters:
    
    RemovePath - the path to remove from the list of library import paths for music
  - RemoveVideoLibraryImportPath
```
public void RemoveVideoLibraryImportPath(java.io.File RemovePath)
```
    Removes a path from the list of library import paths for videos
    
    Parameters:
    
    RemovePath - the path to remove from the list of library import paths for videos
  - SetDefaultRecordingQuality
```
public void SetDefaultRecordingQuality(java.lang.String Quality)
```
    Sets the default quality that is used to record television
    
    Parameters:
    
    Quality - the name of the quality setting to use to record television by default
  - SetIntelligentRecordingDisabled
```
public void SetIntelligentRecordingDisabled(boolean Disabled)
```
    Sets whether or not 'Intelligent Recording' should be disabled.
    
    Parameters:
    
    Disabled - should be true to disable 'Intelligent Recording', false to enable it
  - SetMajorMinorDTVChannelTuningEnabled
```
public void SetMajorMinorDTVChannelTuningEnabled(boolean Enabled)
```
    Deprecated.
    
    Sets whether or not SageTV should use legacy major-minor DTV channels. Not recommend for use anymore.
    
    Parameters:
    
    Enabled - true if SageTV should use legacy major-minor DTV channel tuning
  - IsScreenSaverOnSleepEnabled
```
public boolean IsScreenSaverOnSleepEnabled()
```
    Returns true if SageTV will go to its screen saver when it is put to sleep. If SageTV is not in full screen mode then it will go to the system tray regardless of this setting.
    
    Returns:
    
    true if SageTV will go to its screen saver when put to sleep, false otherwise
  - SetScreenSaverOnSleepEnabled
```
public void SetScreenSaverOnSleepEnabled(boolean Enabled)
```
    Sets whether or not SageTV should go to its screen saver when put to sleep. If SageTV is not in full screen mode then it will go to the system tray regardless of this setting.
    
    Parameters:
    
    Enabled - true if SageTV should go to the screen saver when put to sleep, false otherwise
  - IsSyncSystemClockWithServerEnabled
```
public boolean IsSyncSystemClockWithServerEnabled()
```
    Returns true if SageTV should synchronize the system clock with the server. For SageTV Client this will synchronize with its SageTV Server. For a SageTV system, this will synchronize with the EPG data server.
    
    Returns:
    
    true if SageTV should synchronize the system clock with the server
  - SetSyncSystemClockWithServerEnabled
```
public void SetSyncSystemClockWithServerEnabled(boolean Enabled)
```
    Sets if SageTV should synchronize the system clock with the server. For SageTV Client this will synchronize with its SageTV Server. For a SageTV system, this will synchronize with the EPG data server.
    
    Parameters:
    
    Enabled - true if SageTV should synchronize the system clock with the server
  - GetAspectRatioMode
```
public java.lang.String GetAspectRatioMode()
```
    Returns the localized name of the aspect ratio mode currently in use.
    
    Returns:
    
    the localized name of the aspect ratio mode currently in use
  - SetAspectRatioMode
```
public void SetAspectRatioMode(java.lang.String AspectRatioMode)
```
    Sets the aspect ratio mode that should currently be used.
    
    Parameters:
    
    AspectRatioMode - the localized name of the aspect ratio mode that should currently be used
  - GetAspectRatioModes
```
public java.lang.String[] GetAspectRatioModes()
```
    Gets the list of localized names for the aspect ratio modes
    
    Returns:
    
    the list of localized names for the aspect ratio modes
  - GetDisplayAspectRatio
```
public float GetDisplayAspectRatio()
```
    Returns the display aspect ratio that is set for the current display device being used
    
    Returns:
    
    the display aspect ratio that is set for the current display device being used
    
    Since:
    
    5.1
  - SetDisplayAspectRatio
```
public void SetDisplayAspectRatio(float DisplayAspectRatio)
```
    Sets the aspect ratio of the current display device
    
    Parameters:
    
    DisplayAspectRatio - the aspect ratio of the current display device
    
    Since:
    
    5.1
  - IsParentalControlEnabled
```
public boolean IsParentalControlEnabled()
```
    Returns true if parental controls are enabled on the system
    
    Returns:
    
    true if parental controls are enabled on the system
  - SetParentalControlEnabled
```
public void SetParentalControlEnabled(boolean Enabled)
```
    Sets whether or not parental controls are enabled for the system
    
    Parameters:
    
    Enabled - true if parental controls should be enabled, false otherwise
  - IsMutedOnAlternateSpeedPlayback
```
public boolean IsMutedOnAlternateSpeedPlayback()
```
    Returns true if SageTV should mute the volume when media is played back at speeds besides x1
    
    Returns:
    
    true if SageTV should mute the volume when media is played back at speeds besides x1, false otherwise
  - SetMuteOnAlternateSpeedPlayback
```
public void SetMuteOnAlternateSpeedPlayback(boolean Enabled)
```
    Sets whether or not SageTV should mute the sound when media is played back at a speed other than x1
    
    Parameters:
    
    Enabled - true if SageTV should mute the sound when media is played at a speed other x1, false otherwise
  - HasParentalLockCode
```
public boolean HasParentalLockCode()
```
    Returns true if a parental lock code has been configured
    
    Returns:
    
    true if a parental lock code has been configured, false otherwise
  - GetRatingsUnderParentalLock
```
public java.lang.String[] GetRatingsUnderParentalLock()
```
    Gets the list of content ratings that are under parental lock. When any content that has ratings that match anything in the restricted list is requested for playback; the parental lock code must be entered before playback will begin.
    
    Returns:
    
    the list of content ratings that are under parental lock
  - IsRatingUnderParentalLock
```
public boolean IsRatingUnderParentalLock(java.lang.String Rating)
```
    Returns true if the specified rating is in the list that is under parental control
    
    Parameters:
    
    Rating - the rating to check
    
    Returns:
    
    true if the specified rating is in the list that is under parental control, false otherwise
  - GetVideoBackgroundColor
```
public java.awt.Color GetVideoBackgroundColor()
```
    Returns the color that should be used for the video background. This is only shown when the video's aspect ratio doesn't match the area that it's playing back in.
    
    Returns:
    
    the color that should be used for the video background
  - SetVideoBackgroundColor
```
public void SetVideoBackgroundColor(java.awt.Color Color)
```
    Sets the color that should be used for the video background. This is only shown when the video's aspect ratio doesn't match the area that it's playing back in.
    
    Parameters:
    
    Color - the color that should be used for the video background
  - GetVideoOrbitingDuration
```
public long GetVideoOrbitingDuration()
```
    Gets the video orbiting duration in milliseconds. This is used to shift the video left-to-right very slowly over time. It is used on widescreen displays to prevent screen burn when watching 4:3 content.
    
    Returns:
    
    the video orbiting duration in milliseconds
  - SetVideoOrbitingDuration
```
public void SetVideoOrbitingDuration(long Duration)
```
    Sets the video orbiting duration in milliseconds. This is used to shift the video left-to-right very slowly over time. It is used on widescreen displays to prevent screen burn when watching 4:3 content.
    
    Parameters:
    
    Duration - the video orbiting duration in milliseconds
  - GetVideoZoomX
```
public float GetVideoZoomX(java.lang.String AspectRatioMode)
```
    Gets the horizontal scale factor for the video for the specified aspect ratio mode.
    
    Parameters:
    
    AspectRatioMode - the localized name of the aspect ratio mode
    
    Returns:
    
    the horizontal scale factor for the video for the specified aspect ratio mode
  - SetVideoZoomX
```
public void SetVideoZoomX(java.lang.String AspectRatioMode,
                          float ScaleFactor)
```
    Sets the horizontal scale factor for the video for the specified aspect ratio mode.
    
    Parameters:
    
    AspectRatioMode - the localized name of the aspect ratio mode
    
    ScaleFactor - the horizontal scale factor for the video for the specified aspect ratio mode
  - GetVideoZoomY
```
public float GetVideoZoomY(java.lang.String AspectRatioMode)
```
    Gets the vertical scale factor for the video for the specified aspect ratio mode.
    
    Parameters:
    
    AspectRatioMode - the localized name of the aspect ratio mode
    
    Returns:
    
    the vertical scale factor for the video for the specified aspect ratio mode
  - SetVideoZoomY
```
public void SetVideoZoomY(java.lang.String AspectRatioMode,
                          float ScaleFactor)
```
    Sets the vertical scale factor for the video for the specified aspect ratio mode.
    
    Parameters:
    
    AspectRatioMode - the localized name of the aspect ratio mode
    
    ScaleFactor - the vertical scale factor for the video for the specified aspect ratio mode
  - GetVideoOffsetX
```
public int GetVideoOffsetX(java.lang.String AspectRatioMode)
```
    Gets of the offset in pixels that should be applied horizontally to the video. Positive numbers move it to the right.
    
    Parameters:
    
    AspectRatioMode - the localized name of the aspect ratio mode
    
    Returns:
    
    the offset in pixels that should be applied horizontally to the video
  - SetVideoOffsetX
```
public void SetVideoOffsetX(java.lang.String AspectRatioMode,
                            int PixelOffset)
```
    Sets of the offset in pixels that should be applied horizontally to the video. Positive numbers move it to the right.
    
    Parameters:
    
    AspectRatioMode - the localized name of the aspect ratio mode
    
    PixelOffset - the offset in pixels that should be applied horizontally to the video
  - GetVideoOffsetY
```
public int GetVideoOffsetY(java.lang.String AspectRatioMode)
```
    Gets of the offset in pixels that should be applied vertically to the video. Positive numbers move it down.
    
    Parameters:
    
    AspectRatioMode - the localized name of the aspect ratio mode
    
    Returns:
    
    the offset in pixels that should be applied vertically to the video
  - SetVideoOffsetY
```
public void SetVideoOffsetY(java.lang.String AspectRatioMode,
                            int PixelOffset)
```
    Sets of the offset in pixels that should be applied vertically to the video. Positive numbers move it down.
    
    Parameters:
    
    AspectRatioMode - the localized name of the aspect ratio mode
    
    PixelOffset - the offset in pixels that should be applied vertically to the video
  - SetParentalLockCode
```
public void SetParentalLockCode(java.lang.String ParentalLockCode)
```
    Sets the code that is to be used in order to unlock the parental controls.
    
    Parameters:
    
    ParentalLockCode - the new value to set the parental lock code to
  - GetRecordingQualities
```
public java.lang.String[] GetRecordingQualities()
```
    Returns a list of the different recording quality names available in the system
    
    Returns:
    
    a list of the different recording quality names available in the system
  - GetRecordingQualityBitrate
```
public long GetRecordingQualityBitrate(java.lang.String Quality)
```
    Gets the estimated overall bitrate for a given recording quality. The returned value is in Megabits per second.
    
    Parameters:
    
    Quality - the name of the recording quality
    
    Returns:
    
    the estimated overall bitrate for the specified recording quality in Megabits per second
  - GetRecordingQualityFormat
```
public java.lang.String GetRecordingQualityFormat(java.lang.String Quality)
```
    Gets the format for a given recording quality. Returns values like "MPEG-2 PS", "DivX", etc.
    
    Parameters:
    
    Quality - the name of the recording quality
    
    Returns:
    
    the format for the specified recording quality
  - GetVideoDirectories
```
public java.io.File[] GetVideoDirectories()
```
    Gets the list of directories that SageTV is configured to record television to
    
    Returns:
    
    the list of directories that SageTV is configured to record television to
  - GetDiskspaceRuleForVideoDirectory
```
public java.lang.String GetDiskspaceRuleForVideoDirectory(java.io.File Directory)
```
    Returns the diskspace rule that SageTV should use when managing the disk space in a given directory. The names for the rules are localized versions of the strings "Use Only", "Use All" and "Leave Free"
    
    Parameters:
    
    Directory - the video directory to get the diskspace rule for
    
    Returns:
    
    the diskspace rule for the specified video directory
  - GetDiskspaceSizeForVideoDirectory
```
public long GetDiskspaceSizeForVideoDirectory(java.io.File Directory)
```
    Returns the size (in bytes) that should be applied to the specified directory for its configured diskspace rule
    
    Parameters:
    
    Directory - the video directory to get the size for that applies to its rule
    
    Returns:
    
    the size (in bytes) that should be applied to the specified directory for its configured diskspace rule
  - RemoveVideoDirectory
```
public void RemoveVideoDirectory(java.io.File Directory)
```
    Removes a directory from SageTV's list of directories that it can record television to. If you delete all of the directories; SageTV will be unable to record television. This does NOT delete the directory or any of its files from disk. They will still be fully accessible in SageTV.
    
    Parameters:
    
    Directory - the directory that SageTV should no longer record television content to
  - AddVideoDirectory
```
public void AddVideoDirectory(java.lang.String Directory,
                              java.lang.String Rule,
                              long Size)
```
    Adds a new directory to SageTV's list of directories that it can record video to. Also specifies what rule & size to use when managing the diskspace for this directory.
    
    Parameters:
    
    Directory - the directory to add as a video directory
    
    Rule - the diskspace rule to use for this directory see GetVideoDiskspaceRules()
    
    Size - the size to use for the specified diskspace rule and directory
  - ChangeVideoDirectory
```
public void ChangeVideoDirectory(java.io.File OldDirectory,
                                 java.io.File NewDirectory,
                                 java.lang.String NewRule,
                                 long NewSize)
```
    Changes the location of a given video directory, or modifies the diskspace rule or diskspace rule size for a video directory.
    
    Parameters:
    
    OldDirectory - the currently configured path for the video directory that is to have its path or rules modified
    
    NewDirectory - the new file path to use for the video directory (this can be the same as OldDirectory)
    
    NewRule - the diskspace rule to use for this video directory, see GetVideoDiskspaceRules()
    
    NewSize - the size to use for this diskspace rule
  - GetVideoDiskspaceRules
```
public java.lang.String[] GetVideoDiskspaceRules()
```
    Returns the list of valid diskspace rules. Will be localized versions of the strings "Use All", "Use Only" and "Leave Free"
    
    Returns:
    
    the list of valid diskspace rules
  - GetIRCodesLinkedToSageCommand
```
public long[] GetIRCodesLinkedToSageCommand(java.lang.String SageCommand)
```
    Returns the infrared codes that are linked to the given SageTV Command. When one of these IR codes is received; that will cause the specified SageTV Command to get executed.
    
    Parameters:
    
    SageCommand - the SageTV Command for which the IR codes should be retrieved
    
    Returns:
    
    the infrared codes that are linked to the specified SageTV Command
  - GetKeystrokesLinkedToSageCommand
```
public java.lang.String[] GetKeystrokesLinkedToSageCommand(java.lang.String SageCommand)
```
    Returns the keystroke names that are linked to the given SageTV Command. When one of these keystrokes is received; that will cause the specified SageTV Command to get executed.
    
    Parameters:
    
    SageCommand - the SageTV Command for which the keystrokes should be retrieved
    
    Returns:
    
    the keystrokes that are linked to the specified SageTV Command
  - GetNameForIRCode
```
public java.lang.String GetNameForIRCode(long IRCode)
```
    Gets the name that is associated with an IR code. This has no functional purpose and is purely for display purposes.
    
    Parameters:
    
    IRCode - the IRCode to get the associated name for, see SetNameForIRCode()
    
    Returns:
    
    the name for the specified IRCode
  - GetSageCommandLinkedToIRCode
```
public java.lang.String GetSageCommandLinkedToIRCode(long IRCode)
```
    Returns the SageTV Command that is linked to the specified infrared code.
    
    Parameters:
    
    IRCode - the infrared code
    
    Returns:
    
    the SageTV Command that is linked to the specified infrared code
  - GetSageCommandLinkedToKeystroke
```
public java.lang.String GetSageCommandLinkedToKeystroke(java.lang.String Keystroke)
```
    Returns the SageTV Command that is linked to the specified keystroke.
    
    Parameters:
    
    Keystroke - the name of the keystroke
    
    Returns:
    
    the SageTV Command that is linked to the specified keystroke
  - SetNameForIRCode
```
public void SetNameForIRCode(long IRCode,
                             java.lang.String Name)
```
    Sets the name for a given IR code. This has no functional purpose, and is purely for display purposes.
    
    Parameters:
    
    IRCode - the infrared code to attach a name to
    
    Name - the name to attach to the specified infrared code
  - LinkIRCodeToSageCommand
```
public void LinkIRCodeToSageCommand(long IRCode,
                                    java.lang.String SageCommand)
```
    Links an infrared code to a SageTV Command. The specified SageTV Command will then be executed whenever the specified IRCode is received.
    
    Parameters:
    
    IRCode - the infrared code to link to the SageTV Command
    
    SageCommand - the SageTVCommand to link the infrared code to
  - LinkKeystrokeToSageCommand
```
public void LinkKeystrokeToSageCommand(java.lang.String Keystroke,
                                       java.lang.String SageCommand)
```
    Links a keystroke to a SageTV Command. The specified SageTV Command will then be executed whenever the specified keystroke is received.
    
    Parameters:
    
    Keystroke - the name of the keystroke to link to the SageTV Command
    
    SageCommand - the SageTVCommand to link the keystroke to
  - UnlinkIRCodeFromSageCommands
```
public void UnlinkIRCodeFromSageCommands(long IRCode)
```
    Unlinks an infrared code from any SageTV commands it is linked to
    
    Parameters:
    
    IRCode - the infrared code to unlink from any SageTV Commands that it is linked with
  - UnlinkKeystrokeFromSageCommands
```
public void UnlinkKeystrokeFromSageCommands(java.lang.String Keystroke)
```
    Unlinks a keystroke from any SageTV commands it is linked to
    
    Parameters:
    
    Keystroke - the keystroke to unlink from any SageTV Commands that it is linked with
  - SetRatingUnderParentalControl
```
public void SetRatingUnderParentalControl(java.lang.String Rating,
                                          boolean Restricted)
```
    Sets whether or not a given rating should be restricted under parental control
    
    Parameters:
    
    Rating - the name of the rating
    
    Restricted - true if the specified Rating should be restricted by parental control, false otherwise
  - GetInfraredReceiverPort
```
public java.lang.String GetInfraredReceiverPort()
```
    Gets the name of the port that the infrared receiver is connected to.
    
    Returns:
    
    the name of the port that the infrared receiver is connected to; will be a value like: "COM1", "COM2" or "USB"
  - SetInfraredReceiverPort
```
public boolean SetInfraredReceiverPort(java.lang.String Port)
```
    Sets the name of the port that the infrared receiver is connected to.
    
    Parameters:
    
    Port - the name of the port that the infrared receiver is connected to; should be a value like: "COM1", "COM2" or "USB"
    
    Returns:
    
    true on success, false otherwise
  - GetInactivityTimeout
```
public int GetInactivityTimeout()
```
    Gets the inactivity timeout in milliseconds. The hook InactivityTimeout() will be called whenever the system experiences inactivity for this amount of time.
    
    Returns:
    
    the inactivity timeout in milliseconds
  - SetInactivityTimeout
```
public void SetInactivityTimeout(int Timeout)
```
    Sets the inactivity timeout in milliseconds. The hook InactivityTimeout() will be called whenever the system experiences inactivity for this amount of time.
    
    Parameters:
    
    Timeout - the inactivity timeout in milliseconds
  - GetScreenSaverTimeout
```
public int GetScreenSaverTimeout()
```
    Gets the screen saver timeout in milliseconds. The "Screen Saver" menu will be launched after this period of user inactivity if the program is in full screen mode.
    
    Returns:
    
    the screen saver timeout in milliseconds
  - SetScreenSaverTimeout
```
public void SetScreenSaverTimeout(int Timeout)
```
    Sets the screen saver timeout in milliseconds. The "Screen Saver" menu will be launched after this period of user inactivity if the program is in full screen mode.
    
    Parameters:
    
    Timeout - the screen saver timeout in milliseconds
  - IsSageTVServerEnabled
```
public boolean IsSageTVServerEnabled()
```
    Returns true if the SageTV server is enabled. This allows SageTV Clients to connect.
    
    Returns:
    
    true if the SageTV server is enabled, false otherwise
  - SetSageTVServerEnabled
```
public void SetSageTVServerEnabled(boolean Enabled)
```
    Sets whether or not the SageTV server should be enabled. This call will take effect immediately (i.e. the server can be started/stopped on demand)
    
    Parameters:
    
    Enabled - true if the SageTV server should be enabled, false otherwise
  - IsAcceleratedDrawingEnabled
```
public boolean IsAcceleratedDrawingEnabled()
```
    Returns true if 3D acceleration is enabled for the rendering engine. This uses DirectX9-3D on Windows and OpenGL on Linux.
    
    Returns:
    
    true if 3D acceleration is enabled for the rendering engine
  - SetAcceleratedDrawingEnabled
```
public boolean SetAcceleratedDrawingEnabled(boolean Enabled)
```
    Specifies whether or not 3D acceleration should be enabled for the rendering engine. This uses DirectX9 on Windows and OpenGL on Linux. This call takes effect immediately.
    
    Parameters:
    
    Enabled - true if 3D acceleration should be enabled, false otherwise.
    
    Returns:
    
    true if the change succeeded, false otherwise
  - GetOverscanOffsetX
```
public int GetOverscanOffsetX()
```
    Returns the horizontal offset in pixels that should be applied to the UI to account for overscan. This moves the UI to fit on a TV screen in the case where it goes off the edges of the screen due to what is known as 'Overscan'.
    
    Returns:
    
    the horizontal offset in pixles that should be applied to the UI to account for overscan, positive values move it to the right
  - GetOverscanOffsetY
```
public int GetOverscanOffsetY()
```
    Returns the vertical offset in pixels that should be applied to the UI to account for overscan. This moves the UI to fit on a TV screen in the case where it goes off the edges of the screen due to what is known as 'Overscan'.
    
    Returns:
    
    the vertical offset in pixles that should be applied to the UI to account for overscan, positive values move it down
  - GetOverscanScaleWidth
```
public float GetOverscanScaleWidth()
```
    Returns the horizontal scale factor that should be applied to the UI to account for overscan. This shrinks the UI to fit on a TV screen in the case where it goes off the edges of the screen due to what is known as 'Overscan'.
    
    Returns:
    
    the horizontal scale factor that should be applied to the UI to account for overscan
  - GetOverscanScaleHeight
```
public float GetOverscanScaleHeight()
```
    Returns the vertical scale factor that should be applied to the UI to account for overscan. This shrinks the UI to fit on a TV screen in the case where it goes off the edges of the screen due to what is known as 'Overscan'.
    
    Returns:
    
    the vertical scale factor that should be applied to the UI to account for overscan
  - SetOverscanOffsetX
```
public void SetOverscanOffsetX(int Amount)
```
    Sets the horizontal offset in pixels that should be applied to the UI to account for overscan. This moves the UI to fit on a TV screen in the case where it goes off the edges of the screen due to what is known as 'Overscan'.
    
    Parameters:
    
    Amount - the horizontal offset in pixles that should be applied to the UI to account for overscan, positive values move it to the right
  - SetOverscanOffsetY
```
public void SetOverscanOffsetY(int Amount)
```
    Sets the vertical offset in pixels that should be applied to the UI to account for overscan. This moves the UI to fit on a TV screen in the case where it goes off the edges of the screen due to what is known as 'Overscan'.
    
    Parameters:
    
    Amount - the vertical offset in pixles that should be applied to the UI to account for overscan, positive values move it down
  - SetOverscanScaleWidth
```
public void SetOverscanScaleWidth(float Amount)
```
    Sets the horizontal scale factor that should be applied to the UI to account for overscan. This shrinks the UI to fit on a TV screen in the case where it goes off the edges of the screen due to what is known as 'Overscan'.
    
    Parameters:
    
    Amount - the horizontal scale factor that should be applied to the UI to account for overscan
  - SetOverscanScaleHeight
```
public void SetOverscanScaleHeight(float Amount)
```
    Sets the vertical scale factor that should be applied to the UI to account for overscan. This shrinks the UI to fit on a TV screen in the case where it goes off the edges of the screen due to what is known as 'Overscan'.
    
    Parameters:
    
    Amount - the vertical scale factor that should be applied to the UI to account for overscan
  - GetOverscanInsetLeft
```
public float GetOverscanInsetLeft()
```
    Returns a floating point value which specifies the percent of the UI that is taken up by overscan on the left side. Equivalent to (GetOverscanOffsetX() * 1.0 / (GetFullUIWidth() * GetOverscanScaleWidth()))
    
    Returns:
    
    a floating point value which specifies the percent of the UI that is taken up by overscan on the left side
    
    Since:
    
    7.0
  - GetOverscanInsetRight
```
public float GetOverscanInsetRight()
```
    Returns a floating point value which specifies the percent of the UI that is taken up by overscan on the right side. Equivalent to (1.0 - (GetOverscanOffsetX() * 1.0 / GetFullUIWidth()) - GetOverscanScaleWidth())/GetOverscanScaleWidth()
    
    Returns:
    
    a floating point value which specifies the percent of the UI that is taken up by overscan on the right side
    
    Since:
    
    7.0
  - GetOverscanInsetTop
```
public float GetOverscanInsetTop()
```
    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())))
    
    Returns:
    
    a floating point value which specifies the percent of the UI that is taken up by overscan on the top
    
    Since:
    
    7.0
  - GetOverscanInsetBottom
```
public float GetOverscanInsetBottom()
```
    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()
    
    Returns:
    
    a floating point value which specifies the percent of the UI that is taken up by overscan on the bottom
    
    Since:
    
    7.0
  - GetOverscanInsets
```
public java.lang.Float[] GetOverscanInsets()
```
    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. The order is top, left, bottom, right in the returned array. Each value comes from GetOverscanInsetTop/Left/Bottom/Right() API calls.
    
    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
    
    Since:
    
    7.0
  - GetAvailableCountries
```
public java.lang.String[] GetAvailableCountries()
```
    Gets the names of the countries that can be used in the SetCountry() call.
    
    Returns:
    
    the possible names for country selection
  - SetCountry
```
public java.lang.String SetCountry(java.lang.String Country)
```
    Sets the country that the user is in. This is used for determining the frequencies used for tuning television signals.
    
    Parameters:
    
    Country - the name of the country the user is in, should be a value from GetAvailableCountries()
    
    Returns:
    
    the passed in Country variable
  - GetCountry
```
public java.lang.String GetCountry()
```
    Gets the country that SageTV is configured for. This is used for determining the frequencies used for tuning television signals.
    
    Returns:
    
    the name of the country that SageTV is configured for
  - SetAnalogVideoFormat
```
public void SetAnalogVideoFormat(java.lang.String Format)
```
    Sets the analog video format that should be used for capture and playback. Valid values are "NTSC" or "PAL"
    
    Parameters:
    
    Format - the analog video format that should be used for capture and playback; valid values are "NTSC" or "PAL"
  - GetAnalogVideoFormat
```
public java.lang.String GetAnalogVideoFormat()
```
    Gets the analog video format that should be used for capture and playback. Valid values are "NTSC" or "PAL"
    
    Returns:
    
    the analog video format that should be used for capture and playback
  - GetUILanguage
```
public java.lang.String GetUILanguage()
```
    Gets the language that the user interface should be displayed in.
    
    Returns:
    
    the language that the user interface should be displayed in
  - SetUILanguage
```
public void SetUILanguage(java.lang.String Language)
```
    Sets the language that the user interface should be displayed in. This takes effect immediately. Use the GetAvailableUILanguages() call to get the options for this.
    
    Parameters:
    
    Language - the language that the user interface should be displayed in
  - GetAvailableUILanguages
```
public java.lang.String[] GetAvailableUILanguages()
```
    Gets the list of languages that are available to be used for the user interface.
    
    Returns:
    
    the list of languages that are available to be used for the user interface
  - GetSubpicAudioLanguageOptions
```
public java.lang.String[] GetSubpicAudioLanguageOptions()
```
    Gets the list of languages that are available to be used as presets for Audio tracks or Subpicture.
    
    Returns:
    
    the list of languages that are available to be used as presets for Audio tracks or Subpicture.
  - GetDefaultAudioLanguage
```
public java.lang.String GetDefaultAudioLanguage()
```
    Gets the name of the preferred default language when selecting which audio stream to playback.
    
    Returns:
    
    the name of the preferred default language when selecting which audio stream to playback
  - SetDefaultAudioLanguage
```
public void SetDefaultAudioLanguage(java.lang.String Language)
```
    Sets the name of the preferred default language when selecting which audio stream to playback. The values for this should be obtained from GetSubpicAudioLanguageOptions.
    
    Parameters:
    
    Language - the name of the preferred default language when selecting which audio stream to playback
  - GetDefaultSubpicLanguage
```
public java.lang.String GetDefaultSubpicLanguage()
```
    Gets the name of the preferred default language when selecting which subpicture stream to playback. This will be the empty string if subtitles are preferred to be off by default.
    
    Returns:
    
    the name of the preferred default language when selecting which subpicture stream to playback or the empty string for no subtitles
  - SetDefaultSubpicLanguage
```
public void SetDefaultSubpicLanguage(java.lang.String Language)
```
    Sets the name of the preferred default language when selecting which subpicture stream to playback. The values for this should be obtained from GetSubpicAudioLanguageOptions, the value of null or the empty string is also allowed to indicate no subtitle track should be selected by default.
    
    Parameters:
    
    Language - the name of the preferred default language when selecting which subpicture stream to playback, null or the empty string can be used to prefer no subtitles
  - GetTimeZone
```
public java.lang.String GetTimeZone()
```
    Gets the name of the time zone that the application is currently configured to use
    
    Returns:
    
    the name of the time zone that the application is currently configured to use
  - SetTimeZone
```
public void SetTimeZone(java.lang.String TimeZone)
```
    Sets the name of the time zone that the application should use. This takes effect immediately.
    
    Parameters:
    
    TimeZone - the name of the time zone to use, see GetAllTimeZones()
  - GetAllTimeZones
```
public java.util.Vector GetAllTimeZones()
```
    Gets the list of all of the valid time zone names
    
    Returns:
    
    the list of all of the valid time zone names
  - GetDVBTRegions
```
public java.lang.String[] GetDVBTRegions()
```
    Gets the names of the regions for the configured country which are used for dividing it up into different areas for DVB-T reception. Returns a zero-length list if there are no sub-regions within the country. Use the results from this in a call to SetDVBTRegion(DVBTRegion)
    
    Returns:
    
    the region names in the country to use for DVBT reception differentiation
    
    Since:
    
    5.1
  - SetDVBTRegion
```
public void SetDVBTRegion(java.lang.String DVBTRegion)
```
    Sets the the region within the current country that the user is in.
    
    Parameters:
    
    DVBTRegion - the name of the region the user is in, should be a value from GetDVBTRegions()
    
    Since:
    
    5.1
  - GetDVBTRegion
```
public java.lang.String GetDVBTRegion()
```
    Gets the the region within the current country that the user is in for DVB-T tuning purposes. Must have been set with a call to SetDVBTRegion(DVBTRegion)
    
    Returns:
    
    the name of the region the user is in
    
    Since:
    
    5.1
  - GetDVBCRegions
```
public java.lang.String[] GetDVBCRegions()
```
    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. Returns a zero-length list if there are one or no providers in this country. Use the results from this in a call to SetDVBCRegion(DVBCRegion)
    
    Returns:
    
    the provider names in the country to use for DVBC reception differentiation
    
    Since:
    
    5.1
  - SetDVBCRegion
```
public void SetDVBCRegion(java.lang.String DVBCRegion)
```
    Sets the the provider within the current country that the user has for DVBC reception.
    
    Parameters:
    
    DVBCRegion - the name of the provider the user has, should be a value from GetDVBCRegions()
    
    Since:
    
    5.1
  - GetDVBCRegion
```
public java.lang.String GetDVBCRegion()
```
    Gets the the provider within the current country that the user has for DVB-C tuning purposes. Must have been set with a call to SetDVBCRegion(DVBCRegion)
    
    Returns:
    
    the name of the provider the user has for DVB-C
    
    Since:
    
    5.1
  - GetDVBSRegions
```
public java.lang.String[] GetDVBSRegions()
```
    Gets the names of the providers for the configured country which are used for dividing it up into different areas for DVB-S reception. Returns a zero-length list if there are one or no providers within the country. Use the results from this in a call to SetDVBSRegion(DVBSRegion)
    
    Returns:
    
    the providers names in the country to use for DVBS reception differentiation
    
    Since:
    
    5.1
  - SetDVBSRegion
```
public void SetDVBSRegion(java.lang.String DVBSRegion)
```
    Sets the the provider within the current country that the user has for DVBS reception.
    
    Parameters:
    
    DVBSRegion - the name of the provider the user has, should be a value from GetDVBSRegions()
    
    Since:
    
    5.1
  - GetDVBSRegion
```
public java.lang.String GetDVBSRegion()
```
    Gets the the provider within the current country that the user has for DVB-S tuning purposes. Must have been set with a call to SetDVBSRegion(DVBSRegion)
    
    Returns:
    
    the name of the provider the user has for DVB-S
    
    Since:
    
    5.1
  - CanDoNativeOutputResolution
```
public boolean CanDoNativeOutputResolution()
```
    Returns true if this device can do native output resolutions (where output resolution matches the format of the media being played)
    
    Returns:
    
    true if this device can do native output resolutions
    
    Since:
    
    6.3
  - IsNativeOutputResolutionEnabled
```
public boolean IsNativeOutputResolutionEnabled()
```
    Returns true if this device is configured to match the output resolution to the media format's resolution
    
    Returns:
    
    true if this device is configured to match the output resolution to the media format's resolution
    
    Since:
    
    6.3
  - SetNativeOutputResolutionEnabled
```
public void SetNativeOutputResolutionEnabled(boolean Enabled)
```
    Sets whether or not this device should try to match its output resolution to the media format's resolution
    
    Parameters:
    
    Enabled - true if this device should be configured to match the output resolution to the media format's resolution; false to use a fixed resolution
    
    Since:
    
    6.3
  - GetAudioOutput
```
public java.lang.String GetAudioOutput()
```
    Returns a string describing the currently selected audio output (empty string if this can't be configured)
    
    Returns:
    
    a string describing the currently selected audio output (empty string if this can't be configured)
    
    Since:
    
    6.3
  - GetAudioOutputOptions
```
public java.lang.String[] GetAudioOutputOptions()
```
    Returns a list of the possible audio outputs. This is currently only used on media extender devices that have adjustable audio outputs.
    
    Returns:
    
    an array of the audio outputs that can be used, null if this change is not supported
    
    Since:
    
    6.3
  - SetAudioOutput
```
public void SetAudioOutput(java.lang.String AudioOutput)
```
    Sets the current audio output. This is currently only used on media extender devices that have configurable audio outputs.
    
    Parameters:
    
    AudioOutput - this must be a value from GetAudioOutputOptions() and should be the new desired audio output
    
    Since:
    
    6.3
  - GetHDMIAutodetectedConnector
```
public java.lang.String GetHDMIAutodetectedConnector()
```
    Returns a string describing the type of connection autodetected on HDMI (currently only used on media extenders)
    
    Returns:
    
    a string describing the type of connection autodetected on HDMI (empty string if this isn't supported)
    
    Since:
    
    6.3
  - IsAdvancedDeinterlacingSupported
```
public boolean IsAdvancedDeinterlacingSupported()
```
    Returns true if the client supports doing advanced deinterlacing. This is only available on the HD300.
    
    Returns:
    
    true if the client supports doing advanced deinterlacing, false otherwise
  - IsAdvancedDeinterlacingEnabled
```
public boolean IsAdvancedDeinterlacingEnabled()
```
    Returns true if the client supports doing advanced deinterlacing and it is enabled. This is only available on the HD300.
    
    Returns:
    
    true if the client supports doing advanced deinterlacing and it is enabled, false otherwise
  - SetAdvancedDeinterlacingEnabled
```
public void SetAdvancedDeinterlacingEnabled(boolean Enabled)
```
    Allows enabling/disabling of advanced deinterlacing support. This is only available on the HD300.
    
    Parameters:
    
    Enabled - true if advanced deinterlacing should be enabled, false if it should be disabled
  - RunFilterAutoconfiguration
```
public void RunFilterAutoconfiguration()
```
    Deprecated.
    
    Sets the DirectShow audio & video decoders on windows to acceptable values
  - GetDXVAMpegMode
```
public java.lang.String GetDXVAMpegMode()
```
    Gets the preferred DXVA MPEG Mode configuration setting (Windows only). This will be A, B, C or D (or Default if not set) This is used when playing back MPEG2 files.
    
    Returns:
    
    the preferred DXVA MPEG Mode configuration setting
  - SetDXVAMpegMode
```
public void SetDXVAMpegMode(java.lang.String DXVAMode)
```
    Sets the preferred DXVA MPEG Mode configuration setting (Windows only). This will be A, B, C or D. This is used when playing back MPEG2 files.
    
    Parameters:
    
    DXVAMode - the preferred DXVA MPEG Mode configuration setting, use the empty string or "Default" to disable this
  - GetDVDDXVAMpegMode
```
public java.lang.String GetDVDDXVAMpegMode()
```
    Gets the preferred DXVA MPEG Mode configuration setting (Windows only). This will be A, B, C or D (or Default if not set) This is used when playing back DVDs.
    
    Returns:
    
    the preferred DXVA MPEG Mode configuration setting
  - SetDVDDXVAMpegMode
```
public void SetDVDDXVAMpegMode(java.lang.String DXVAMode)
```
    Sets the preferred DXVA MPEG Mode configuration setting (Windows only). This will be A, B, C or D. This is used when playing back DVDs.
    
    Parameters:
    
    DXVAMode - the preferred DXVA MPEG Mode configuration setting, use the empty string or "Default" to disable this
  - GetDXVAMpegModes
```
public java.lang.String[] GetDXVAMpegModes()
```
    Gets the list of available DXVA MPEG Modes. This will return {"A", "B", "C", "D"}
    
    Returns:
    
    the list of available DXVA MPEG Modes: {"A", "B", "C", "D"}
  - GetDXVADeinterlaceMode
```
public java.lang.String GetDXVADeinterlaceMode()
```
    Gets the preferred DXVA Deinterlacing configuration setting (Windows only). This is used when playing back MPEG2 files.
    
    Returns:
    
    the preferred DXVA Deinterlacing configuration setting
  - SetDXVADeinterlaceMode
```
public void SetDXVADeinterlaceMode(java.lang.String DeinterlaceMode)
```
    Sets the preferred DXVA Deinterlacing configuration setting (Windows only). This is used when playing back MPEG2 files.
    
    Parameters:
    
    DeinterlaceMode - the preferred DXVA Deinterlacing configuration setting
  - GetDVDDXVADeinterlaceMode
```
public java.lang.String GetDVDDXVADeinterlaceMode()
```
    Gets the preferred DXVA Deinterlacing configuration setting (Windows only). This is used when playing back DVDs.
    
    Returns:
    
    the preferred DXVA Deinterlacing configuration setting
  - SetDVDDXVADeinterlaceMode
```
public void SetDVDDXVADeinterlaceMode(java.lang.String DeinterlaceMode)
```
    Sets the preferred DXVA Deinterlacing configuration setting (Windows only). This is used when playing back DVDs.
    
    Parameters:
    
    DeinterlaceMode - the preferred DXVA Deinterlacing configuration setting
  - GetDXVADeinterlaceModes
```
public java.lang.String[] GetDXVADeinterlaceModes()
```
    Gets the list of potential DXVA Deinterlacing Capabilities (Widows only)
    
    Returns:
    
    the list of potential DXVA Deinterlacing Capabilities
  - GetDscalerMode
```
public java.lang.String GetDscalerMode()
```
    Gets the mode that DScaler is currently configured to run in when it is used (Windows only)
    
    Returns:
    
    the mode that DScaler is currently configured to run in when it is used
  - SetDscalerMode
```
public void SetDscalerMode(java.lang.String DscalerMode)
```
    Sets the mode that DScaler should be configured to run in when it is used (Windows only)
    
    Parameters:
    
    DscalerMode - the mode that DScaler should be configured to run in when it is used
  - GetDscalerModes
```
public java.lang.String[] GetDscalerModes()
```
    Gets the list of the available modes that DScaler can be run in
    
    Returns:
    
    the list of the available modes that DScaler can be run in
  - GetAudioDecoderFilter
```
public java.lang.String GetAudioDecoderFilter()
```
    Gets the name of the DirectShow audio decoder filter that's used for MPEG2 playback (Windows only)
    
    Returns:
    
    the name of the DirectShow audio decoder filter that's used for MPEG2 playback
  - SetAudioDecoderFilter
```
public void SetAudioDecoderFilter(java.lang.String FilterName)
```
    Sets the name of the DirectShow audio decoder filter that's used for MPEG2 playback (Windows only)
    
    Parameters:
    
    FilterName - the name of the DirectShow audio decoder filter to use for MPEG2 playback
  - GetDVDAudioDecoderFilter
```
public java.lang.String GetDVDAudioDecoderFilter()
```
    Gets the name of the DirectShow audio decoder filter that's used for DVD playback (Windows only)
    
    Returns:
    
    the name of the DirectShow audio decoder filter that's used for DVD playback
  - SetDVDAudioDecoderFilter
```
public void SetDVDAudioDecoderFilter(java.lang.String FilterName)
```
    Sets the name of the DirectShow audio decoder filter that's used for DVD playback (Windows only)
    
    Parameters:
    
    FilterName - the name of the DirectShow audio decoder filter to use for DVD playback
  - GetAudioRenderFilter
```
public java.lang.String GetAudioRenderFilter()
```
    Gets the name of the DirectShow audio renderer filter that's used for all playback except DVDs (Windows only)
    
    Returns:
    
    the name of the DirectShow audio renderer filter that's used for playback except DVDs
  - SetAudioRenderFilter
```
public void SetAudioRenderFilter(java.lang.String FilterName)
```
    Sets the name of the DirectShow audio renderer filter that's used for playback except DVDs (Windows only)
    
    Parameters:
    
    FilterName - the name of the DirectShow audio renderer filter to use for playback except DVDs
  - GetDVDAudioRenderFilter
```
public java.lang.String GetDVDAudioRenderFilter()
```
    Gets the name of the DirectShow audio renderer filter that's used for DVD playback (Windows only)
    
    Returns:
    
    the name of the DirectShow audio renderer filter that's used for DVD playback
  - SetDVDAudioRenderFilter
```
public void SetDVDAudioRenderFilter(java.lang.String FilterName)
```
    Sets the name of the DirectShow audio renderer filter that's used for DVD playback (Windows only)
    
    Parameters:
    
    FilterName - the name of the DirectShow audio renderer filter to use for DVD playback
  - GetDVDVideoRenderFilter
```
public java.lang.String GetDVDVideoRenderFilter()
```
    Gets the video renderer filter that should be used for DVD playback. Possible values are "VMR9", "Overlay" and the localized "Default" string
    
    Returns:
    
    the video renderer filter that should be used for DVD playback
  - SetDVDVideoRenderFilter
```
public void SetDVDVideoRenderFilter(java.lang.String FilterName)
```
    Sets the video renderer filter that should be used for DVD playback. Possible values are "VMR9", "Overlay" and the localized "Default" string
    
    Parameters:
    
    FilterName - the video renderer filter that should be used for DVD playback
  - GetVideoDecoderFilter
```
public java.lang.String GetVideoDecoderFilter()
```
    Gets the name of the DirectShow video decoder filter that's used for MPEG2 playback (Windows only)
    
    Returns:
    
    the name of the DirectShow video decoder filter that's used for MPEG2 playback
  - SetVideoDecoderFilter
```
public void SetVideoDecoderFilter(java.lang.String FilterName)
```
    Sets the name of the DirectShow video decoder filter that's used for MPEG2 playback (Windows only)
    
    Parameters:
    
    FilterName - the name of the DirectShow video decoder filter to use for MPEG2 playback
  - GetDVDVideoDecoderFilter
```
public java.lang.String GetDVDVideoDecoderFilter()
```
    Gets the name of the DirectShow video decoder filter that's used for DVD playback (Windows only)
    
    Returns:
    
    the name of the DirectShow video decoder filter that's used for DVD playback
  - SetDVDVideoDecoderFilter
```
public void SetDVDVideoDecoderFilter(java.lang.String FilterName)
```
    Sets the name of the DirectShow video decoder filter that's used for DVD playback (Windows only)
    
    Parameters:
    
    FilterName - the name of the DirectShow video decoder filter to use for DVD playback
  - GetAudioDelay
```
public int GetAudioDelay()
```
    Gets the audio delay in milliseconds to apply when playing back MPEG2 files (Windows only)
    
    Returns:
    
    the audio delay in milliseconds to apply when playing back MPEG2 files
  - SetAudioDelay
```
public void SetAudioDelay(int Delay)
```
    Sets the audio delay in milliseconds to apply when playing back MPEG2 files (Windows only)
    
    Parameters:
    
    Delay - the audio delay in milliseconds to apply when playing back MPEG2 files
  - GetAudioDecoderFilters
```
public java.lang.String[] GetAudioDecoderFilters()
```
    Gets the list of the audio decoder filters that are available in the system for MPEG2 playback (Windows only)
    
    Returns:
    
    the list of the audio decoder filters that are available in the system for MPEG2 playback
  - GetVideoDecoderFilters
```
public java.lang.String[] GetVideoDecoderFilters()
```
    Gets the list of the video decoder filters that are available in the system for MPEG2 playback (Windows only)
    
    Returns:
    
    the list of the video decoder filters that are available in the system for MPEG2 playback
  - IsSoftwareDecodingDisabled
```
public boolean IsSoftwareDecodingDisabled()
```
    Returns true if software decoding is disabled. This only applies to the TV output of the Hauppauge WinTV PVR-350 PCI card on Windows
    
    Returns:
    
    true if software decoding is disabled
  - SetSoftwareDecodingDisabled
```
public void SetSoftwareDecodingDisabled(boolean Disabled)
```
    Sets if software decoding is disabled. This only applies to the TV output of the Hauppauge WinTV PVR-350 PCI card on Windows
    
    Parameters:
    
    Disabled - true if software decoding is disabled
  - IsDscalerDoubleRefresh
```
public boolean IsDscalerDoubleRefresh()
```
    Returns true if DScaler is set to double the refresh rate when used. This means it'll run at 60fps instead of 30fps.
    
    Returns:
    
    true if DScaler is set to double the refresh rate when used.
  - SetDscalerDoubleRefresh
```
public void SetDscalerDoubleRefresh(boolean Enabled)
```
    Sets whether or not DScaler should double the refresh rate. This means it'll run at 60fps instead of 30fps.
    
    Parameters:
    
    Enabled - true if DScaler should double the refresh rate when used, false otherwise
  - IsDscalerOddFieldFirst
```
public boolean IsDscalerOddFieldFirst()
```
    Returns true if DScaler is configured to display the odd field first (fields are even or odd)
    
    Returns:
    
    true if DScaler is configured to display the odd field first
  - SetDscalerOddFieldFirst
```
public void SetDscalerOddFieldFirst(boolean Enabled)
```
    Sets if DScaler should display the odd field first (fields are even or odd)
    
    Parameters:
    
    Enabled - true if DScaler should display the odd field first
  - HasPVR350TVOutput
```
public boolean HasPVR350TVOutput()
```
    Returns true if the system has a Hauppauge WinTV PVR-350 card installed which can produce a TV output (Windows only)
    
    Returns:
    
    true if the system has a Hauppauge WinTV PVR-350 card installed which can produce a TV output
  - IsPVR350TVOutputEnabled
```
public boolean IsPVR350TVOutputEnabled()
```
    Returns true if the TV output on a Hauppauge WinTV PVR-350 card is enabled (Windows only)
    
    Returns:
    
    true if the TV output on a Hauppauge WinTV PVR-350 card is enabled
  - SetPVR350TVOutputEnabled
```
public void SetPVR350TVOutputEnabled(boolean Enabled)
```
    Sets whether or not the TV output on a Hauppauge WinTV PVR-350 should be enabled (Windows only)
    
    Parameters:
    
    Enabled - true if the TV output of a Hauppauge WinTV PVR-350 should be enabled
  - IsPVR350OSDEnabled
```
public boolean IsPVR350OSDEnabled()
```
    Returns true if the user interface (OSD) display on a Hauppauge WinTV PVR-350 should be shown through the tv output (Windows only)
    
    Returns:
    
    true if the user interface (OSD) display on a Hauppauge WinTV PVR-350 should be shown through the tv output
  - SetPVR350OSDEnabled
```
public void SetPVR350OSDEnabled(boolean Enabled)
```
    Sets whether or not the user interface (OSD) should be displayed on the TV output of a Hauppauge WinTV PVR-350 (Windows only)
    
    Parameters:
    
    Enabled - true if the user interface (OSD) should be displayed on the TV output of a Hauppauge WinTV PVR-350, false otherwise
  - IsDscalerEnabled
```
public boolean IsDscalerEnabled()
```
    Returns true if the DScaler deinterlacing filter is enabled (Windows only)
    
    Returns:
    
    true if the DScaler deinterlacing filter is enabled
  - SetDscalerEnabled
```
public void SetDscalerEnabled(boolean Enabled)
```
    Sets whether or not the DScaler deinterlacing filter should be used (Windows only)
    
    Parameters:
    
    Enabled - true if the DScaler deinterlacing filter should be used, false otherwise
  - GetDscalerPlugin
```
public java.lang.String GetDscalerPlugin()
```
    Gets the plugin that DScaler is currently configured to use when it is in "Plugin" mode.
    
    Returns:
    
    the plugin that DScaler is currently configured to use when it is in "Plugin" mode
  - SetDscalerPlugin
```
public void SetDscalerPlugin(java.lang.String PluginName)
```
    Sets the plugin that should be used by DScaler. DScaler must also be set into "Plugin" mode.
    
    Parameters:
    
    PluginName - the name of the plugin to use with DScaler
  - GetDscalerPlugins
```
public java.lang.String[] GetDscalerPlugins()
```
    Returns the list of plugins that are supported by DScaler. These are used when DScaler is in "Plugin" mode. (Windows only)
    
    Returns:
    
    the list of plugins that are supported by DScaler
  - HasDirectX9
```
public boolean HasDirectX9()
```
    Returns true if the system has DirectX 9 installed (Windows Only)
    
    Returns:
    
    true if the system has DirectX 9 installed, false otherwise
  - HasEVRSupport
```
public boolean HasEVRSupport()
```
    Returns true if the system has support for the Enhanced Video Renderer (EVR) (Windows Only)
    
    Returns:
    
    true if the system has support for the Enhanced Video Renderer (EVR), false otherwise
  - IsVideoRendererOverlay
```
public boolean IsVideoRendererOverlay()
```
    Returns true if the video renderer is configured to use the Overlay surface (Windows Only) Applies to all files except DVDs.
    
    Returns:
    
    true if the video renderer is configured to use the Overlay surface, false otherwise
  - IsVideoRendererVMR9
```
public boolean IsVideoRendererVMR9()
```
    Returns true if the video renderer is configured to use the Video Mixing Renderer 9 (Windows Only). This will only work if accelerated rendering is enabled (3D acceleration). If it's not then Overlay will be used as the video renderer instead of VMR9. Applies to all files except DVDs.
    
    Returns:
    
    true if the video renderer is configured to use VMR9, false otherwise
  - IsVideoRendererEVR
```
public boolean IsVideoRendererEVR()
```
    Returns true if the video renderer is configured to use the Enhanced Video Renderer (Windows Only). This will only work if accelerated rendering is enabled (3D acceleration). If it's not then Overlay will be used as the video renderer instead of EVR. Applies to all files except DVDs.
    
    Returns:
    
    true if the video renderer is configured to use EVR, false otherwise
    
    Since:
    
    6.5
  - IsVideoRendererDefault
```
public boolean IsVideoRendererDefault()
```
    Returns true if the video renderer is configured to use the Default renderer (Windows Only). This will usually be the Video Mixing Renderer 7 if using Windows XP; but DirectShow ultimately decides this itself. Applies to all files except DVDs.
    
    Returns:
    
    true if the video renderer is configured to use the Default renderer
  - SetVideoRendererToDefault
```
public void SetVideoRendererToDefault()
```
    Sets the video renderer to use the default renderer (Windows Only). This will usually be the Video Mixing Renderer 7 if using Windows XP; but DirectShow ultimately decides this itself. Applies to all files except DVDs.
  - SetVideoRendererToOverlay
```
public void SetVideoRendererToOverlay()
```
    Sets the video renderer to use the video Overlay surface (Windows Only). Applies to all files except DVDs.
  - SetVideoRendererToVMR9
```
public void SetVideoRendererToVMR9()
```
    Sets the video renderer to use the Video Mixing Renderer 9 (Windows Only). This will only work if accelerated rendering is enabled (3D acceleration). If it's not then Overlay will be used as the video renderer instead of VMR9. Applies to all files except DVDs.
  - SetVideoRendererToEVR
```
public void SetVideoRendererToEVR()
```
    Sets the video renderer to use the Enhanced Video Renderer (Windows Only). This will only work if accelerated rendering is enabled (3D acceleration). If it's not then Overlay will be used as the video renderer instead of EVR. Applies to all files except DVDs.
    
    Since:
    
    6.5
  - GetAudioRendererFilters
```
public java.util.Vector GetAudioRendererFilters()
```
    Gets the list of DirectShow audio renderer filters that are available on the system (Windows Only).
    
    Returns:
    
    the list of DirectShow audio renderer filters that are available on the system
  - GetMixerAudioInputPaths
```
public java.lang.String[] GetMixerAudioInputPaths()
```
    Gets the different input connectors that are available on the system sound mixer (Windows Only)
    
    Returns:
    
    the different input connectors that are available on the system sound mixer
  - SetAllowPlaceshifterLoginCaching
```
public void SetAllowPlaceshifterLoginCaching(boolean Enabled)
```
    Sets whether or not placeshifter connections should be allowed to cache their login information. Disabling this setting will clear the current authentication cache on the server.
    
    Parameters:
    
    Enabled - true if the server should allow caching of placeshifter logins; false otherwise (false also clears the cache)
    
    Since:
    
    6.6
  - IsPlaceshifterLoginCachingAllowed
```
public boolean IsPlaceshifterLoginCachingAllowed()
```
    Returns true if this server allows caching of placeshifter logins, false otherwise
    
    Returns:
    
    true if this server allows caching of placeshifter logins, false otherwise
    
    Since:
    
    6.6
  - SetCurrentlyAiringProgramsStartLive
```
public void SetCurrentlyAiringProgramsStartLive(boolean Enabled)
```
    Sets whether or not when playing back a program that is currently airing whether we should start from live TV or not
    
    Parameters:
    
    Enabled - true if we should start from live for anything currently airing
    
    Since:
    
    8.1
  - GetCurrentlyAiringProgramsStartLive
```
public boolean GetCurrentlyAiringProgramsStartLive()
```
    Returns true if the system is configured to start any program that is currently airing from live, false otherwise
    
    Returns:
    
    true if the system is configured to start any program that is currently airing from live, false otherwise
    
    Since:
    
    8.1

Class Configuration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Configuration

Method Detail

SaveProperties

GetLibraryImportPaths

GetPictureLibraryImportPaths

GetMusicLibraryImportPaths

GetVideoLibraryImportPaths

IsMajorMinorDTVChannelTuningEnabled

GetAutodialForInternet

SetAutodialForInternet

IsProvideoPentium4FixEnabled

SetProvideoPentium4FixEnabled

GetInfraredTuningPlugins

GetRemotesForInfraredTuningPlugin

AddRemoteForInfraredTuningPlugin

LearnCommandForInfraredTuningPlugin

RenameCommandForInfraredTuningPlugin

RemoveRemoteForInfraredTuningPlugin

RemoveCommandForInfraredTuningPlugin

SetMaxChannelDigitsForInfraredTuningPlugin

GetMaxChannelDigitsForInfraredTuningPlugin

SetButtonDelayForInfraredTuningPlugin

GetButtonDelayForInfraredTuningPlugin

SetSequenceDelayForInfraredTuningPlugin

GetSequenceDelayForInfraredTuningPlugin

SetConfirmCommandForInfraredTuningPlugin

SetPrefixCommandForInfraredTuningPlugin

GetConfirmCommandForInfraredTuningPlugin

GetPrefixCommandForInfraredTuningPlugin

GetCarrierFrequencyForInfraredTuningPlugin

GetBitTimeForInfraredTuningPlugin

GetCommandsForInfraredTuningPlugin

GetSubpropertiesThatAreBranches

GetSubpropertiesThatAreLeaves

GetServerSubpropertiesThatAreBranches

GetServerSubpropertiesThatAreLeaves

GetProperty

SetProperty

GetServerProperty

SetServerProperty

RemoveProperty

RemovePropertyAndChildren

RemoveServerProperty

RemoveServerPropertyAndChildren

GetDefaultRecordingQuality

IsIntelligentRecordingDisabled

AddLibraryImportPath

AddPictureLibraryImportPath

AddMusicLibraryImportPath

AddVideoLibraryImportPath

RemoveLibraryImportPath

RemovePictureLibraryImportPath

RemoveMusicLibraryImportPath

RemoveVideoLibraryImportPath

SetDefaultRecordingQuality

SetIntelligentRecordingDisabled

SetMajorMinorDTVChannelTuningEnabled

IsScreenSaverOnSleepEnabled

SetScreenSaverOnSleepEnabled

IsSyncSystemClockWithServerEnabled

SetSyncSystemClockWithServerEnabled

GetAspectRatioMode

SetAspectRatioMode

GetAspectRatioModes

GetDisplayAspectRatio

SetDisplayAspectRatio

IsParentalControlEnabled

SetParentalControlEnabled

IsMutedOnAlternateSpeedPlayback

SetMuteOnAlternateSpeedPlayback

HasParentalLockCode

GetRatingsUnderParentalLock

IsRatingUnderParentalLock

GetVideoBackgroundColor

SetVideoBackgroundColor