digiKam
DigikamGenericMediaServerPlugin::DMediaServerMngr Class Reference
+ Inheritance diagram for DigikamGenericMediaServerPlugin::DMediaServerMngr:

Public Member Functions

int albumsShared () const
 Return some stats about total albums and total items shared on the network. More...
 
void cleanUp ()
 Stop the DLNA server and clean-up. More...
 
MediaServerMap collectionMap () const
 Return the current album map shared. More...
 
QString configGroupName () const
 Config properties methods. More...
 
QString configStartServerOnStartupEntry () const
 
bool isRunning () const
 Return true if server is running in background. More...
 
QList< QUrl > itemsList () const
 Return a flat list of items shared. More...
 
int itemsShared () const
 
bool load ()
 
bool loadAtStartup ()
 Wrapper to check if server configuration must be saved and restored between application sessions. More...
 
void mediaServerNotification (bool started)
 Send a notification message if MediaServer have been started or not. More...
 
bool save ()
 Low level methods to save and load from xml data file. More...
 
void saveAtShutdown ()
 
void setCollectionMap (const MediaServerMap &)
 Setup the list of albums to share with DLNA server. More...
 
void setItemsList (const QString &aname, const QList< QUrl > &urls)
 Setup the list of items to share with the DLNA server into a single album. More...
 
bool startMediaServer ()
 Start the DLNA server and share the contents. Return true is all is on-line. More...
 

Static Public Member Functions

static DMediaServerMngrinstance ()
 This manager is a singleton. Use this method to control the DLNA server instance. More...
 

Friends

class DMediaServerMngrCreator
 

Member Function Documentation

◆ albumsShared()

int DigikamGenericMediaServerPlugin::DMediaServerMngr::albumsShared ( ) const

Return some stats about total albums and total items shared on the network.

◆ cleanUp()

void DigikamGenericMediaServerPlugin::DMediaServerMngr::cleanUp ( )

Stop the DLNA server and clean-up.

Referenced by saveAtShutdown(), and startMediaServer().

◆ collectionMap()

MediaServerMap DigikamGenericMediaServerPlugin::DMediaServerMngr::collectionMap ( ) const

Return the current album map shared.

◆ configGroupName()

QString DigikamGenericMediaServerPlugin::DMediaServerMngr::configGroupName ( ) const

Config properties methods.

Referenced by loadAtStartup(), and saveAtShutdown().

◆ configStartServerOnStartupEntry()

QString DigikamGenericMediaServerPlugin::DMediaServerMngr::configStartServerOnStartupEntry ( ) const

Referenced by loadAtStartup(), and saveAtShutdown().

◆ instance()

DMediaServerMngr * DigikamGenericMediaServerPlugin::DMediaServerMngr::instance ( )
static

This manager is a singleton. Use this method to control the DLNA server instance.

Referenced by DigikamGenericMediaServerPlugin::MediaServerPlugin::cleanUp(), and DigikamGenericMediaServerPlugin::MediaServerPlugin::MediaServerPlugin().

◆ isRunning()

bool DigikamGenericMediaServerPlugin::DMediaServerMngr::isRunning ( ) const

Return true if server is running in background.

◆ itemsList()

QList< QUrl > DigikamGenericMediaServerPlugin::DMediaServerMngr::itemsList ( ) const

Return a flat list of items shared.

Referenced by itemsShared().

◆ itemsShared()

int DigikamGenericMediaServerPlugin::DMediaServerMngr::itemsShared ( ) const

References itemsList().

◆ load()

bool DigikamGenericMediaServerPlugin::DMediaServerMngr::load ( )

References setCollectionMap().

Referenced by loadAtStartup().

◆ loadAtStartup()

bool DigikamGenericMediaServerPlugin::DMediaServerMngr::loadAtStartup ( )

Wrapper to check if server configuration must be saved and restored between application sessions.

References configGroupName(), configStartServerOnStartupEntry(), load(), mediaServerNotification(), and startMediaServer().

Referenced by DigikamGenericMediaServerPlugin::MediaServerPlugin::MediaServerPlugin().

◆ mediaServerNotification()

void DigikamGenericMediaServerPlugin::DMediaServerMngr::mediaServerNotification ( bool  started)

Send a notification message if MediaServer have been started or not.

References Digikam::DNotificationWrapper().

Referenced by loadAtStartup().

◆ save()

bool DigikamGenericMediaServerPlugin::DMediaServerMngr::save ( )

Low level methods to save and load from xml data file.

Referenced by saveAtShutdown().

◆ saveAtShutdown()

void DigikamGenericMediaServerPlugin::DMediaServerMngr::saveAtShutdown ( )

◆ setCollectionMap()

void DigikamGenericMediaServerPlugin::DMediaServerMngr::setCollectionMap ( const MediaServerMap map)

Setup the list of albums to share with DLNA server.

Referenced by load().

◆ setItemsList()

void DigikamGenericMediaServerPlugin::DMediaServerMngr::setItemsList ( const QString &  aname,
const QList< QUrl > &  urls 
)

Setup the list of items to share with the DLNA server into a single album.

◆ startMediaServer()

bool DigikamGenericMediaServerPlugin::DMediaServerMngr::startMediaServer ( )

Start the DLNA server and share the contents. Return true is all is on-line.

References cleanUp().

Referenced by loadAtStartup().

Friends And Related Function Documentation

◆ DMediaServerMngrCreator

friend class DMediaServerMngrCreator
friend

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