class CacheStatus

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.
uint64_t	kodi::vfs::CacheStatus::GetForward ()
	Get number of bytes cached forward of current position.
void	kodi::vfs::CacheStatus::SetMaxRate (uint32_t maxrate)
	Set maximum number of bytes per second cache is allowed to fill.
uint32_t	kodi::vfs::CacheStatus::GetMaxRate ()
	Set maximum number of bytes per second cache is allowed to fill.
void	kodi::vfs::CacheStatus::SetCurrentRate (uint32_t currate)
	Set number of bytes per second for average read rate from source file since last position change.
uint32_t	kodi::vfs::CacheStatus::GetCurrentRate ()
	Get number of bytes per second for average read rate from source file since last position change.
void	kodi::vfs::CacheStatus::SetLowRate (uint32_t lowrate)
	Set number of bytes per second for low speed rate.
uint32_t	kodi::vfs::CacheStatus::GetLowRate ()
	Get number of bytes per second for low speed rate.

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	uint32_t	SetMaxRate	GetMaxRate
Average read rate from source file	uint32_t	SetCurrentRate	GetCurrentRate
Cache low speed rate detected	uint32_t	SetLowRate	GetLowRate

Function Documentation

GetCurrentRate()

uint32_t kodi::vfs::CacheStatus::GetCurrentRate ( )

inline

Get number of bytes per second for 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.

GetLowRate()

uint32_t kodi::vfs::CacheStatus::GetLowRate ( )

inline

Get number of bytes per second for low speed rate.

GetMaxRate()

uint32_t kodi::vfs::CacheStatus::GetMaxRate ( )

inline

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

SetCurrentRate()

void kodi::vfs::CacheStatus::SetCurrentRate ( uint32_t currate )

inline

Set number of bytes per second for 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.

SetLowRate()

void kodi::vfs::CacheStatus::SetLowRate ( uint32_t lowrate )

inline

Set number of bytes per second for low speed rate.

SetMaxRate()

void kodi::vfs::CacheStatus::SetMaxRate ( uint32_t maxrate )

inline

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