kodi
Public Member Functions | List of all members
CWin32DiscDriveHandler Class Reference
Inheritance diagram for CWin32DiscDriveHandler:
Inheritance graph
[legend]
Collaboration diagram for CWin32DiscDriveHandler:
Collaboration graph
[legend]

Public Member Functions

 CWin32DiscDriveHandler ()=default
 Win32 DiscDriveHandler constructor.
 
 ~CWin32DiscDriveHandler () override=default
 Win32 DiscDriveHandler destructor.
 
DriveState GetDriveState (const std::string &devicePath) override
 Get the optical drive state provided its device path. More...
 
TrayState GetTrayState (const std::string &devicePath) override
 Get the optical drive tray state provided the drive device path. More...
 
void EjectDriveTray (const std::string &devicePath) override
 Eject the provided drive device. More...
 
void CloseDriveTray (const std::string &devicePath) override
 Close the provided drive device. More...
 
void ToggleDriveTray (const std::string &devicePath) override
 Toggle the state of a given drive device. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IDiscDriveHandler
static std::shared_ptr< IDiscDriveHandlerCreateInstance ()
 Called to create platform-specific disc drive handler. More...
 

Member Function Documentation

◆ CloseDriveTray()

void CWin32DiscDriveHandler::CloseDriveTray ( const std::string &  devicePath)
overridevirtual

Close the provided drive device.

Note
Some drives support closing appart from opening/eject
Parameters
devicePaththe path for the device drive (e.g. D\://)

Implements IDiscDriveHandler.

◆ EjectDriveTray()

void CWin32DiscDriveHandler::EjectDriveTray ( const std::string &  devicePath)
overridevirtual

Eject the provided drive device.

Parameters
devicePaththe path for the device drive (e.g. D\://)

Implements IDiscDriveHandler.

◆ GetDriveState()

DriveState CWin32DiscDriveHandler::GetDriveState ( const std::string &  devicePath)
overridevirtual

Get the optical drive state provided its device path.

Parameters
devicePaththe path for the device drive (e.g. D\://)
Returns
The drive state

Implements IDiscDriveHandler.

◆ GetTrayState()

TrayState CWin32DiscDriveHandler::GetTrayState ( const std::string &  devicePath)
overridevirtual

Get the optical drive tray state provided the drive device path.

Parameters
devicePaththe path for the device drive (e.g. D\://)
Returns
The drive state

Implements IDiscDriveHandler.

◆ ToggleDriveTray()

void CWin32DiscDriveHandler::ToggleDriveTray ( const std::string &  devicePath)
overridevirtual

Toggle the state of a given drive device.

Parameters
devicePaththe path for the device drive (e.g. D\://)

Implements IDiscDriveHandler.


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