Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
kodi::addon::PVRRecording Class Reference
C++ » Interface - kodi::addon » Addon type instances » PVR » Definitions, structures and enumerators » 5. Recording » class PVRRecording

#include <Recordings.h>

Inheritance diagram for kodi::addon::PVRRecording:
kodi::addon::CStructHdl< PVRRecording, PVR_RECORDING >

Public Member Functions

void SetRecordingId (const std::string &recordingId)
 required
Unique identifier of the recording on the client.
 
std::string GetRecordingId () const
 To get with SetRecordingId changed values.
 
void SetTitle (const std::string &title)
 required
The title of this recording.
 
std::string GetTitle () const
 To get with SetTitle changed values.
 
void SetEpisodeName (const std::string &episodeName)
 optional
Episode name (also known as subtitle).
 
std::string GetEpisodeName () const
 To get with SetEpisodeName changed values.
 
void SetSeriesNumber (int seriesNumber)
 optional
Series number (usually called season).
 
int GetSeriesNumber () const
 To get with SetSeriesNumber changed values.
 
void SetEpisodeNumber (int episodeNumber)
 optional
Eepisode number within the "iSeriesNumber" season.
 
int GetEpisodeNumber () const
 To get with SetEpisodeNumber changed values.
 
void SetYear (int year)
 optional
Year of first release (use to identify a specific movie re-make) / first airing for TV shows.
 
int GetYear () const
 To get with SetYear changed values.
 
void SetDirectory (const std::string &directory)
 optional

 
std::string GetDirectory () const
 To get with SetDirectory changed values.
 
void SetPlotOutline (const std::string &plotOutline)
 optional
Plot outline name.
 
std::string GetPlotOutline () const
 To get with SetPlotOutline changed values.
 
void SetPlot (const std::string &plot)
 optional
Plot name.
 
std::string GetPlot () const
 To get with SetPlot changed values.
 
void SetChannelName (const std::string &channelName)
 optional
Channel name.
 
std::string GetChannelName () const
 To get with SetChannelName changed values.
 
void SetIconPath (const std::string &iconPath)
 optional
Channel logo (icon) path.
 
std::string GetIconPath () const
 To get with SetIconPath changed values.
 
void SetThumbnailPath (const std::string &thumbnailPath)
 optional
Thumbnail path.
 
std::string GetThumbnailPath () const
 To get with SetThumbnailPath changed values.
 
void SetFanartPath (const std::string &fanartPath)
 optional
Fanart path.
 
std::string GetFanartPath () const
 To get with SetFanartPath changed values.
 
void SetRecordingTime (time_t recordingTime)
 optional
Start time of the recording.
 
time_t GetRecordingTime () const
 To get with SetRecordingTime changed values.
 
void SetDuration (int duration)
 optional
Duration of the recording in seconds.
 
int GetDuration () const
 To get with SetDuration changed values.
 
void SetPriority (int priority)
 optional
Priority of this recording (from 0 - 100).
 
int GetPriority () const
 To get with SetPriority changed values.
 
void SetLifetime (int lifetime)
 optional
Life time in days of this recording.
 
int GetLifetime () const
 To get with SetLifetime changed values.
 
void SetGenreType (int genreType)
 optional
Genre type.
 
int GetGenreType () const
 To get with SetGenreType changed values.
 
void SetGenreSubType (int genreSubType)
 optional
Genre sub type.
 
int GetGenreSubType () const
 To get with SetGenreSubType changed values.
 
void SetGenreDescription (const std::string &genreDescription)
 optional
To set own genre description name.
 
std::string GetGenreDescription () const
 To get with SetGenreDescription changed values.
 
void SetPlayCount (int playCount)
 optional
Play count of this recording on the client.
 
int GetPlayCount () const
 To get with SetPlayCount changed values.
 
void SetLastPlayedPosition (int lastPlayedPosition)
 optional
Last played position of this recording on the client.
 
int GetLastPlayedPosition () const
 To get with SetLastPlayedPosition changed values.
 
void SetIsDeleted (int isDeleted)
 optional
Shows this recording is deleted and can be undelete.
 
int GetIsDeleted () const
 To get with SetIsDeleted changed values.
 
void SetEPGEventId (unsigned int epgEventId)
 optional
EPG event id associated with this recording. Valid ids must be greater than EPG_TAG_INVALID_UID.
 
unsigned int GetEPGEventId () const
 To get with SetEPGEventId changed values.
 
void SetChannelUid (int channelUid)
 optional
Unique identifier of the channel for this recording. PVR_CHANNEL_INVALID_UID denotes that channel uid is not available.
 
int GetChannelUid () const
 To get with SetChannelUid changed values.
 
void SetChannelType (PVR_RECORDING_CHANNEL_TYPE channelType)
 optional
Channel type.
 
PVR_RECORDING_CHANNEL_TYPE GetChannelType () const
 To get with SetChannelType changed values.
 
void SetFirstAired (const std::string &firstAired)
 optional
First aired date of this recording.
 
std::string GetFirstAired () const
 To get with SetFirstAired changed values.
 
void SetFlags (unsigned int flags)
 optional
Bit field of independent flags associated with the recording.
 
unsigned int GetFlags () const
 To get with SetFlags changed values.
 
void SetSizeInBytes (int64_t sizeInBytes)
 optional
Size of the recording in bytes.
 
int64_t GetSizeInBytes () const
 To get with SetSizeInBytes changed values.
 
void SetClientProviderUid (int iClientProviderUid)
 optional
Unique identifier of the provider this channel belongs to.
 
int GetClientProviderUid () const
 To get with SetClientProviderUid changed values.
 
void SetProviderName (const std::string &providerName)
 optional
Name for the provider of this channel.
 
std::string GetProviderName () const
 To get with SetProviderName changed values.
 
- Public Member Functions inherited from kodi::addon::CStructHdl< PVRRecording, PVR_RECORDING >
 CStructHdl ()
 
 CStructHdl (const PVRRecording &cppClass)
 
 CStructHdl (const PVR_RECORDING *cStructure)
 
 CStructHdl (PVR_RECORDING *cStructure)
 
const CStructHdl & operator= (const CStructHdl &right)
 
const CStructHdl & operator= (const PVR_RECORDING &right)
 
virtual ~CStructHdl ()
 
 operator PVR_RECORDING * ()
 
 operator const PVR_RECORDING * () const
 
const PVR_RECORDING * GetCStructure () const
 

Friends

class CInstancePVRClient
 

Additional Inherited Members

- Protected Attributes inherited from kodi::addon::CStructHdl< PVRRecording, PVR_RECORDING >
PVR_RECORDING * m_cStructure
 

Member Function Documentation

◆ GetClientProviderUid()

int kodi::addon::PVRRecording::GetClientProviderUid ( ) const
inline

To get with SetClientProviderUid changed values.

◆ GetProviderName()

std::string kodi::addon::PVRRecording::GetProviderName ( ) const
inline

To get with SetProviderName changed values.

◆ SetClientProviderUid()

void kodi::addon::PVRRecording::SetClientProviderUid ( int iClientProviderUid)
inline

optional
Unique identifier of the provider this channel belongs to.

PVR_PROVIDER_INVALID_UID denotes that provider uid is not available.

◆ SetProviderName()

void kodi::addon::PVRRecording::SetProviderName ( const std::string & providerName)
inline

optional
Name for the provider of this channel.

Friends And Related Symbol Documentation

◆ CInstancePVRClient

friend class CInstancePVRClient
friend
The documentation for this class was generated from the following file: