org.jmythapi.protocol.response.impl
Class ProgramInfo

java.lang.Object
  org.jmythapi.impl.AData<E>
      org.jmythapi.protocol.response.impl.AMythResponse<E>
          org.jmythapi.protocol.response.impl.AProgramInfo<IProgramInfo.Props>
              org.jmythapi.protocol.response.impl.ProgramInfo

All Implemented Interfaces:

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

public class ProgramInfo
extends AProgramInfo<IProgramInfo.Props>
implements IBasicChannelInfo, IBasicInputInfo, IProgramInfo

Nested Class Summary

Nested classes/interfaces inherited from interface org.jmythapi.protocol.response.IProgramInfo

IProgramInfo.Props

Field Summary

Fields inherited from class org.jmythapi.impl.AData

logger, propsClass, protoVersion, respArgs

Constructor Summary

ProgramInfo(IMythPacket packet)
Constructs a program-info object from a MythTv-protocol packet.

ProgramInfo(ProtocolVersion protoVersion)
Constructs an empty program-info object for the given protocol version.

ProgramInfo(ProtocolVersion protoVersion, List<String> responseArgs)
Constructs a program-info object for the given protocol version with the given parameters.

Method Summary

IProgramAudioProperties	getAudioProperties() Gets the recording audio properties.
String	getBaseName() Gets the recording file base name.
Integer	getCardID() Gets the ID of the physical capture card.
String	getCategory() Gets the category of the program.
Integer	getChannelID() Gets the MythTV internal channel ID.
String	getChannelName() Gets the channel name.
String	getChannelNumber() Gets the user defined channel number.
String	getChannelOuputFilters() Output filters.
String	getChannelSign() Gets the station abbreviation.
String	getDescription() Gets the program description.
Date	getEndDateTime() Gets the scheduled end of the 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 a specific input.
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.
ProgramFlags	getProgramFlags() Gets additional status flags of the recording.
String	getProgramID() Get the program ID.
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.
ProgramRecordingStatus	getRecordingStatus() Gets the current recording status.
ProgramRecordingType	getRecordingType() Gets the recording type.
Integer	getSeason() Gets the season of the program.
String	getSeriesID() Gets the series ID of the program.
Integer	getSourceID() Gets the source ID.
Float	getStars() Rating.
Date	getStartDateTime() Gets the scheduled start of the program.
String	getStorageGroup() Gets the name of the storage group storing the recording.
String	getSubtitle() Gets the program subtitle.
IProgramSubtitleType	getSubtitleType() Gets the recording subtitle properties.
String	getSyndicatedEpisode() Gets the syndicated episode of the program.
Float	getTimeStretch() Time stretch setting for recording.
String	getTitle() Gets the program title.
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 ProgramFlags#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 ProgramFlags#isSet(org.jmythapi.protocol.response.IProgramFlags.Flags) instead.
Boolean	isShareable() Deprecated. 57
void	setFileSize(Long fileSize) Updates the size of the recording.
static ProgramInfo	valueOf(RecorderNextProgramInfo nextProgram, InputInfoFree input)

Methods inherited from class org.jmythapi.protocol.response.impl.AProgramInfo

getDuration, getFullTitle, getMinutesAfterMidnight, getUniqueProgramId, isValid

Methods inherited from class org.jmythapi.protocol.response.impl.AMythResponse

checkSize, decodeProperty, encodeProperty, getExpectedSize, getPacket, getProperties, getProperty, getPropertyIndex

Methods inherited from class org.jmythapi.impl.AData

clone, equals, getPropertyClass, getPropertyCount, getPropertyMap, getPropertyValue, getPropertyValue, getPropertyValueObject, getPropertyValueObject, getPropertyValues, getVersionNr, hashCode, init, postProcessArguments, setPropertyValue, setPropertyValue, setPropertyValueObject, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

getPropertyValues

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

Constructor Detail

ProgramInfo

public ProgramInfo(IMythPacket packet)

Constructs a program-info object from a MythTv-protocol packet.

Parameters:

packet - the protocol packet received over network.

ProgramInfo

public ProgramInfo(ProtocolVersion protoVersion,
                   List<String> responseArgs)

Constructs a program-info object for the given protocol version with the given parameters.

Parameters:

protoVersion - the protocol version to use

responseArgs - the program-info arguments

ProgramInfo

public ProgramInfo(ProtocolVersion protoVersion)

Constructs an empty program-info object for the given protocol version.

Parameters:

protoVersion - the protocol version to use

Method Detail

getUniqueRecordingId

public String getUniqueRecordingId()

Description copied from interface: IProgramInfo

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()

Specified by:

getUniqueRecordingId in interface IProgramInfo

Returns:

the unique recording id.

getTitle

public String getTitle()

Description copied from interface: IBasicProgramInfo

Gets the program title.

Specified by:

getTitle in interface IBasicProgramInfo

Specified by:

getTitle in interface IProgramInfo

Specified by:

getTitle in class AProgramInfo<IProgramInfo.Props>

Returns:

the title of the program

See Also:

IProgramInfo.Props.TITLE, IBasicProgramInfo.getTitle()

getSubtitle

public String getSubtitle()

Description copied from interface: IBasicProgramInfo

Gets the program subtitle.

Specified by:

getSubtitle in interface IBasicProgramInfo

Specified by:

getSubtitle in interface IProgramInfo

Specified by:

getSubtitle in class AProgramInfo<IProgramInfo.Props>

Returns:

the subtitle of the program

See Also:

IProgramInfo.Props.SUBTITLE, IBasicProgramInfo.getSubtitle()

getDescription

public String getDescription()

Description copied from interface: IBasicProgramInfo

Gets the program description.

Specified by:

getDescription in interface IBasicProgramInfo

Specified by:

getDescription in interface IProgramInfo

Specified by:

getDescription in class AProgramInfo<IProgramInfo.Props>

Returns:

the program description

See Also:

IProgramInfo.Props.DESCRIPTION, IBasicProgramInfo.getDescription()

getCategory

public String getCategory()

Description copied from interface: IBasicProgramInfo

Gets the category of the program.

Specified by:

getCategory in interface IBasicProgramInfo

Specified by:

getCategory in interface IProgramInfo

Specified by:

getCategory in class AProgramInfo<IProgramInfo.Props>

Returns:

the program category, e.g. Comedy

See Also:

IProgramInfo.Props.CATEGORY, IBasicProgramInfo.getCategory()

getStartDateTime

public Date getStartDateTime()

Description copied from interface: IBasicProgramInfo

Gets the scheduled start of the program.

Specified by:

getStartDateTime in interface IBasicProgramInfo

Specified by:

getStartDateTime in interface IProgramInfo

Specified by:

getStartDateTime in class AProgramInfo<IProgramInfo.Props>

Returns:

the scheduled start time.

See Also:

IProgramInfo.Props.START_DATE_TIME, IBasicProgramInfo.getStartDateTime()

getEndDateTime

public Date getEndDateTime()

Description copied from interface: IBasicProgramInfo

Gets the scheduled end of the program.

Specified by:

getEndDateTime in interface IBasicProgramInfo

Specified by:

getEndDateTime in interface IProgramInfo

Specified by:

getEndDateTime in class AProgramInfo<IProgramInfo.Props>

Returns:

the scheduled end time.

See Also:

IProgramInfo.Props.END_DATE_TIME, IBasicProgramInfo.getEndDateTime()

getSeriesID

public String getSeriesID()

Description copied from interface: IBasicProgramInfo

Gets the series ID of the program.

Specified by:

getSeriesID in interface IBasicProgramInfo

Specified by:

getSeriesID in interface IProgramInfo

Specified by:

getSeriesID in class AProgramInfo<IProgramInfo.Props>

Returns:

the series ID.

See Also:

IProgramInfo.Props.SERIES_ID, IBasicProgramInfo.getSeriesID()

getProgramID

public String getProgramID()

Description copied from interface: IBasicProgramInfo

Get the program ID.

Specified by:

getProgramID in interface IBasicProgramInfo

Specified by:

getProgramID in interface IProgramInfo

Specified by:

getProgramID in class AProgramInfo<IProgramInfo.Props>

Returns:

the program ID.

See Also:

IProgramInfo.Props.PROGRAM_ID, IBasicProgramInfo.getProgramID()

getChannelID

public Integer getChannelID()

Description copied from interface: IBasicChannelInfo

Gets the MythTV internal channel ID.

Specified by:

getChannelID in interface IBasicChannelInfo

Specified by:

getChannelID in interface IProgramInfo

Specified by:

getChannelID in class AProgramInfo<IProgramInfo.Props>

Returns:

the ID of the channel, e.g. 11123

See Also:

IProgramInfo.Props.CHANNEL_ID, IBasicChannelInfo.getChannelID()

getChannelSign

public String getChannelSign()

Description copied from interface: IBasicChannelInfo

Gets the station abbreviation.

Specified by:

getChannelSign in interface IBasicChannelInfo

Specified by:

getChannelSign in interface IProgramInfo

Specified by:

getChannelSign in class AProgramInfo<IProgramInfo.Props>

Returns:

the channel abbreviation, e.g. PULS 4

See Also:

IProgramInfo.Props.CHANNEL_SIGN, IBasicChannelInfo.getChannelSign()

getChannelNumber

public String getChannelNumber()

Description copied from interface: IBasicChannelInfo

Gets the user defined channel number.

Specified by:

getChannelNumber in interface IBasicChannelInfo

Specified by:

getChannelNumber in interface IProgramInfo

Specified by:

getChannelNumber in class AProgramInfo<IProgramInfo.Props>

Returns:

the user defined number. This could contain '-', '_' or '.'

See Also:

IRecorderChannelInfo.Props.CHANNEL_NUMBER

getFindID

public Integer getFindID()

Description copied from interface: IProgramInfo

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

Specified by:

getFindID in interface IProgramInfo

Returns:

the find id of the recording or 0

See Also:

IProgramInfo.Props.FIND_ID

getParentID

public Integer getParentID()

Description copied from interface: IProgramInfo

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.

Specified by:

getParentID in interface IProgramInfo

Returns:

the parent id of the recording

See Also:

IProgramInfo.Props.PARENT_ID

getSeason

public Integer getSeason()

Description copied from interface: IProgramInfo

Gets the season of the program.

Specified by:

getSeason in interface IProgramInfo

See Also:

IProgramInfo.Props.SEASON

getEpisode

public Integer getEpisode()

Description copied from interface: IProgramInfo

Gets the episode number of the program.

Specified by:

getEpisode in interface IProgramInfo

See Also:

IProgramInfo.Props.EPISODE

getSyndicatedEpisode

public String getSyndicatedEpisode()

Description copied from interface: IProgramInfo

Gets the syndicated episode of the program.

Specified by:

getSyndicatedEpisode in interface IProgramInfo

See Also:

IProgramInfo.Props.SYNDICATED_EPISODE

getInetRef

public String getInetRef()

Description copied from interface: IProgramInfo

Gets an identification string to use for metadata grabbers.

Specified by:

getInetRef in interface IProgramInfo

See Also:

IProgramInfo.Props.INETREF

getChannelName

public String getChannelName()

Description copied from interface: IProgramInfo

Gets the channel name.

Specified by:

getChannelName in interface IProgramInfo

Returns:

the recording channel name

See Also:

IProgramInfo.Props.CHANNEL_NAME

getChannelOuputFilters

public String getChannelOuputFilters()

Description copied from interface: IProgramInfo

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.

Specified by:

getChannelOuputFilters in interface IProgramInfo

Returns:

the channel output filters

See Also:

IProgramInfo.Props.CHANNEL_OUTPUT_FILTERS

getPathName

public String getPathName()

Description copied from interface: IProgramInfo

Gets the recording file name or URI.

Specified by:

getPathName in interface IProgramInfo

Returns:

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

See Also:

IProgramInfo.Props.PATH_NAME

getBaseName

public String getBaseName()

Description copied from interface: IProgramInfo

Gets the recording file base name.

Specified by:

getBaseName in interface IProgramInfo

Returns:

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

See Also:

IProgramInfo.Props.PATH_NAME

getPreviewImageName

public String getPreviewImageName()

Description copied from interface: IProgramInfo

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.

Specified by:

getPreviewImageName in interface IProgramInfo

Returns:

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

getHostName

public String getHostName()

Description copied from interface: IProgramInfo

Gets the name of the host storing the recording file.

Specified by:

getHostName in interface IProgramInfo

Returns:

the host name

See Also:

IProgramInfo.Props.HOSTNAME

getFileSize

public Long getFileSize()

Description copied from interface: IProgramInfo

Gets the size of the recording file.

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

Specified by:

getFileSize in interface IProgramInfo

Returns:

the recording file size in bytes.

See Also:

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

setFileSize

public void setFileSize(Long fileSize)

Description copied from interface: IProgramInfo

Updates the size of the recording.

Specified by:

setFileSize in interface IProgramInfo

Parameters:

fileSize - the new file size

See Also:

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

getOriginalAirdate

public Date getOriginalAirdate()

Description copied from interface: IProgramInfo

Gets the original airdate of the recording.

Specified by:

getOriginalAirdate in interface IProgramInfo

Returns:

the air date of the recording.

See Also:

IProgramInfo.Props.ORIGINAL_AIRDATE

getRecordingStartTime

public Date getRecordingStartTime()

Description copied from interface: IProgramInfo

Gets the recording start time.

Note: This may be different to IProgramInfo.getStartDateTime().

Specified by:

getRecordingStartTime in interface IProgramInfo

Returns:

the recording start time.

See Also:

IProgramInfo.Props.REC_START_TIME

getRecordingEndTime

public Date getRecordingEndTime()

Description copied from interface: IProgramInfo

Gets the recording end time.

Note: This may be different to IProgramInfo.getEndDateTime().

Specified by:

getRecordingEndTime in interface IProgramInfo

Returns:

the recording end time.

See Also:

IProgramInfo.Props.REC_END_TIME

getRecordingDuration

public int getRecordingDuration()

Description copied from interface: IProgramInfo

Gets the recording duration for the program in minutes.

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

Specified by:

getRecordingDuration in interface IProgramInfo

Returns:

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

getRecordingStartOffset

public int getRecordingStartOffset()

Description copied from interface: IProgramInfo

Gets the recording start offset.

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

Specified by:

getRecordingStartOffset in interface IProgramInfo

Returns:

the recording start offset in minutes.

See Also:

EncodingUtils.getMinutesDiff(Date, Date)

getRecordingEndOffset

public int getRecordingEndOffset()

Description copied from interface: IProgramInfo

Gets the recording end offset.

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

Specified by:

getRecordingEndOffset in interface IProgramInfo

Returns:

the recording end offset in minutes.

See Also:

EncodingUtils.getMinutesDiff(Date, Date)

getRecordingElapsedMinutes

public int getRecordingElapsedMinutes()

Description copied from interface: IProgramInfo

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 IProgramInfo.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.

Specified by:

getRecordingElapsedMinutes in interface IProgramInfo

Returns:

the amount of minutes elapsed since recording started.

See Also:

EncodingUtils.getMinutesDiff(Date, Date)

getRecordingElapsedPercent

public int getRecordingElapsedPercent()

Description copied from interface: IProgramInfo

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

Specified by:

getRecordingElapsedPercent in interface IProgramInfo

Returns:

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

getRecordingPriority

public Integer getRecordingPriority()

Description copied from interface: IProgramInfo

Gets the recording priority.

Specified by:

getRecordingPriority in interface IProgramInfo

Returns:

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

See Also:

IProgramInfo.Props.REC_PRIORITY

getRecordingPriority2

public Integer getRecordingPriority2()

Description copied from interface: IProgramInfo

Gets the recording priority 2.

Specified by:

getRecordingPriority2 in interface IProgramInfo

Returns:

the recording priority-2

See Also:

IProgramInfo.Props.REC_PRIORITY2

getRecordingGroup

public String getRecordingGroup()

Description copied from interface: IProgramInfo

Gets the recording group.

Specified by:

getRecordingGroup in interface IProgramInfo

Returns:

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

See Also:

IProgramInfo.Props.REC_GROUP

getPlayGroup

public String getPlayGroup()

Description copied from interface: IProgramInfo

Gets the play group assigned to the recording.

Specified by:

getPlayGroup in interface IProgramInfo

Returns:

the play group name, e.g. Default

See Also:

IProgramInfo.Props.PLAY_GROUP

getStorageGroup

public String getStorageGroup()

Description copied from interface: IProgramInfo

Gets the name of the storage group storing the recording.

Specified by:

getStorageGroup in interface IProgramInfo

Returns:

the storage group name, e.g. Default

See Also:

IProgramInfo.Props.STORAGE_GROUP

getProgramFlags

public ProgramFlags getProgramFlags()

Description copied from interface: IProgramInfo

Gets additional status flags of the recording.

See IProgramFlags.Flags for all possible values.

Specified by:

getProgramFlags in interface IProgramInfo

Returns:

status flags

See Also:

IProgramInfo.Props.PROGRAM_FLAGS

getAudioProperties

public IProgramAudioProperties getAudioProperties()

Description copied from interface: IProgramInfo

Gets the recording audio properties.

See IProgramAudioProperties.Flags for all possible values.

Specified by:

getAudioProperties in interface IProgramInfo

Returns:

the audio properties.

See Also:

IProgramInfo.Props.AUDIO_PROPERTIES

getVideoProperties

public IProgramVideoProperties getVideoProperties()

Description copied from interface: IProgramInfo

Gets the recording video properties.

See IProgramVideoProperties.Flags for all possible values.

Specified by:

getVideoProperties in interface IProgramInfo

Returns:

the recording video properties.

See Also:

IProgramInfo.Props.VIDEO_PROPERTIES

getSubtitleType

public IProgramSubtitleType getSubtitleType()

Description copied from interface: IProgramInfo

Gets the recording subtitle properties.

See IProgramSubtitleType.Flags for all possible values.

Specified by:

getSubtitleType in interface IProgramInfo

Returns:

the subtitle properties.

See Also:

IProgramInfo.Props.SUBTITLE_TYPE

getRecordingStatus

public ProgramRecordingStatus getRecordingStatus()

Description copied from interface: IProgramInfo

Gets the current recording status.

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

Specified by:

getRecordingStatus in interface IProgramInfo

Returns:

the recording status.

See Also:

IProgramInfo.Props.REC_STATUS

getRecordingType

public ProgramRecordingType getRecordingType()

Description copied from interface: IProgramInfo

Gets the recording type.

See IProgramRecordingType.Type for all possible types.

Specified by:

getRecordingType in interface IProgramInfo

Returns:

the recording type.

See Also:

IProgramInfo.Props.REC_TYPE

getRecordingDuplicationType

public IProgramRecordingDupInType getRecordingDuplicationType()

Description copied from interface: IProgramInfo

Gets the duplication type of the recording.

See IProgramRecordingDupInType.Flags for all possible flags.

Specified by:

getRecordingDuplicationType in interface IProgramInfo

Returns:

the duplication type

See Also:

IProgramInfo.Props.DUP_IN

getRecordingDuplicationMethod

public IProgramRecordingDupMethodType getRecordingDuplicationMethod()

Description copied from interface: IProgramInfo

Gets the duplication mode to use for the recording.

See IProgramRecordingDupMethodType.Flags for all possible flags.

Specified by:

getRecordingDuplicationMethod in interface IProgramInfo

Returns:

the duplication mode.

See Also:

IProgramInfo.Props.DUP_METHOD

getYear

public Integer getYear()

Description copied from interface: IProgramInfo

Gets the production year of the program.

Specified by:

getYear in interface IProgramInfo

Returns:

the production year of the program.

See Also:

IProgramInfo.Props.YEAR

getRecordingId

public Integer getRecordingId()

Description copied from interface: IProgramInfo

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 IProgramInfo.getUniqueRecordingId() instead.

Specified by:

getRecordingId in interface IProgramInfo

Returns:

the recording ID

See Also:

IProgramInfo.Props.REC_ID

getTimeStretch

public Float getTimeStretch()

Description copied from interface: IProgramInfo

Time stretch setting for recording.

Specified by:

getTimeStretch in interface IProgramInfo

Returns:

the time stretch setting

See Also:

IProgramInfo.Props.TIMESTRETCH

getStars

public Float getStars()

Description copied from interface: IProgramInfo

Rating.

Specified by:

getStars in interface IProgramInfo

Returns:

the rating for this program.

See Also:

IProgramInfo.Props.STARS

getLastModified

public Date getLastModified()

Description copied from interface: IProgramInfo

Last modification time.

Keeps track of the last time the entry was updated.

Specified by:

getLastModified in interface IProgramInfo

Returns:

the last modified date of the recording

See Also:

IProgramInfo.Props.LAST_MODIFIED

getPartNumber

public Integer getPartNumber()

Description copied from interface: IProgramInfo

Part number.

Specified by:

getPartNumber in interface IProgramInfo

See Also:

IProgramInfo.Props.PART_NUMBER

getPartTotal

public Integer getPartTotal()

Description copied from interface: IProgramInfo

Part total.

Specified by:

getPartTotal in interface IProgramInfo

See Also:

IProgramInfo.Props.PART_TOTAL

isDuplicate

public Boolean isDuplicate()

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

Description copied from interface: IProgramInfo

Checks if the recording is a duplicate.

Specified by:

isDuplicate in interface IProgramInfo

See Also:

IProgramInfo.Props.DUPLICATE, IProgramFlags.Flags.FL_DUPLICATE

isShareable

public Boolean isShareable()

Deprecated. 57

Description copied from interface: IProgramInfo

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.

Specified by:

isShareable in interface IProgramInfo

See Also:

IProgramInfo.Props.SHAREABLE

isRepeat

public Boolean isRepeat()

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

Specified by:

isRepeat in interface IProgramInfo

See Also:

IProgramInfo.Props.REPEAT, IProgramFlags.Flags.FL_REPEAT

isChannelCommFree

public Boolean isChannelCommFree()

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

Specified by:

isChannelCommFree in interface IProgramInfo

See Also:

IProgramInfo.Props.CHAN_COMM_FREE, IProgramFlags.Flags.FL_CHANCOMMFREE

hasAirDate

public Boolean hasAirDate()

Deprecated. 57

Description copied from interface: IProgramInfo

Checks if an airdate is available for the program.

Specified by:

hasAirDate in interface IProgramInfo

See Also:

IProgramInfo.Props.HAS_AIRDATE

getCardID

public Integer getCardID()

Description copied from interface: IBasicInputInfo

Gets the ID of the physical capture card.

Specified by:

getCardID in interface IBasicInputInfo

Specified by:

getCardID in interface IProgramInfo

Returns:

the capture card ID

See Also:

IProgramInfo.Props.CARD_ID, IBasicInputInfo.getCardID()

getInputID

public Integer getInputID()

Description copied from interface: IBasicInputInfo

Gets the ID of a specific input.

Specified by:

getInputID in interface IBasicInputInfo

Specified by:

getInputID in interface IProgramInfo

Returns:

the input ID

See Also:

IProgramInfo.Props.INPUT_ID, IBasicInputInfo.getInputID()

getSourceID

public Integer getSourceID()

Description copied from interface: IBasicInputInfo

Gets the source ID.

Specified by:

getSourceID in interface IBasicInputInfo

Specified by:

getSourceID in interface IProgramInfo

Returns:

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

See Also:

IProgramInfo.Props.SOURCE_ID, IBasicInputInfo.getSourceID()

valueOf

public static ProgramInfo valueOf(RecorderNextProgramInfo nextProgram,
                                  InputInfoFree input)