Inherits DynamicCStructHdl< PVRRecording, PVR_RECORDING >.

Public Member Functions
std::string	GetChannelName () const
	To get with SetChannelName changed values.

PVR_RECORDING_CHANNEL_TYPE	GetChannelType () const
	To get with SetChannelType changed values.

int	GetChannelUid () const
	To get with SetChannelUid changed values.

int	GetClientProviderUid () const
	To get with SetClientProviderUid changed values.

std::string	GetDirectory () const
	To get with SetDirectory changed values.

int	GetDuration () const
	To get with SetDuration changed values.

unsigned int	GetEPGEventId () const
	To get with SetEPGEventId changed values.

std::string	GetEpisodeName () const
	To get with SetEpisodeName changed values.

int	GetEpisodeNumber () const
	To get with SetEpisodeNumber changed values.

int	GetEpisodePartNumber () const
	To get with SetEpisodePartNumber changed values.

std::string	GetFanartPath () const
	To get with SetFanartPath changed values.

std::string	GetFirstAired () const
	To get with SetFirstAired changed values.

unsigned int	GetFlags () const
	To get with SetFlags changed values.

std::string	GetGenreDescription () const
	To get with SetGenreDescription changed values.

int	GetGenreSubType () const
	To get with SetGenreSubType changed values.

int	GetGenreType () const
	To get with SetGenreType changed values.

std::string	GetIconPath () const
	To get with SetIconPath changed values.

int	GetIsDeleted () const
	To get with SetIsDeleted changed values.

int	GetLastPlayedPosition () const
	To get with SetLastPlayedPosition changed values.

int	GetLifetime () const
	To get with SetLifetime changed values.

unsigned int	GetParentalRating () const
	To get with SetParentalRating changed values.

std::string	GetParentalRatingCode () const
	To get with SetParentalRatingCode changed values.

std::string	GetParentalRatingIcon () const
	To get with SetParentalRatingIcon changed values.

std::string	GetParentalRatingSource () const
	To get with SetParentalRatingSource changed values.

int	GetPlayCount () const
	To get with SetPlayCount changed values.

std::string	GetPlot () const
	To get with SetPlot changed values.

std::string	GetPlotOutline () const
	To get with SetPlotOutline changed values.

int	GetPriority () const
	To get with SetPriority changed values.

std::string	GetProviderName () const
	To get with SetProviderName changed values.

std::string	GetRecordingId () const
	To get with SetRecordingId changed values.

time_t	GetRecordingTime () const
	To get with SetRecordingTime changed values.

int	GetSeriesNumber () const
	To get with SetSeriesNumber changed values.

int64_t	GetSizeInBytes () const
	To get with SetSizeInBytes changed values.

std::string	GetThumbnailPath () const
	To get with SetThumbnailPath changed values.

std::string	GetTitle () const
	To get with SetTitle changed values.

std::string	GetTitleExtraInfo () const
	To get with SetTitleExtraInfo changed values.

int	GetYear () const
	To get with SetYear changed values.

void	SetChannelName (const std::string &channelName)
	optional Channel name.

void	SetChannelType (PVR_RECORDING_CHANNEL_TYPE channelType)
	optional Channel type.

void	SetChannelUid (int channelUid)
	optional Unique identifier of the channel for this recording. PVR_CHANNEL_INVALID_UID denotes that channel uid is not available.

void	SetClientProviderUid (int iClientProviderUid)
	optional Unique identifier of the provider this channel belongs to.

void	SetDirectory (const std::string &directory)
	optional

void	SetDuration (int duration)
	optional Duration of the recording in seconds.

void	SetEPGEventId (unsigned int epgEventId)
	optional EPG event id associated with this recording. Valid ids must be greater than EPG_TAG_INVALID_UID.

void	SetEpisodeName (const std::string &episodeName)
	optional Episode name (also known as subtitle).

void	SetEpisodeNumber (int episodeNumber)
	optional Eepisode number within the "iSeriesNumber" season.

void	SetEpisodePartNumber (int episodePartNumber)
	optional Episode part number.

void	SetFanartPath (const std::string &fanartPath)
	optional Fanart path.

void	SetFirstAired (const std::string &firstAired)
	optional First aired date of this recording.

void	SetFlags (unsigned int flags)
	optional Bit field of independent flags associated with the recording.

void	SetGenreDescription (const std::string &genreDescription)
	optional To set own genre description name.

void	SetGenreSubType (int genreSubType)
	optional Genre sub type.

void	SetGenreType (int genreType)
	optional Genre type.

void	SetIconPath (const std::string &iconPath)
	optional Channel logo (icon) path.

void	SetIsDeleted (int isDeleted)
	optional Shows this recording is deleted and can be undelete.

void	SetLastPlayedPosition (int lastPlayedPosition)
	optional Last played position of this recording on the client.

void	SetLifetime (int lifetime)
	optional Life time in days of this recording.

void	SetParentalRating (unsigned int iParentalRating)
	optional Age rating for the recording.

void	SetParentalRatingCode (const std::string &ratingCode)
	optional Parental rating code for this recording.

void	SetParentalRatingIcon (const std::string &ratingIcon)
	optional Parental rating icon for this recording.

void	SetParentalRatingSource (const std::string &ratingSource)
	optional Parental rating source for this recording.

void	SetPlayCount (int playCount)
	optional Play count of this recording on the client.

void	SetPlot (const std::string &plot)
	optional Plot name.

void	SetPlotOutline (const std::string &plotOutline)
	optional Plot outline name.

void	SetPriority (int priority)
	optional Priority of this recording (from 0 - 100).

void	SetProviderName (const std::string &providerName)
	optional Name for the provider of this channel.

void	SetRecordingId (const std::string &recordingId)
	required Unique identifier of the recording on the client.

void	SetRecordingTime (time_t recordingTime)
	optional Start time of the recording.

void	SetSeriesNumber (int seriesNumber)
	optional Series number (usually called season).

void	SetSizeInBytes (int64_t sizeInBytes)
	optional Size of the recording in bytes.

void	SetThumbnailPath (const std::string &thumbnailPath)
	optional Thumbnail path.

void	SetTitle (const std::string &title)
	required The title of this recording.

void	SetTitleExtraInfo (const std::string &titleExtraInfo)
	optional The title extra information of this recording.

void	SetYear (int year)
	optional Year of first release (use to identify a specific movie re-make) / first airing for TV shows.

Public Member Functions inherited from DynamicCStructHdl< PVRRecording, PVR_RECORDING >
	DynamicCStructHdl (const DynamicCStructHdl &cppClass)

	DynamicCStructHdl (const PVR_RECORDING *cStructure)

	DynamicCStructHdl (PVR_RECORDING *cStructure)

const PVR_RECORDING *	GetCStructure () const

	operator const PVR_RECORDING * () const

	operator PVR_RECORDING * ()

const DynamicCStructHdl &	operator= (const DynamicCStructHdl &right)

const DynamicCStructHdl &	operator= (const PVR_RECORDING &right)

PVR_RECORDING *	release ()

Static Public Member Functions
static void	AllocResources (const PVR_RECORDING source, PVR_RECORDING target)

static void	FreeResources (PVR_RECORDING *target)

Friends
class	CInstancePVRClient

Additional Inherited Members
Protected Attributes inherited from DynamicCStructHdl< PVRRecording, PVR_RECORDING >
PVR_RECORDING *	m_cStructure

Member Function Documentation

◆ SetClientProviderUid()

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

◆ GetClientProviderUid()

int GetClientProviderUid ( ) const

inline

To get with SetClientProviderUid changed values.

◆ SetProviderName()

void SetProviderName ( const std::string & providerName )

inline

optional
Name for the provider of this channel.

◆ GetProviderName()

std::string GetProviderName ( ) const

inline

To get with SetProviderName changed values.

◆ SetParentalRating()

void SetParentalRating ( unsigned int iParentalRating )

inline

optional
Age rating for the recording.

◆ GetParentalRating()

unsigned int GetParentalRating ( ) const

inline

To get with SetParentalRating changed values.

◆ SetParentalRatingCode()

void SetParentalRatingCode ( const std::string & ratingCode )

inline

optional
Parental rating code for this recording.

◆ GetParentalRatingCode()

std::string GetParentalRatingCode ( ) const

inline

To get with SetParentalRatingCode changed values.

◆ SetParentalRatingIcon()

void SetParentalRatingIcon ( const std::string & ratingIcon )

inline

optional
Parental rating icon for this recording.

◆ GetParentalRatingIcon()

std::string GetParentalRatingIcon ( ) const

inline

To get with SetParentalRatingIcon changed values.

◆ SetParentalRatingSource()

void SetParentalRatingSource ( const std::string & ratingSource )

inline

optional
Parental rating source for this recording.

◆ GetParentalRatingSource()

std::string GetParentalRatingSource ( ) const

inline

To get with SetParentalRatingSource changed values.

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

/github/workspace/xbmc/addons/kodi-dev-kit/include/kodi/addon-instance/pvr/Recordings.h

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Member Function Documentation

◆ SetClientProviderUid()

◆ GetClientProviderUid()

◆ SetProviderName()

◆ GetProviderName()

◆ SetParentalRating()

◆ GetParentalRating()

◆ SetParentalRatingCode()

◆ GetParentalRatingCode()

◆ SetParentalRatingIcon()

◆ GetParentalRatingIcon()

◆ SetParentalRatingSource()

◆ GetParentalRatingSource()