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

#include <UDisksProvider.h>

Public Member Functions

 CUDiskDevice (const char *DeviceKitUDI)
 
 ~CUDiskDevice ()=default
 
void Update ()
 
bool Mount ()
 
bool UnMount ()
 
bool IsApproved () const
 Check if the device is approved/whitelisted.
 
MEDIA_DETECT::STORAGE::Type GetStorageType () const
 Get the storage type of this device.
 
bool IsOptical () const
 Check if the device is optical.
 
bool IsMounted () const
 Check if the device is mounted.
 
bool IsSystemInternal () const
 Check if the device is internal to the system.
 
const std::string & GetDisplayName () const
 Get the device display name/label.
 
const std::string & GetMountPoint () const
 Get the device mount point.
 
std::string ToString () const
 Get a representation of the device as a readable string.
 
CMediaSource ToMediaShare () const
 Get a representation of the device as a media share.
 
MEDIA_DETECT::STORAGE::StorageDevice ToStorageDevice () const
 Get a representation of the device as a storage device abstraction.
 

Constructor & Destructor Documentation

◆ CUDiskDevice()

CUDiskDevice::CUDiskDevice ( const char * DeviceKitUDI)

◆ ~CUDiskDevice()

CUDiskDevice::~CUDiskDevice ( )
default

Member Function Documentation

◆ GetDisplayName()

const std::string & CUDiskDevice::GetDisplayName ( ) const
inline

Get the device display name/label.

Returns
the device display name/label

◆ GetMountPoint()

const std::string & CUDiskDevice::GetMountPoint ( ) const
inline

Get the device mount point.

Returns
the device mount point

◆ GetStorageType()

MEDIA_DETECT::STORAGE::Type CUDiskDevice::GetStorageType ( ) const

Get the storage type of this device.

Returns
the storage type (e.g. OPTICAL) or UNKNOWN if the type couldn't be detected

◆ IsApproved()

bool CUDiskDevice::IsApproved ( ) const

Check if the device is approved/whitelisted.

Returns
true if the device is approved/whitelisted, false otherwise

◆ IsMounted()

bool CUDiskDevice::IsMounted ( ) const

Check if the device is mounted.

Returns
true if the device is mounted, false otherwise

◆ IsOptical()

bool CUDiskDevice::IsOptical ( ) const

Check if the device is optical.

Returns
true if the device is optical, false otherwise

◆ IsSystemInternal()

bool CUDiskDevice::IsSystemInternal ( ) const

Check if the device is internal to the system.

Returns
true if the device is internal to the system, false otherwise

◆ Mount()

bool CUDiskDevice::Mount ( )

◆ ToMediaShare()

CMediaSource CUDiskDevice::ToMediaShare ( ) const

Get a representation of the device as a media share.

Returns
the media share

◆ ToStorageDevice()

MEDIA_DETECT::STORAGE::StorageDevice CUDiskDevice::ToStorageDevice ( ) const

Get a representation of the device as a storage device abstraction.

Returns
the storage device abstraction of the device

◆ ToString()

std::string CUDiskDevice::ToString ( ) const

Get a representation of the device as a readable string.

Returns
device as a string

◆ UnMount()

bool CUDiskDevice::UnMount ( )

◆ Update()

void CUDiskDevice::Update ( )

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