MythTV  master
Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
UPnpCDSExtension Class Reference

#include <libmythupnp/upnpcds.h>

Inheritance diagram for UPnpCDSExtension:
[legend]
Collaboration diagram for UPnpCDSExtension:
[legend]

Public Member Functions

 UPnpCDSExtension (QString sName, QString sExtensionId, QString sClass)
 
virtual CDSObject * GetRoot ()
 
virtual ~UPnpCDSExtension ()
 
virtual UPnpCDSExtensionResults * Browse (UPnpCDSRequest *pRequest)
 
virtual UPnpCDSExtensionResults * Search (UPnpCDSRequest *pRequest)
 
virtual QString GetSearchCapabilities ()
 
virtual QString GetSortCapabilities ()
 
virtual CDSShortCutList GetShortCuts ()
 

Public Attributes

QString m_sExtensionId
 
QString m_sName
 
QString m_sClass
 
CDSShortCutList m_shortcuts
 

Protected Member Functions

virtual bool IsBrowseRequestForUs (UPnpCDSRequest *pRequest)
 
virtual bool IsSearchRequestForUs (UPnpCDSRequest *pRequest)
 
virtual int GetRootCount ()
 
virtual int GetRootContainerCount ()
 
virtual void CreateRoot ()
 
virtual bool LoadMetadata (const UPnpCDSRequest *pRequest, UPnpCDSExtensionResults *pResults, const IDTokenMap &tokens, const QString &currentToken)
 Fetch just the metadata for the item identified in the request. More...
 
virtual bool LoadChildren (const UPnpCDSRequest *pRequest, UPnpCDSExtensionResults *pResults, const IDTokenMap &tokens, const QString &currentToken)
 Fetch the children of the container identified in the request. More...
 

Static Protected Member Functions

static QString RemoveToken (const QString &sToken, const QString &sStr, int num)
 
static IDTokenMap TokenizeIDString (const QString &Id)
 Split the 'Id' String up into tokens for handling by each extension. More...
 
static IDToken GetCurrentToken (const QString &Id)
 Split the 'Id' String up into tokens and return the last (current) token. More...
 
static QString CreateIDString (const QString &RequestId, const QString &Name, int Value)
 
static QString CreateIDString (const QString &RequestId, const QString &Name, const QString &Value)
 

Protected Attributes

CDSObject * m_pRoot {nullptr}
 

Detailed Description

Definition at line 203 of file upnpcds.h.

Constructor & Destructor Documentation

◆ UPnpCDSExtension()

UPnpCDSExtension::UPnpCDSExtension ( QString  sName,
QString  sExtensionId,
QString  sClass 
)
inline

Definition at line 253 of file upnpcds.h.

◆ ~UPnpCDSExtension()

UPnpCDSExtension::~UPnpCDSExtension ( )
virtual

Definition at line 792 of file upnpcds.cpp.

Member Function Documentation

◆ RemoveToken()

QString UPnpCDSExtension::RemoveToken ( const QString &  sToken,
const QString &  sStr,
int  num 
)
staticprotected

Definition at line 931 of file upnpcds.cpp.

◆ IsBrowseRequestForUs()

bool UPnpCDSExtension::IsBrowseRequestForUs ( UPnpCDSRequest *  pRequest)
protectedvirtual

Reimplemented in UPnpCDSVideo, UPnpCDSMusic, and UPnpCDSTv.

Definition at line 805 of file upnpcds.cpp.

Referenced by Browse(), UPnpCDSTv::IsBrowseRequestForUs(), UPnpCDSMusic::IsBrowseRequestForUs(), and UPnpCDSVideo::IsBrowseRequestForUs().

◆ IsSearchRequestForUs()

bool UPnpCDSExtension::IsSearchRequestForUs ( UPnpCDSRequest *  pRequest)
protectedvirtual

Reimplemented in UPnpCDSVideo, UPnpCDSMusic, and UPnpCDSTv.

Definition at line 892 of file upnpcds.cpp.

Referenced by UPnpCDSTv::IsSearchRequestForUs(), UPnpCDSMusic::IsSearchRequestForUs(), UPnpCDSVideo::IsSearchRequestForUs(), and Search().

◆ GetRootCount()

virtual int UPnpCDSExtension::GetRootCount ( )
inlineprotectedvirtual

Definition at line 224 of file upnpcds.h.

◆ GetRootContainerCount()

virtual int UPnpCDSExtension::GetRootContainerCount ( )
inlineprotectedvirtual

Definition at line 225 of file upnpcds.h.

◆ CreateRoot()

void UPnpCDSExtension::CreateRoot ( )
protectedvirtual

Reimplemented in UPnpCDSVideo, UPnpCDSMusic, and UPnpCDSTv.

Definition at line 1078 of file upnpcds.cpp.

Referenced by GetRoot().

◆ LoadMetadata()

bool UPnpCDSExtension::LoadMetadata ( const UPnpCDSRequest *  pRequest,
UPnpCDSExtensionResults *  pResults,
const IDTokenMap &  tokens,
const QString &  currentToken 
)
protectedvirtual

Fetch just the metadata for the item identified in the request.

This is the 'BrowseMetadata' request type.

The ID may refer to a container or an object.

  • pRequest The request object to read the id from
  • pResults The result object to write into
Returns
true if we could load the metadata

Reimplemented in UPnpCDSVideo, UPnpCDSMusic, and UPnpCDSTv.

Definition at line 963 of file upnpcds.cpp.

Referenced by Browse().

◆ LoadChildren()

bool UPnpCDSExtension::LoadChildren ( const UPnpCDSRequest *  pRequest,
UPnpCDSExtensionResults *  pResults,
const IDTokenMap &  tokens,
const QString &  currentToken 
)
protectedvirtual

Fetch the children of the container identified in the request.

This is the 'BrowseDirectChildren' request type.

The ID may only refer to a container.

  • pRequest The request object to read the id from
  • pResults The result object to write into
Returns
true if we could load the children

Reimplemented in UPnpCDSVideo, UPnpCDSMusic, and UPnpCDSTv.

Definition at line 985 of file upnpcds.cpp.

Referenced by Browse().

◆ TokenizeIDString()

IDTokenMap UPnpCDSExtension::TokenizeIDString ( const QString &  Id)
staticprotected

Split the 'Id' String up into tokens for handling by each extension.

Some example strings: 

Recordings/RecGroup=3/Date=1380844800 (2013-10-04 in 'epoch' form)
Video/Genre=10
Music/Artist=123/Album=15
Music/Genre=32/Artist=616/Album=13/Track=2632

Special case where we only care about the last token: 

Video/Directory=45/Directory=63/Directory=82

Definition at line 1007 of file upnpcds.cpp.

Referenced by Browse().

◆ GetCurrentToken()

IDToken UPnpCDSExtension::GetCurrentToken ( const QString &  Id)
staticprotected

Split the 'Id' String up into tokens and return the last (current) token.

Some example strings: 

Recordings/RecGroup=3/Date=1380844800 (2013-10-04 in 'epoch' form)
Video/Genre=10
Music/Artist=123/Album=15
Music/Genre=32/Artist=616/Album=13/Track=2632

Special case where we only care about the last token: 

Video/Directory=45/Directory=63/Directory=82

Definition at line 1043 of file upnpcds.cpp.

Referenced by Browse(), and CreateIDString().

◆ CreateIDString() [1/2]

QString UPnpCDSExtension::CreateIDString ( const QString &  RequestId,
const QString &  Name,
int  Value 
)
staticprotected

Definition at line 1053 of file upnpcds.cpp.

Referenced by UPnpCDSMusic::LoadAlbums(), UPnpCDSMusic::LoadArtists(), UPnpCDSTv::LoadChannels(), UPnpCDSTv::LoadDates(), UPnpCDSTv::LoadGenres(), UPnpCDSVideo::LoadGenres(), UPnpCDSMusic::LoadGenres(), UPnpCDSTv::LoadRecGroups(), UPnpCDSTv::LoadRecordings(), UPnpCDSVideo::LoadSeasons(), UPnpCDSVideo::LoadSeries(), UPnpCDSTv::LoadTitles(), UPnpCDSMusic::LoadTracks(), and UPnpCDSVideo::LoadVideos().

◆ CreateIDString() [2/2]

QString UPnpCDSExtension::CreateIDString ( const QString &  RequestId,
const QString &  Name,
const QString &  Value 
)
staticprotected

Definition at line 1060 of file upnpcds.cpp.

◆ GetRoot()

CDSObject * UPnpCDSExtension::GetRoot ( )
virtual

Definition at line 1086 of file upnpcds.cpp.

Referenced by UPnpCDS::HandleBrowse(), UPnpCDSTv::LoadChildren(), UPnpCDSMusic::LoadChildren(), UPnpCDSVideo::LoadChildren(), UPnpCDSTv::LoadMetadata(), UPnpCDSMusic::LoadMetadata(), and UPnpCDSVideo::LoadMetadata().

◆ Browse()

UPnpCDSExtensionResults * UPnpCDSExtension::Browse ( UPnpCDSRequest *  pRequest)
virtual

Definition at line 819 of file upnpcds.cpp.

◆ Search()

UPnpCDSExtensionResults * UPnpCDSExtension::Search ( UPnpCDSRequest *  pRequest)
virtual

Definition at line 901 of file upnpcds.cpp.

◆ GetSearchCapabilities()

virtual QString UPnpCDSExtension::GetSearchCapabilities ( )
inlinevirtual

Definition at line 267 of file upnpcds.h.

◆ GetSortCapabilities()

virtual QString UPnpCDSExtension::GetSortCapabilities ( )
inlinevirtual

Definition at line 268 of file upnpcds.h.

◆ GetShortCuts()

virtual CDSShortCutList UPnpCDSExtension::GetShortCuts ( )
inlinevirtual

Definition at line 269 of file upnpcds.h.

Referenced by UPnpCDS::RegisterExtension().

Member Data Documentation

◆ m_sExtensionId

QString UPnpCDSExtension::m_sExtensionId

Definition at line 207 of file upnpcds.h.

Referenced by Browse(), UPnpCDSTv::CreateRoot(), UPnpCDSMusic::CreateRoot(), UPnpCDSVideo::CreateRoot(), CreateRoot(), IsBrowseRequestForUs(), UPnpCDSTv::LoadChildren(), UPnpCDSMusic::LoadChildren(), UPnpCDSVideo::LoadChildren(), UPnpCDSTv::LoadMetadata(), UPnpCDSMusic::LoadMetadata(), UPnpCDSVideo::LoadMetadata(), UPnpCDSTv::LoadRecordings(), UPnpCDSMusic::LoadTracks(), and UPnpCDSVideo::LoadVideos().

◆ m_sName

QString UPnpCDSExtension::m_sName

Definition at line 208 of file upnpcds.h.

Referenced by UPnpCDSTv::CreateRoot(), UPnpCDSMusic::CreateRoot(), UPnpCDSVideo::CreateRoot(), and CreateRoot().

◆ m_sClass

QString UPnpCDSExtension::m_sClass

Definition at line 209 of file upnpcds.h.

Referenced by IsSearchRequestForUs(), and Search().

◆ m_shortcuts

CDSShortCutList UPnpCDSExtension::m_shortcuts

Definition at line 211 of file upnpcds.h.

Referenced by UPnpCDSMusic::UPnpCDSMusic(), UPnpCDSTv::UPnpCDSTv(), and UPnpCDSVideo::UPnpCDSVideo().

◆ m_pRoot

CDSObject* UPnpCDSExtension::m_pRoot {nullptr}
protected

Definition at line 249 of file upnpcds.h.

Referenced by UPnpCDSTv::CreateRoot(), UPnpCDSMusic::CreateRoot(), UPnpCDSVideo::CreateRoot(), CreateRoot(), GetRoot(), and ~UPnpCDSExtension().

The documentation for this class was generated from the following files:
Generated on Wed Feb 26 2025 03:18:25 for MythTV by   doxygen 1.8.17