Kodi Docs 20.0
Kodi is an open source media player and entertainment hub.

Cache information status
Used on kodi::vfs::CFile::IoControlGetCacheStatus() to get running cache status of processed stream. More...

Classes

class  kodi::vfs::CacheStatus
 

Functions

void kodi::vfs::CacheStatus::SetForward (uint64_t forward)
 Set number of bytes cached forward of current position. More...
 
uint64_t kodi::vfs::CacheStatus::GetForward ()
 Get number of bytes cached forward of current position. More...
 
void kodi::vfs::CacheStatus::SetMaxRate (unsigned int maxrate)
 Set maximum number of bytes per second cache is allowed to fill. More...
 
unsigned int kodi::vfs::CacheStatus::GetMaxRate ()
 Set maximum number of bytes per second cache is allowed to fill. More...
 
void kodi::vfs::CacheStatus::SetCurrentRate (unsigned int currate)
 Set average read rate from source file since last position change. More...
 
unsigned int kodi::vfs::CacheStatus::GetCurrentRate ()
 Get average read rate from source file since last position change. More...
 
void kodi::vfs::CacheStatus::SetLowspeed (bool lowspeed)
 Set cache low speed condition detected. More...
 
bool kodi::vfs::CacheStatus::GetLowspeed ()
 Get cache low speed condition detected. More...
 

Detailed Description

Cache information status
Used on kodi::vfs::CFile::IoControlGetCacheStatus() to get running cache status of processed stream.

@ingroup cpp_kodi_vfs_Defs_CacheStatus

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

Name Type Set call Get call
Number of bytes cached uint64_t SetForward GetForward
Maximum number of bytes per second unsigned int SetMaxRate GetMaxRate
Average read rate from source file unsigned int SetCurrentRate GetCurrentRate
Cache low speed condition detected bool SetLowspeed GetLowspeed

Function Documentation

◆ GetCurrentRate()

unsigned int kodi::vfs::CacheStatus::GetCurrentRate ( )
inline

Get average read rate from source file since last position change.

◆ GetForward()

uint64_t kodi::vfs::CacheStatus::GetForward ( )
inline

Get number of bytes cached forward of current position.

◆ GetLowspeed()

bool kodi::vfs::CacheStatus::GetLowspeed ( )
inline

Get cache low speed condition detected.

◆ GetMaxRate()

unsigned int kodi::vfs::CacheStatus::GetMaxRate ( )
inline

Set maximum number of bytes per second cache is allowed to fill.

◆ SetCurrentRate()

void kodi::vfs::CacheStatus::SetCurrentRate ( unsigned int  currate)
inline

Set average read rate from source file since last position change.

◆ SetForward()

void kodi::vfs::CacheStatus::SetForward ( uint64_t  forward)
inline

Set number of bytes cached forward of current position.

◆ SetLowspeed()

void kodi::vfs::CacheStatus::SetLowspeed ( bool  lowspeed)
inline

Set cache low speed condition detected.

◆ SetMaxRate()

void kodi::vfs::CacheStatus::SetMaxRate ( unsigned int  maxrate)
inline

Set maximum number of bytes per second cache is allowed to fill.