#include <MediaManager.h>

Inheritance diagram for CMediaManager:

Public Types
enum class	HasBlurayPlaylist : uint8_t { YES , NO , UNKNOWN }

Public Member Functions
	CMediaManager ()

void	Initialize ()

void	Stop ()

void	ScanForPresentMedia ()

void	LoadSources ()

bool	SaveSources ()

void	GetLocalDrives (std::vector< CMediaSource > &localDrives, bool includeQ=true)

void	GetRemovableDrives (std::vector< CMediaSource > &removableDrives)

void	GetNetworkLocations (std::vector< CMediaSource > &locations, bool autolocations=true)

bool	AddNetworkLocation (const std::string &path)

bool	HasLocation (const std::string &path) const

bool	RemoveLocation (const std::string &path)

bool	SetLocationPath (const std::string &oldPath, const std::string &newPath)

void	AddAutoSource (const CMediaSource &share, bool bAutorun=false)

void	RemoveAutoSource (const CMediaSource &share)

bool	IsDiscInDrive (const std::string &devicePath="")

bool	IsAudio (const std::string &devicePath="", bool allowCachedFailure=false)
	Whether the disc in a drive is an audio CD.

bool	HasOpticalDrive ()

std::string	TranslateDevicePath (const std::string &devicePath, bool bReturnAsDevice=false)

DriveState	GetDriveStatus (const std::string &devicePath="")

void	ResetDriveCaches (const std::string &devicePath="")
	Discard everything cached about a drive, so the next query asks the hardware again.

std::string	GetDiscPath ()

void	SetHasOpticalDrive (bool bstatus)

bool	Eject (const std::string &mountpath)

void	EjectTray (bool bEject=true, const std::string &devicePath="")
	Eject or close the tray of an optical drive.

void	CloseTray (const std::string &devicePath="")
	Close the tray of an optical drive.

void	ToggleTray (const std::string &devicePath="")
	Eject the tray of an optical drive, or close it when already open.

void	ProcessEvents ()

std::vector< std::string >	GetDiskUsage ()

void	OnStorageAdded (const MEDIA_DETECT::STORAGE::StorageDevice &device) override
	Callback executed when a new storage device is added.

void	OnStorageSafelyRemoved (const MEDIA_DETECT::STORAGE::StorageDevice &device) override
	Callback executed when a new storage device is safely removed.

void	OnStorageUnsafelyRemoved (const MEDIA_DETECT::STORAGE::StorageDevice &device) override
	Callback executed when a new storage device is unsafely removed.

void	OnJobComplete (unsigned int jobID, bool success, CJob *job) override
	The callback used when a job completes.

bool	playStubFile (const CFileItem &item)

UTILS::DISCS::DiscInfo	GetDiscInfo (const std::string &mediaPath)

Public Member Functions inherited from IStorageEventsCallback
virtual	~IStorageEventsCallback ()=default

Public Member Functions inherited from IJobCallback
virtual	~IJobCallback ()=default
	Destructor for job call back objects.

virtual void	OnJobAbort (unsigned int jobID, CJob *job)
	An optional callback function used when a job will be aborted.

virtual void	OnJobProgress (unsigned int jobID, unsigned int progress, unsigned int total, const CJob *job)
	An optional callback function that a job may call while processing.

Protected Attributes
std::vector< CNetworkLocation >	m_locations

CCriticalSection	m_muAutoSource

CCriticalSection	m_CritSecStorageProvider

bool	m_bOpticalDrivePresent

std::string	m_strFirstAvailDrive

Member Enumeration Documentation

◆ HasBlurayPlaylist

enum class CMediaManager::HasBlurayPlaylist : uint8_t

strong

Enumerator
YES
NO
UNKNOWN

Constructor & Destructor Documentation

◆ CMediaManager()

CMediaManager::CMediaManager ( )

Member Function Documentation

◆ AddAutoSource()

void CMediaManager::AddAutoSource	(	const CMediaSource &	share,
		bool	bAutorun = false )

◆ AddNetworkLocation()

bool CMediaManager::AddNetworkLocation ( const std::string & path )

◆ CloseTray()

void CMediaManager::CloseTray ( const std::string & devicePath = "" )

Close the tray of an optical drive.

Parameters

devicePath Path of the drive, empty for the first available optical drive

◆ Eject()

bool CMediaManager::Eject ( const std::string & mountpath )

◆ EjectTray()

void CMediaManager::EjectTray	(	bool	bEject = true,
		const std::string &	devicePath = "" )

Eject or close the tray of an optical drive.

Parameters

bEject	True to eject the tray, false to close it
devicePath	Path of the drive, empty for the first available optical drive

◆ GetDiscInfo()

UTILS::DISCS::DiscInfo CMediaManager::GetDiscInfo ( const std::string & mediaPath )

◆ GetDiscPath()

std::string CMediaManager::GetDiscPath ( )

◆ GetDiskUsage()

std::vector< std::string > CMediaManager::GetDiskUsage ( )

◆ GetDriveStatus()

DriveState CMediaManager::GetDriveStatus ( const std::string & devicePath = "" )

◆ GetLocalDrives()

void CMediaManager::GetLocalDrives	(	std::vector< CMediaSource > &	localDrives,
		bool	includeQ = true )

◆ GetNetworkLocations()

void CMediaManager::GetNetworkLocations	(	std::vector< CMediaSource > &	locations,
		bool	autolocations = true )

◆ GetRemovableDrives()

void CMediaManager::GetRemovableDrives ( std::vector< CMediaSource > & removableDrives )

◆ HasLocation()

bool CMediaManager::HasLocation ( const std::string & path ) const

◆ HasOpticalDrive()

bool CMediaManager::HasOpticalDrive ( )

◆ Initialize()

void CMediaManager::Initialize ( )

◆ IsAudio()

bool CMediaManager::IsAudio	(	const std::string &	devicePath = "",
		bool	allowCachedFailure = false )

Whether the disc in a drive is an audio CD.

Parameters

allowCachedFailure Allow GUI polling to reuse a recent failed TOC read on Windows. Explicit actions such as ripping must leave this false so they read the disc again.

◆ IsDiscInDrive()

bool CMediaManager::IsDiscInDrive ( const std::string & devicePath = "" )

◆ LoadSources()

void CMediaManager::LoadSources ( )

◆ OnJobComplete()

void CMediaManager::OnJobComplete	(	unsigned int	jobID,
		bool	success,
		CJob *	job )

inlineoverridevirtual

The callback used when a job completes.

OnJobComplete is called at the completion of the job's DoWork() function, and is used to return information to the caller on the result of the job. On returning form this function the CJobManager will destroy this job.

Parameters

jobID	the unique id of the job (as retrieved from CJobManager::AddJob)
success	the result from the DoWork call
job	the job that has been processed. The job will be destroyed after this function returns

See also: CJobManager and CJob

Implements IJobCallback.

◆ OnStorageAdded()

void CMediaManager::OnStorageAdded ( const MEDIA_DETECT::STORAGE::StorageDevice & device )

overridevirtual

Callback executed when a new storage device is added.

See also: IStorageEventsCallback

Parameters

device the storage device

Implements IStorageEventsCallback.

◆ OnStorageSafelyRemoved()

void CMediaManager::OnStorageSafelyRemoved ( const MEDIA_DETECT::STORAGE::StorageDevice & device )

overridevirtual

Callback executed when a new storage device is safely removed.

See also: IStorageEventsCallback

Parameters

device the storage device

Implements IStorageEventsCallback.

◆ OnStorageUnsafelyRemoved()

void CMediaManager::OnStorageUnsafelyRemoved ( const MEDIA_DETECT::STORAGE::StorageDevice & device )

overridevirtual

Callback executed when a new storage device is unsafely removed.

See also: IStorageEventsCallback

Parameters

device the storage device

Implements IStorageEventsCallback.

◆ playStubFile()

bool CMediaManager::playStubFile ( const CFileItem & item )

◆ ProcessEvents()

void CMediaManager::ProcessEvents ( )

◆ RemoveAutoSource()

void CMediaManager::RemoveAutoSource ( const CMediaSource & share )

◆ RemoveLocation()

bool CMediaManager::RemoveLocation ( const std::string & path )

◆ ResetDriveCaches()

void CMediaManager::ResetDriveCaches ( const std::string & devicePath = "" )

Discard everything cached about a drive, so the next query asks the hardware again.

Parameters

devicePath The optical drive path, empty for every drive

◆ SaveSources()

bool CMediaManager::SaveSources ( )

◆ ScanForPresentMedia()

void CMediaManager::ScanForPresentMedia ( )

◆ SetHasOpticalDrive()

void CMediaManager::SetHasOpticalDrive ( bool bstatus )

◆ SetLocationPath()

bool CMediaManager::SetLocationPath	(	const std::string &	oldPath,
		const std::string &	newPath )

◆ Stop()

void CMediaManager::Stop ( )

◆ ToggleTray()

void CMediaManager::ToggleTray ( const std::string & devicePath = "" )

Eject the tray of an optical drive, or close it when already open.

Parameters

devicePath Path of the drive, empty for the first available optical drive

◆ TranslateDevicePath()

std::string CMediaManager::TranslateDevicePath	(	const std::string &	devicePath,
		bool	bReturnAsDevice = false )

Member Data Documentation

◆ m_bOpticalDrivePresent

bool CMediaManager::m_bOpticalDrivePresent

protected

◆ m_CritSecStorageProvider

CCriticalSection CMediaManager::m_CritSecStorageProvider

protected

◆ m_locations

std::vector<CNetworkLocation> CMediaManager::m_locations

protected

◆ m_muAutoSource

CCriticalSection CMediaManager::m_muAutoSource

protected

◆ m_strFirstAvailDrive

std::string CMediaManager::m_strFirstAvailDrive

protected

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

Public Types

Public Member Functions

Protected Attributes

Member Enumeration Documentation

◆ HasBlurayPlaylist

Constructor & Destructor Documentation

◆ CMediaManager()

Member Function Documentation

◆ AddAutoSource()

◆ AddNetworkLocation()

◆ CloseTray()

◆ Eject()

◆ EjectTray()

◆ GetDiscInfo()

◆ GetDiscPath()

◆ GetDiskUsage()

◆ GetDriveStatus()

◆ GetLocalDrives()

◆ GetNetworkLocations()

◆ GetRemovableDrives()

◆ HasLocation()

◆ HasOpticalDrive()

◆ Initialize()

◆ IsAudio()

◆ IsDiscInDrive()

◆ LoadSources()

◆ OnJobComplete()

◆ OnStorageAdded()

◆ OnStorageSafelyRemoved()

◆ OnStorageUnsafelyRemoved()

◆ playStubFile()

◆ ProcessEvents()

◆ RemoveAutoSource()

◆ RemoveLocation()

◆ ResetDriveCaches()

◆ SaveSources()

◆ ScanForPresentMedia()

◆ SetHasOpticalDrive()

◆ SetLocationPath()

◆ Stop()

◆ ToggleTray()

◆ TranslateDevicePath()

Member Data Documentation

◆ m_bOpticalDrivePresent

◆ m_CritSecStorageProvider

◆ m_locations

◆ m_muAutoSource

◆ m_strFirstAvailDrive