Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches

Times of playing stream (Live TV and recordings)
This class is used to transfer the necessary data when kodi::addon::PVRStreamProperties::GetStreamTimes is called. More...

Classes

class  kodi::addon::PVRStreamTimes
 

Functions

void kodi::addon::PVRStreamTimes::SetStartTime (time_t startTime)
 For recordings, this must be zero. For Live TV, this is a reference time in units of time_t (UTC) from which time elapsed starts. Ideally start of tv show, but can be any other value.
 
time_t kodi::addon::PVRStreamTimes::GetStartTime () const
 To get with SetStartTime() changed values.
 
void kodi::addon::PVRStreamTimes::SetPTSStart (int64_t ptsStart)
 The pts of startTime.
 
int64_t kodi::addon::PVRStreamTimes::GetPTSStart () const
 To get with SetPTSStart() changed values.
 
void kodi::addon::PVRStreamTimes::SetPTSBegin (int64_t ptsBegin)
 Earliest pts player can seek back. Value is in micro seconds, relative to PTS start. For recordings, this must be zero. For Live TV, this must be zero if not timeshifting and must point to begin of the timeshift buffer, otherwise.
 
int64_t kodi::addon::PVRStreamTimes::GetPTSBegin () const
 To get with SetPTSBegin() changed values.
 
void kodi::addon::PVRStreamTimes::SetPTSEnd (int64_t ptsEnd)
 Latest pts player can seek forward. Value is in micro seconds, relative to PTS start. For recordings, this must be the total length. For Live TV, this must be zero if not timeshifting and must point to end of the timeshift buffer, otherwise.
 
int64_t kodi::addon::PVRStreamTimes::GetPTSEnd () const
 To get with SetPTSEnd() changed values.
 

Detailed Description

Times of playing stream (Live TV and recordings)
This class is used to transfer the necessary data when kodi::addon::PVRStreamProperties::GetStreamTimes is called.


@ingroup cpp_kodi_addon_pvr_Defs_Stream_PVRStreamTimes

The following table contains values that can be set with class PVRStreamTimes :

Name Type Set call Get call
Start time time_t SetStartTime GetStartTime
PTS start int64_t SetPTSStart GetPTSStart
PTS begin int64_t SetPTSBegin GetPTSBegin
PTS end int64_t SetPTSEnd GetPTSEnd

Function Documentation

◆ GetPTSBegin()

int64_t kodi::addon::PVRStreamTimes::GetPTSBegin ( ) const
inline

To get with SetPTSBegin() changed values.

◆ GetPTSEnd()

int64_t kodi::addon::PVRStreamTimes::GetPTSEnd ( ) const
inline

To get with SetPTSEnd() changed values.

◆ GetPTSStart()

int64_t kodi::addon::PVRStreamTimes::GetPTSStart ( ) const
inline

To get with SetPTSStart() changed values.

◆ GetStartTime()

time_t kodi::addon::PVRStreamTimes::GetStartTime ( ) const
inline

To get with SetStartTime() changed values.

◆ SetPTSBegin()

void kodi::addon::PVRStreamTimes::SetPTSBegin ( int64_t ptsBegin)
inline

Earliest pts player can seek back. Value is in micro seconds, relative to PTS start. For recordings, this must be zero. For Live TV, this must be zero if not timeshifting and must point to begin of the timeshift buffer, otherwise.

◆ SetPTSEnd()

void kodi::addon::PVRStreamTimes::SetPTSEnd ( int64_t ptsEnd)
inline

Latest pts player can seek forward. Value is in micro seconds, relative to PTS start. For recordings, this must be the total length. For Live TV, this must be zero if not timeshifting and must point to end of the timeshift buffer, otherwise.

◆ SetPTSStart()

void kodi::addon::PVRStreamTimes::SetPTSStart ( int64_t ptsStart)
inline

The pts of startTime.

◆ SetStartTime()

void kodi::addon::PVRStreamTimes::SetStartTime ( time_t startTime)
inline

For recordings, this must be zero. For Live TV, this is a reference time in units of time_t (UTC) from which time elapsed starts. Ideally start of tv show, but can be any other value.