banner logo

Index of Constants

These string contants are passed as parameter values within Remote Potato's API objects.
EPG
TVProgrammeType
Purpose:
Represents a genre of TV Programme
Possible Values:
None
Sport
News
Movie
Documentary
Kids
All
ThumbnailSizes
Purpose:
Represents a size of thumbnail
Possible Values:
Small
Medium
Large
ExtraLarge
Recording
RecordingRequestType
Purpose:
Represents a type of recording request
Possible Values:
Manual
OneTime
Series
Unknown
SeriesRequestSubTypes
Purpose:
Represents a type of series recording request
Possible Values:
ThisChannelThisTime,
ThisChannelAnyTime
AnyChannelAnyTime
KeepUntilTypes
Purpose:
Represents the time for which the Media Center keeps a recorded TV programme before deletion.
Possible Values:
UntilUserWatched
UntilUserDeletes
UntilEligible
OneWeek
LatestEpisodes
NotSet
Notes:
The LatestEpisodes value is used in conjunction with the KeepNumberOfEpisodes parameter of a RecordingRequest object to indicate how many of the latest episodes should be kept at any one time.
RequestResults
Purpose:
Represents the result of a recording request
Possible Values:
Unset
FailedWithError
Conflicts
NoProgrammesFound
AlreadyScheduled
ExceededMaxRequests
OK
EPGSearchMatchType
Purpose:
Represents how the server should match text when searching the EPG
Possible Values:
ExactMatch
StartsWith
Contains
EPGSearchTextType
Purpose:
Represents which text fields the server should check when searching the EPG for a show
Possible Values:
Title
TitleAndEpisodeTitle
TitlesAndDescription
Credits
AllTextFields
Streaming
MediaStreamingQuality
Purpose:
Represents a set of pre-defined audio and video encoding settings
Possible Values:
0
1
2
3
4
5
6
Notes:
The higher the number the greater the bitrate and size. The encoding settings represented by each value are:
0 (Low) : Video:192x128 @ 48k Audio:48k X264SubQ:2, X264MotionSearchRange:8
1 (Med) : Video:192x128 @ 56k Audio:48k X264SubQ:2, X264MotionSearchRange:8
2 (Norm) : Video:240x160 @ 96k Audio:64k X264SubQ:4, X264MotionSearchRange:12
3 (High) : Video:240x160 @ 192k Audio:64k X264SubQ:5, X264MotionSearchRange:16
4 (V High) : Video:480x320 @ 320k Audio:64k X264SubQ:6, X264MotionSearchRange:16
5 (near HD) : Video:614x460 @ 860k Audio:64k X264SubQ:6, X264MotionSearchRange:16
6 (HD) : Video:1024x768 @ 1400k Audio:64k X264SubQ:6, X264MotionSearchRange:16
WTVProfileQuality
Purpose:
Represents the quality of a streaming video session.
Possible Values:
Low
Normal
Med
High
UltraHigh
Custom
Server
ServerCapabilities
Purpose:
These constants are used to tell clients what features are supported on the server.
Possible Values:
MCE
MUSIC
PICTURES
VIDEOS
RECORDEDTV
STREAM-HTTPLIVE
STREAM-MSWMSP
Notes:
The various values correspond to the following functions on the server:

MCE - The server has full Media Center integration. (EPG Guide, Schedule Recordings, etc)
MUSIC - A music Library is available to browse and stream.
PICTURES - A picture library is available to browse and view.
VIDEOS - A video library is available to browse, but not necessarily stream.
RECORDEDTV - A recorded TV library is available to browse, but not necessarily stream.
STREAM-HTTPLIVE - The server can stream HTTP Live video streams, e.g. to iOS devices
STREAM-MSWMSP - The server can stream MS-WMSP video streams, e.g. to Silverlight.


A stock installation of Remote Potato on Windows 7 will return all of these flags, however on Windows XP or Vista, the MCE flag will be ommitted.
Remote Control
RemoteCommand
Purpose:
These constants are used to represent various simulated 'infra red' remote control key presses.
Possible Values:
Play,
Pause,
Stop,
Ffw,
Rew,
SkipFwd,
SkipBack,
Record,
NavUp,
NavDown,
NavLeft,
NavRight,
NavBack,
Menu,
Info,
DVDMenu,
OK,
Clear,
Enter,
VolUp,
VolDown,
VolMute,
DVDAudio,
ChanUp,
ChanDown,
Num0,
Num1,
Num2,
Num3,
Num4,
Num5,
Num6,
Num7,
Num8,
Num9,
NumHash,
NumStar,
Text,
TextRed,
TextGreen,
TextYellow,
TextBlue,
Subtitles,
GotoGuide,
GotoLiveTV,
GotoRecTV,
GotoPictures,
GotoMusic,
GotoMovies,
GotoVideos,
GotoRadio,
GotoExtras,
GreenButton,
Power