Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
CMediaSource Class Referencefinal

Represents a share. More...

#include <MediaSource.h>

Public Member Functions

bool operator== (const CMediaSource &right) const
 
void FromNameAndPaths (const std::string &category, const std::string &name, const std::vector< std::string > &paths)
 
bool IsWritable () const
 

Public Attributes

std::string strName
 Name of the share, can be chosen freely.
 
std::string strStatus
 Status of the share (eg has disk etc.)
 
std::string strDiskUniqueId
 removable:// + DVD Label + DVD ID for resume point storage, if available
 
std::string strPath
 Path of the share, eg. iso9660:// or F:
 
SourceType m_iDriveType = SourceType::UNKNOWN
 The type of the media source.
 
LockMode m_iLockMode = LockMode::EVERYONE
 The type of Lock UI to show when accessing the media source.
 
std::string m_strLockCode
 Input code for Lock UI to verify, can be chosen freely.
 
int m_iHasLock = LOCK_STATE_NO_LOCK
 
int m_iBadPwdCount = 0
 Number of wrong passwords user has entered since share was last unlocked.
 
std::string m_strThumbnailImage
 Path to a thumbnail image for the share, or blank for default.
 
std::vector< std::string > vecPaths
 
bool m_ignore = false
 
bool m_allowSharing = true
 <Do not store in xml
 

Detailed Description

Represents a share.

See also
VECMediaSource, std::vector<CMediaSource>::iterator

Member Function Documentation

◆ FromNameAndPaths()

void CMediaSource::FromNameAndPaths ( const std::string & category,
const std::string & name,
const std::vector< std::string > & paths )

◆ IsWritable()

bool CMediaSource::IsWritable ( ) const

◆ operator==()

bool CMediaSource::operator== ( const CMediaSource & right) const

Member Data Documentation

◆ m_allowSharing

bool CMediaSource::m_allowSharing = true

<Do not store in xml

◆ m_iBadPwdCount

int CMediaSource::m_iBadPwdCount = 0

Number of wrong passwords user has entered since share was last unlocked.

◆ m_iDriveType

SourceType CMediaSource::m_iDriveType = SourceType::UNKNOWN

The type of the media source.

Value can be:

  • SOURCE_TYPE_UNKNOWN
    Unknown source, maybe a wrong path.
  • SOURCE_TYPE_LOCAL
    Harddisk source.
  • SOURCE_TYPE_OPTICAL_DISC
    DVD-ROM source of the build in drive, strPath may vary.
  • SOURCE_TYPE_VIRTUAL_OPTICAL_DISC
    DVD-ROM source, strPath is fix.
  • SOURCE_TYPE_REMOTE
    Network source.

◆ m_ignore

bool CMediaSource::m_ignore = false

◆ m_iHasLock

int CMediaSource::m_iHasLock = LOCK_STATE_NO_LOCK

◆ m_iLockMode

LockMode CMediaSource::m_iLockMode = LockMode::EVERYONE

The type of Lock UI to show when accessing the media source.

Value can be:

◆ m_strLockCode

std::string CMediaSource::m_strLockCode

Input code for Lock UI to verify, can be chosen freely.

◆ m_strThumbnailImage

std::string CMediaSource::m_strThumbnailImage

Path to a thumbnail image for the share, or blank for default.

◆ strDiskUniqueId

std::string CMediaSource::strDiskUniqueId

removable:// + DVD Label + DVD ID for resume point storage, if available

◆ strName

std::string CMediaSource::strName

Name of the share, can be chosen freely.

◆ strPath

std::string CMediaSource::strPath

Path of the share, eg. iso9660:// or F:

◆ strStatus

std::string CMediaSource::strStatus

Status of the share (eg has disk etc.)

◆ vecPaths

std::vector<std::string> CMediaSource::vecPaths

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