org.jmythapi
Interface IRecorderChannelInfo

All Superinterfaces:

Cloneable, IBasicChannelInfo, IPropertyAware<IRecorderChannelInfo.Props>, IVersionable

All Known Implementing Classes:

ChannelInfo, RecorderChannelInfo

public interface IRecorderChannelInfo
extends IBasicChannelInfo, IPropertyAware<IRecorderChannelInfo.Props>, IVersionable

An interface to get informations about a MythTV recorder channel.

This interface represents the response to an IRecorder.getChannelInfo(Integer) request.
This interface is property-aware. See the properties-list for all properties of this interface.

A response example:

Example 1:

<0>CHANNEL_ID: 11123 | <1>SOURCE_ID: 1 | <2>CHANNEL_SIGN: PULS 4 | <3>CHANNEL_NUMBER: 10123 | <4>CHANNEL_NAME: PULS 4 | <5>XMLTV_ID:

Example 2:

<0>CHANNEL_ID: 1079 | <1>SOURCE_ID: 1 | <2>CHANNEL_SIGN: VOX | <3>CHANNEL_NUMBER: 8 | <4>CHANNEL_NAME: VOX | <5>XMLTV_ID: CNI0D8E

Since:

28

Nested Class Summary

static class

IRecorderChannelInfo.Props Properties of an IRecorderChannelInfo response.

Method Summary

Integer	getChannelID() Gets the MythTV internal channel ID.
String	getChannelName() Gets the channel name.
String	getChannelNumber() Gets the user defined channel number.
String	getChannelSign() Gets the station abbreviation.
Integer	getSourceID() Gets the source id.
String	getXmlTvID() Gets the XML-TV id.

Methods inherited from interface org.jmythapi.IVersionable

getVersionNr

Methods inherited from interface org.jmythapi.IPropertyAware

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

Method Detail

getChannelID

Integer getChannelID()

Description copied from interface: IBasicChannelInfo

Gets the MythTV internal channel ID.

Specified by:

getChannelID in interface IBasicChannelInfo

Returns:

the ID of the channel, e.g. 11123

See Also:

IRecorderChannelInfo.Props.CHANNEL_ID, IBasicChannelInfo.getChannelID()

getChannelSign

String getChannelSign()

Description copied from interface: IBasicChannelInfo

Gets the station abbreviation.

Specified by:

getChannelSign in interface IBasicChannelInfo

Returns:

the channel abbreviation, e.g. PULS 4

See Also:

IRecorderChannelInfo.Props.CHANNEL_SIGN, IBasicChannelInfo.getChannelSign()

getChannelNumber

String getChannelNumber()

Gets the user defined channel number.

Specified by:

getChannelNumber in interface IBasicChannelInfo

Returns:

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

See Also:

IRecorderChannelInfo.Props.CHANNEL_NUMBER

getChannelName

String getChannelName()

Gets the channel name.

Returns:

the channel name

See Also:

IRecorderChannelInfo.Props.CHANNEL_NAME

getSourceID

Integer getSourceID()

Gets the source id.

Returns:

the source id

See Also:

IRecorderChannelInfo.Props.SOURCE_ID

getXmlTvID

String getXmlTvID()

Gets the XML-TV id.

Returns:

the xml tv id

See Also:

IRecorderChannelInfo.Props.XMLTV_ID