org.jmythapi.protocol.events
Interface IRecordingListChangeAdd

All Superinterfaces:
Cloneable, IMythEvent<IRecordingListChangeAdd.Props>, IPropertyAware<IRecordingListChangeAdd.Props>, IRecordingEvent<IRecordingListChangeAdd.Props>, IRecordingListChange<IRecordingListChangeAdd.Props>, IRecordingListChangeSingle<IRecordingListChangeAdd.Props>, ISendable, IVersionable
All Known Implementing Classes:
RecordingListChangeAdd

public interface IRecordingListChangeAdd
extends IRecordingListChangeSingle<IRecordingListChangeAdd.Props>

Backend Event - Recording-List Event - Recording Added.

MythTV protocol example:
81      
BACKEND_MESSAGE[]:[]RECORDING_LIST_CHANGE ADD 1000 2013-09-18T05:35:00Z[]:[]empty

Protocol Version Hint:

Prior to protocol 53, it was possible to receive an UPDATE_PROG_INFO message for new recordings.

UTC Support:Starting with 75 dates are delivered with timezone UTC, but are automatically converted into the local timezone by this class.

Since:
53
See Also:
BACKEND_MESSAGE_RECORDING_LIST_CHANGE

Nested Class Summary
static class IRecordingListChangeAdd.Props
           
 
Method Summary
 Integer getChannelID()
          Gets the channel ID of the recording.
 Date getRecordingStartTime()
          Gets the recording start time.
 String getUniqueRecordingID()
          Gets the unique ID of the changed recording.
 
Methods inherited from interface org.jmythapi.protocol.events.IMythEvent
getEventName
 
Methods inherited from interface org.jmythapi.IPropertyAware
getProperties, getProperty, getPropertyClass, getPropertyCount, getPropertyIndex, getPropertyMap, getPropertyValue, getPropertyValue, getPropertyValueObject, getPropertyValues, setPropertyValue, setPropertyValue, setPropertyValueObject
 
Methods inherited from interface org.jmythapi.IVersionable
getVersionNr
 
Methods inherited from interface org.jmythapi.protocol.ISendable
getPacket
 

Method Detail

getChannelID

Integer getChannelID()
Gets the channel ID of the recording.

Specified by:
getChannelID in interface IRecordingEvent<IRecordingListChangeAdd.Props>
Specified by:
getChannelID in interface IRecordingListChangeSingle<IRecordingListChangeAdd.Props>
Returns:
the channel ID.

getRecordingStartTime

Date getRecordingStartTime()
Gets the recording start time.

Specified by:
getRecordingStartTime in interface IRecordingEvent<IRecordingListChangeAdd.Props>
Specified by:
getRecordingStartTime in interface IRecordingListChangeSingle<IRecordingListChangeAdd.Props>
Returns:
the recording start time.

getUniqueRecordingID

String getUniqueRecordingID()
Gets the unique ID of the changed recording.

Specified by:
getUniqueRecordingID in interface IRecordingEvent<IRecordingListChangeAdd.Props>
Specified by:
getUniqueRecordingID in interface IRecordingListChangeSingle<IRecordingListChangeAdd.Props>
Returns:
the unique recording ID.
See Also:
EncodingUtils.generateId(Integer, Date)


Copyright © 2008-2013. All Rights Reserved.