org.jmythapi.protocol.response
Interface IProgramInfo

All Superinterfaces:

Cloneable, IBasicChannelInfo, IBasicInputInfo, IBasicProgramInfo, IPropertyAware<IProgramInfo.Props>, IVersionable

All Known Implementing Classes:

ProgramInfo

public interface IProgramInfo
extends IBasicChannelInfo, IBasicInputInfo, IBasicProgramInfo, IVersionable, IPropertyAware<IProgramInfo.Props>

An interface to get infos about a MythTV recording.

This object represents a finished, running, pending or scheduled MythTV recording. Depending on the type of a recording and on the MythTV version, different recording properties may be returned.
This interface is property-aware. See the properties-list for all properties of this object.

See the response examples on how a returned recording looks like.
See the usage examples on how to fetch the different types of recording lists.

A response example:

An example which data is returned for a recording:

Protocol Version 56 example:

<00>TITLE: Fringe - Grenzfälle des FBI | <01>SUBTITLE: Kontrolle | <02>DESCRIPTION: Der Sohn eines hochrangigen Massive Dynamic-Mitarbeiters wird entführt... | <03>CATEGORY: | <04>CHANNEL_ID: 11123 | <05>CHANNEL_NUMBER: 10123 | <06>CHANNEL_SIGN: PULS 4 | <07>CHANNEL_NAME: PULS 4 | <08>PATH_NAME: /var/lib/mythtv/recordings/11123_20110401233600.mpg | <09>FILESIZE_HIGH: 0 | <10>FILESIZE_LOW: 0 | <11>START_DATE_TIME: Fri Apr 01 23:04:58 CEST 2011 | <12>END_DATE_TIME: Fri Apr 01 23:58:24 CEST 2011 | <13>DUPLICATE: false | <14>SHAREABLE: false | <15>FIND_ID: 0 | <16>HOSTNAME: brain | <17>SOURCE_ID: 1 | <18>CARD_ID: 1 | <19>INPUT_ID: 1 | <20>REC_PRIORITY: 1 | <21>REC_STATUS: -2=> {RECORDING} | <22>REC_ID: 330 | <23>REC_TYPE: 1=> {SINGLE_RECORD} | <24>DUP_IN: 15=> {DUPS_IN_RECORDED,DUPS_IN_OLD_RECORDED,DUPS_IN_ALL} | <25>DUP_METHOD: 6=> {DUP_CHECK_SUB,DUP_CHECK_DESC,DUP_CHECK_SUB_DESC} | <26>REC_START_TIME: Fri Apr 01 23:36:00 CEST 2011 | <27>REC_END_TIME: Fri Apr 01 23:58:24 CEST 2011 | <28>REPEAT: false | <29>PROGRAM_FLAGS: 0=> {} | <30>REC_GROUP: Default | <31>CHAN_COMM_FREE: false | <32>CHANNEL_OUTPUT_FILTERS: | <33>SERIES_ID: | <34>PROGRAM_ID: | <35>LAST_MODIFIED: Fri Apr 01 23:35:39 CEST 2011 | <36>STARS: 0.000000 | <37>ORIGINAL_AIRDATE: | <38>HAS_AIRDATE: false | <39>PLAY_GROUP: Default | <40>REC_PRIORITY2: 0 | <41>PARENT_ID: 0 | <42>STORAGE_GROUP: Default | <43>AUDIO_PROPERTIES: 1=> {AUD_STEREO} | <44>VIDEO_PROPERTIES: 0=> {} | <45>SUBTITLE_TYPE: 0=> {} | <46>YEAR: 0

Protocol Version 15 example:

<00>TITLE: Malcolm mittendrin | <01>SUBTITLE: | <02>DESCRIPTION: Malcolm verteidigt Reese Serie mit Bryan Cranston, Christopher Masterson Programminformation nur noch bis Ende Dezember 2010 | <03>CATEGORY: Serie | <04>CHANNEL_ID: 1000 | <05>CHANNEL_NUMBER: 1 | <06>CHANNEL_SIGN: PRO7 | <07>CHANNEL_NAME: Pro7 | <08>PATH_NAME: | <09>FILESIZE_HIGH: 0 | <10>FILESIZE_LOW: 0 | <11>START_DATE_TIME: Thu Apr 14 10:15:00 CEST 2011 | <12>END_DATE_TIME: Thu Apr 14 10:45:00 CEST 2011 | <13>DUPLICATE: | <14>SHAREABLE: false | <15>FIND_ID: 0 | <16>HOSTNAME: | <17>SOURCE_ID: 1 | <18>CARD_ID: 1 | <19>INPUT_ID: 1 | <20>REC_PRIORITY: 0 | <21>REC_STATUS: -2=> {RECORDING} | <22>REC_ID: 1 | <23>REC_TYPE: 1=> {SINGLE_RECORD} | <24>DUP_IN: 15=> {DUPS_IN_RECORDED,DUPS_IN_OLD_RECORDED,DUPS_IN_BOTH,DUPS_IN_ALL,DUPS_NEW_EPI} | <25>DUP_METHOD: 6=> {DUP_CHECK_SUB,DUP_CHECK_DESC,DUP_CHECK_SUB_DESC} | <26>REC_START_TIME: Thu Apr 14 10:39:00 CEST 2011 | <27>REC_END_TIME: Thu Apr 14 10:45:00 CEST 2011 | <28>REPEAT: false | <29>PROGRAM_FLAGS: 0=> {} | <30>REC_GROUP: Default | <31>CHAN_COMM_FREE: false | <32>CHANNEL_OUTPUT_FILTERS: | <33>SERIES_ID: 227250734 | <34>PROGRAM_ID: | <35>LAST_MODIFIED: Thu Apr 14 10:39:19 CEST 2011 | <36>STARS: 0.0 | <37>ORIGINAL_AIRDATE: Thu Apr 14 02:00:00 CEST 2011 | <38>HAS_AIRDATE: false

Usage examples

Examples how to get a list of recordings from the backend:

• Get all recorded programs (link)
• Get all pending recordings (link)
• Get all scheduled recordings (link)
• Get all conflicting recordings (link)
• Get all expiring recordings (link)

Examples how to operate on a list of recordings:

• Filter recordings (link)
• Group recordings (link)

Examples how to get the data of a single recording from the backend:

• Get a recording by its file name (link)
• Get a recording by its channel and recording start-time (link)
• Get the current recording of a recorder (link)

Examples how to operate on a given recording:

• Download a recording (link)
• Delete a recording (link)
• Undelete a recording (link)
• Check if a recording is currently being recorded (link)
• Determine the recorder, that is currently recording the recording (link)
• Stop a currently active recording (link)
• Queries the bookmark for a recording (link)
• Set the bookmark for a recording (link)
• Update the file-name and -size for a recording (link)
• Check if a recording file exists (link)
• Generates a unique hash for a recording file (link)
• Generate a preview image for the recording (link)
• Check if the preview image for the recording has been modified (link)
• Get the URL to the Mythweb page of the recording (link)

Nested Class Summary

static class

IProgramInfo.Props The properties of an IProgramInfo response.

Method Summary

IProgramAudioProperties	getAudioProperties() Gets the recording audio properties.
String	getBaseName() Gets the recording file base name.
Integer	getCardID() Gets the id of the recorder, that will record this program.
String	getCategory() Gets the category of this program.
Integer	getChannelID() Gets the channel id of this program.
String	getChannelName() Gets the channel name.
String	getChannelNumber() Gets the channel number of this program.
String	getChannelOuputFilters() Output filters.
String	getChannelSign() Gets the channel station abbreviation of this program.
String	getDescription() Gets the description of this program.
Date	getEndDateTime() Gets the end-date and -time of this program.
Integer	getEpisode() Gets the episode number of the program.
Long	getFileSize() Gets the size of the recording file.
Integer	getFindID() Gets the find-id of the recording.
String	getHostName() Gets the name of the host storing the recording file.
String	getInetRef() Gets an identification string to use for metadata grabbers.
Integer	getInputID() Gets the id of the recorder input, that will be used for recording.
Date	getLastModified() Last modification time.
Date	getOriginalAirdate() Gets the original airdate of the recording.
Integer	getParentID() Parent ID.
Integer	getPartNumber() Part number.
Integer	getPartTotal() Part total.
String	getPathName() Gets the recording file name or URI.
String	getPlayGroup() Gets the play group assigned to the recording.
String	getPreviewImageName() Gets the name of the default recordings preview image.
IProgramFlags	getProgramFlags() Gets additional status flags of the recording.
String	getProgramID() Gets the program id of this program.
List<String>	getPropertyValues() Returns all property values as strings.
IProgramRecordingDupMethodType	getRecordingDuplicationMethod() Gets the duplication mode to use for the recording.
IProgramRecordingDupInType	getRecordingDuplicationType() Gets the duplication type of the recording.
int	getRecordingDuration() Gets the recording duration for the program in minutes.
int	getRecordingElapsedMinutes() Gets the amount of minutes elapsed since recording of this program has started.
int	getRecordingElapsedPercent() Gets the amount of minutes elapsed in percent, since recording of this program has started.
int	getRecordingEndOffset() Gets the recording end offset.
Date	getRecordingEndTime() Gets the recording end time.
String	getRecordingGroup() Gets the recording group.
Integer	getRecordingId() Gets the id of the recording in the database.
Integer	getRecordingPriority() Gets the recording priority.
Integer	getRecordingPriority2() Gets the recording priority 2.
int	getRecordingStartOffset() Gets the recording start offset.
Date	getRecordingStartTime() Gets the recording start time.
IProgramRecordingStatus	getRecordingStatus() Gets the current recording status.
IProgramRecordingType	getRecordingType() Gets the recording type.
Integer	getSeason() Gets the season of the program.
String	getSeriesID() Gets the series id of this program.
Integer	getSourceID() Gets the source id of this program.
Float	getStars() Rating.
Date	getStartDateTime() Gets the start-date and -time of this program.
String	getStorageGroup() Gets the name of the storage group storing the recording.
String	getSubtitle() Gets the subtitle of this program.
IProgramSubtitleType	getSubtitleType() Gets the recording subtitle properties.
String	getSyndicatedEpisode() Gets the syndicated episode of the program.
Float	getTimeStretch() Deprecated. 23, replaced by getPlayGroup()
String	getTitle() Gets the title of this program.
String	getUniqueRecordingId() The unique recording id if this recording.
IProgramVideoProperties	getVideoProperties() Gets the recording video properties.
Integer	getYear() Gets the production year of the program.
Boolean	hasAirDate() Deprecated. 57
Boolean	isChannelCommFree() Deprecated. 57, use IProgramFlags#isSet(org.jmythapi.protocol.response.IProgramFlags.Flags) instead.
Boolean	isDuplicate() Deprecated. 57, use IProgramFlags#isSet(org.jmythapi.protocol.response.IProgramFlags.Flags) instead.
Boolean	isRepeat() Deprecated. 57, use IProgramFlags#isSet(org.jmythapi.protocol.response.IProgramFlags.Flags) instead.
Boolean	isShareable() Deprecated. 57
void	setFileSize(Long fileSize) Updates the size of the recording.

Methods inherited from interface org.jmythapi.protocol.response.IBasicProgramInfo

getDuration, getFullTitle, getMinutesAfterMidnight, getUniqueProgramId, isValid

Methods inherited from interface org.jmythapi.IVersionable

getVersionNr

Methods inherited from interface org.jmythapi.IPropertyAware

getProperties, getProperty, getPropertyClass, getPropertyCount, getPropertyIndex, getPropertyMap, getPropertyValue, getPropertyValue, getPropertyValueObject, setPropertyValue, setPropertyValue, setPropertyValueObject

Method Detail

getPropertyValues

List<String> getPropertyValues()

Description copied from interface: IPropertyAware

Returns all property values as strings.

Specified by:

getPropertyValues in interface IPropertyAware<IProgramInfo.Props>

Returns:

all properties as strings

getUniqueRecordingId

String getUniqueRecordingId()

The unique recording id if this recording.

This id has the format: [channel-id]_[recording-start-time]

Note: This id is different to IBasicProgramInfo.getUniqueProgramId()

Returns:

the unique recording id.

getTitle

String getTitle()

Gets the title of this program.

Specified by:

getTitle in interface IBasicProgramInfo

Returns:

the title of the program

See Also:

IProgramInfo.Props.TITLE, IBasicProgramInfo.getTitle()

getSubtitle

String getSubtitle()

Gets the subtitle of this program.

Specified by:

getSubtitle in interface IBasicProgramInfo

Returns:

the subtitle of the program

See Also:

IProgramInfo.Props.SUBTITLE, IBasicProgramInfo.getSubtitle()

getDescription

String getDescription()

Gets the description of this program.

Specified by:

getDescription in interface IBasicProgramInfo

Returns:

the program description

See Also:

IProgramInfo.Props.DESCRIPTION, IBasicProgramInfo.getDescription()

getCategory

String getCategory()

Gets the category of this program.

Specified by:

getCategory in interface IBasicProgramInfo

Returns:

the program category, e.g. Comedy

See Also:

IProgramInfo.Props.CATEGORY, IBasicProgramInfo.getCategory()

getStartDateTime

Date getStartDateTime()

Gets the start-date and -time of this program.

Note: This value may be different to getRecordingStartTime().

Specified by:

getStartDateTime in interface IBasicProgramInfo

Returns:

the scheduled start time.

See Also:

IProgramInfo.Props.START_DATE_TIME, IBasicProgramInfo.getStartDateTime()

getEndDateTime

Date getEndDateTime()

Gets the end-date and -time of this program.

Note: This value may be different to getRecordingEndTime().

Specified by:

getEndDateTime in interface IBasicProgramInfo

Returns:

the scheduled end time.

See Also:

IProgramInfo.Props.END_DATE_TIME, IBasicProgramInfo.getEndDateTime()

getSeriesID

String getSeriesID()

Gets the series id of this program.

This is used by MythTV for duplication checks.

Specified by:

getSeriesID in interface IBasicProgramInfo

Returns:

the series ID.

Since:

08

See Also:

IProgramInfo.Props.SERIES_ID, IBasicProgramInfo.getSeriesID()

getProgramID

String getProgramID()

Gets the program id of this program.

This is used by MythTV for duplication checks.

Specified by:

getProgramID in interface IBasicProgramInfo

Returns:

the program ID.

Since:

08

See Also:

IProgramInfo.Props.PROGRAM_ID, IBasicProgramInfo.getProgramID()

getChannelID

Integer getChannelID()

Gets the channel id of this program.

Specified by:

getChannelID in interface IBasicChannelInfo

Returns:

the ID of the channel, e.g. 11123

See Also:

IProgramInfo.Props.CHANNEL_ID, IBasicChannelInfo.getChannelID()

getChannelSign

String getChannelSign()

Gets the channel station abbreviation of this program.

Specified by:

getChannelSign in interface IBasicChannelInfo

Returns:

the channel abbreviation, e.g. PULS 4

See Also:

IProgramInfo.Props.CHANNEL_SIGN, IBasicChannelInfo.getChannelSign()

getChannelNumber

String getChannelNumber()

Gets the channel number of this program.

Specified by:

getChannelNumber in interface IBasicChannelInfo

Returns:

the channel number

See Also:

IProgramInfo.Props.CHANNEL_NUMBER, IBasicChannelInfo.getChannelNumber()

getCardID

Integer getCardID()

Gets the id of the recorder, that will record this program.

Specified by:

getCardID in interface IBasicInputInfo

Returns:

the capture card ID

See Also:

IProgramInfo.Props.CARD_ID, IBasicInputInfo.getCardID()

getInputID

Integer getInputID()

Gets the id of the recorder input, that will be used for recording.

Specified by:

getInputID in interface IBasicInputInfo

Returns:

the input ID

See Also:

IProgramInfo.Props.INPUT_ID, IBasicInputInfo.getInputID()

getSourceID

Integer getSourceID()

Gets the source id of this program.

Specified by:

getSourceID in interface IBasicInputInfo

Returns:

the source ID. This is usually the first digit of the channel ID.

See Also:

IProgramInfo.Props.SOURCE_ID, IBasicInputInfo.getSourceID()

isDuplicate

Boolean isDuplicate()

Deprecated. 57, use IProgramFlags#isSet(org.jmythapi.protocol.response.IProgramFlags.Flags) instead.

Checks if the recording is a duplicate.

See Also:

IProgramInfo.Props.DUPLICATE, IProgramFlags.Flags.FL_DUPLICATE

isShareable

Boolean isShareable()

Deprecated. 57

Checks if a shareable card input is used.

Signals that the used card input can be shared, e.g. on DVB cards. Till protocol version 57 this information was used by the scheduler.

See Also:

IProgramInfo.Props.SHAREABLE

isRepeat

Boolean isRepeat()

Deprecated. 57, use IProgramFlags#isSet(org.jmythapi.protocol.response.IProgramFlags.Flags) instead.

See Also:

IProgramInfo.Props.REPEAT, IProgramFlags.Flags.FL_REPEAT

isChannelCommFree

Boolean isChannelCommFree()

Deprecated. 57, use IProgramFlags#isSet(org.jmythapi.protocol.response.IProgramFlags.Flags) instead.

Since:

03

See Also:

IProgramInfo.Props.CHAN_COMM_FREE, IProgramFlags.Flags.FL_CHANCOMMFREE

hasAirDate

Boolean hasAirDate()

Deprecated. 57

Checks if an airdate is available for the program.

Since:

15

See Also:

IProgramInfo.Props.HAS_AIRDATE

getFindID

Integer getFindID()

Gets the find-id of the recording. Note: According to the MythTV wiki, this is calculated like this: (UNIX_TIMESTAMP(program.starttime)/60/60/24)+719528

Returns:

the find id of the recording or 0

See Also:

IProgramInfo.Props.FIND_ID

getParentID

Integer getParentID()

Parent ID.

If this recording is a duplicate, the ID of the parent is specified here.

This is used in combination with IProgramRecordingType.Type.OVERRIDE_RECORD.

Returns:

the parent id of the recording

Since:

31

See Also:

IProgramInfo.Props.PARENT_ID

getSeason

Integer getSeason()

Gets the season of the program.

Since:

67

See Also:

IProgramInfo.Props.SEASON

getEpisode

Integer getEpisode()

Gets the episode number of the program.

Since:

67

See Also:

IProgramInfo.Props.EPISODE

getSyndicatedEpisode

String getSyndicatedEpisode()

Gets the syndicated episode of the program.

Since:

76

See Also:

IProgramInfo.Props.SYNDICATED_EPISODE

getInetRef

String getInetRef()

Gets an identification string to use for metadata grabbers.

Since:

67

See Also:

IProgramInfo.Props.INETREF

getChannelName

String getChannelName()

Gets the channel name.

Returns:

the recording channel name

Since:

00

See Also:

IProgramInfo.Props.CHANNEL_NAME

getChannelOuputFilters

String getChannelOuputFilters()

Output filters.

Allows to specify a set of filters to be used when playing back recordings from a given channel. This is useful for those with hardware encoders and more than one source, since filters are rarely a one-size-fits-all thing.

Returns:

the channel output filters

Since:

06

See Also:

IProgramInfo.Props.CHANNEL_OUTPUT_FILTERS

getPathName

String getPathName()

Gets the recording file name or URI.

Returns:

the recording file name and path or the URI to the file.

Since:

00

See Also:

IProgramInfo.Props.PATH_NAME

getPreviewImageName

String getPreviewImageName()

Gets the name of the default recordings preview image.

You can use the value returned by this function download the preview-image of the recording.

Returns:

the name of the preview image, e.g. 1000_20110701123000.mpg.png

getBaseName

String getBaseName()

Gets the recording file base name.

Returns:

the recording file base name, e.g. 1000_20110701123000.mpg

Since:

00

See Also:

IProgramInfo.Props.PATH_NAME

getHostName

String getHostName()

Gets the name of the host storing the recording file.

Returns:

the host name

Since:

00

See Also:

IProgramInfo.Props.HOSTNAME

getFileSize

Long getFileSize()

Gets the size of the recording file.

Hint: To print a human readable string you can use EncodingUtils.getFormattedFileSize(long).

Returns:

the recording file size in bytes.

Since:

00

See Also:

IProgramInfo.Props.FILESIZE, IProgramInfo.Props.FILESIZE_LOW, IProgramInfo.Props.FILESIZE_HIGH, EncodingUtils.getFormattedFileSize(long)

setFileSize

void setFileSize(Long fileSize)

Updates the size of the recording.

Parameters:

fileSize - the new file size

Since:

00

See Also:

IProgramInfo.Props.FILESIZE, IProgramInfo.Props.FILESIZE_LOW, IProgramInfo.Props.FILESIZE_HIGH, EncodingUtils.getFormattedFileSize(long)

getOriginalAirdate

Date getOriginalAirdate()

Gets the original airdate of the recording.

Returns:

the air date of the recording.

Since:

12

See Also:

IProgramInfo.Props.ORIGINAL_AIRDATE

getRecordingStartTime

Date getRecordingStartTime()

Gets the recording start time.

Note: This may be different to getStartDateTime().

Returns:

the recording start time.

Since:

00

See Also:

IProgramInfo.Props.REC_START_TIME

getRecordingEndTime

Date getRecordingEndTime()

Gets the recording end time.

Note: This may be different to getEndDateTime().

Returns:

the recording end time.

Since:

00

See Also:

IProgramInfo.Props.REC_END_TIME

getRecordingStartOffset

int getRecordingStartOffset()

Gets the recording start offset.

This value is the difference in minutes between getRecordingStartTime() and getStartDateTime().

Returns:

the recording start offset in minutes.

See Also:

EncodingUtils.getMinutesDiff(Date, Date)

getRecordingEndOffset

int getRecordingEndOffset()

Gets the recording end offset.

This value is the difference in minutes between getRecordingEndTime() and getEndDateTime().

Returns:

the recording end offset in minutes.

See Also:

EncodingUtils.getMinutesDiff(Date, Date)

getRecordingDuration

int getRecordingDuration()

Gets the recording duration for the program in minutes.

Note: This value may be different to IBasicProgramInfo.getDuration().

Returns:

the recording duration of the program in minutes or -1 if unknown.

getRecordingElapsedMinutes

int getRecordingElapsedMinutes()

Gets the amount of minutes elapsed since recording of this program has started.

If current time is before recording-start-time, then 0 is returned.
If current time is after recording-end-time, then getRecordingDuration() is returned.
If current time is between recording-start- -and -end-time, EncodingUtils.getMinutesDiff(recStartDate,now) is used to calculate the amount of minutes elapsed.

Returns:

the amount of minutes elapsed since recording started.

See Also:

EncodingUtils.getMinutesDiff(Date, Date)

getRecordingElapsedPercent

int getRecordingElapsedPercent()

Gets the amount of minutes elapsed in percent, since recording of this program has started.

Returns:

the amount of minutes elapsed in percent, since recording has started.

getRecordingPriority

Integer getRecordingPriority()

Gets the recording priority.

Returns:

the recording priority. This is typically a value between -20 and 20

See Also:

IProgramInfo.Props.REC_PRIORITY

getRecordingPriority2

Integer getRecordingPriority2()

Gets the recording priority 2.

Returns:

the recording priority-2

Since:

25

See Also:

IProgramInfo.Props.REC_PRIORITY2

getRecordingGroup

String getRecordingGroup()

Gets the recording group.

Returns:

the name of the recording group, e.g. Default, LiveTV or Deleted

Since:

03

See Also:

IProgramInfo.Props.REC_GROUP

getPlayGroup

String getPlayGroup()

Gets the play group assigned to the recording.

Returns:

the play group name, e.g. Default

Since:

23

See Also:

IProgramInfo.Props.PLAY_GROUP

getStorageGroup

String getStorageGroup()

Gets the name of the storage group storing the recording.

Returns:

the storage group name, e.g. Default

Since:

32

See Also:

IProgramInfo.Props.STORAGE_GROUP

getProgramFlags

IProgramFlags getProgramFlags()

Gets additional status flags of the recording.

See IProgramFlags.Flags for all possible values.

Returns:

status flags

Since:

00

See Also:

IProgramInfo.Props.PROGRAM_FLAGS

getAudioProperties

IProgramAudioProperties getAudioProperties()

Gets the recording audio properties.

See IProgramAudioProperties.Flags for all possible values.

Returns:

the audio properties.

Since:

35

See Also:

IProgramInfo.Props.AUDIO_PROPERTIES

getVideoProperties

IProgramVideoProperties getVideoProperties()

Gets the recording video properties.

See IProgramVideoProperties.Flags for all possible values.

Returns:

the recording video properties.

Since:

35

See Also:

IProgramInfo.Props.VIDEO_PROPERTIES

getSubtitleType

IProgramSubtitleType getSubtitleType()

Gets the recording subtitle properties.

See IProgramSubtitleType.Flags for all possible values.

Returns:

the subtitle properties.

Since:

35

See Also:

IProgramInfo.Props.SUBTITLE_TYPE

getRecordingId

Integer getRecordingId()

Gets the id of the recording in the database.

Note: This is the ID of the mythtv scheduling rule, stored in the database. Therefore multiple recordings may have the same recording id!
If you need an unique id for a recording, use getUniqueRecordingId() instead.

Returns:

the recording ID

Since:

00

See Also:

IProgramInfo.Props.REC_ID

getRecordingStatus

IProgramRecordingStatus getRecordingStatus()

Gets the current recording status.

The recording status is typically unknown for a recording schedule.
See IProgramRecordingStatus.Status for all possible status values.

Returns:

the recording status.

Since:

00

See Also:

IProgramInfo.Props.REC_STATUS

getRecordingType

IProgramRecordingType getRecordingType()

Gets the recording type.

See IProgramRecordingType.Type for all possible types.

Returns:

the recording type.

Since:

00

See Also:

IProgramInfo.Props.REC_TYPE

getRecordingDuplicationType

IProgramRecordingDupInType getRecordingDuplicationType()

Gets the duplication type of the recording.

See IProgramRecordingDupInType.Flags for all possible flags.

Returns:

the duplication type

Since:

03

See Also:

IProgramInfo.Props.DUP_IN

MythTV protocol range: [03,-1)

	Version	Date	Additional Version Info
Added	03	2004-02-05	Changelog, SVN-Rev.: 3112
Removed	-1

getRecordingDuplicationMethod

IProgramRecordingDupMethodType getRecordingDuplicationMethod()

Gets the duplication mode to use for the recording.

See IProgramRecordingDupMethodType.Flags for all possible flags.

Returns:

the duplication mode.

Since:

03

See Also:

IProgramInfo.Props.DUP_METHOD

MythTV protocol range: [03,-1)

	Version	Date	Additional Version Info
Added	03	2004-02-05	Changelog, SVN-Rev.: 3112
Removed	-1

getYear

Integer getYear()

Gets the production year of the program.

Returns:

the production year of the program.

Since:

41

See Also:

IProgramInfo.Props.YEAR

getPartNumber

Integer getPartNumber()

Part number.

Since:

76

See Also:

IProgramInfo.Props.PART_NUMBER

getPartTotal

Integer getPartTotal()

Part total.

Since:

76

See Also:

IProgramInfo.Props.PART_TOTAL

getStars

Float getStars()

Rating.

Returns:

the rating for this program.

Since:

12

See Also:

IProgramInfo.Props.STARS

getTimeStretch

Float getTimeStretch()

Deprecated. 23, replaced by getPlayGroup()

Time stretch setting for recording.

Returns:

the time stretch setting

Since:

18

See Also:

IProgramInfo.Props.TIMESTRETCH

getLastModified

Date getLastModified()

Last modification time.

Keeps track of the last time the entry was updated.

Returns:

the last modified date of the recording

Since:

11

See Also:

IProgramInfo.Props.LAST_MODIFIED