#include <mythbackend/upnpcdsmusic.h>

Inheritance diagram for UPnpCDSMusic:

Collaboration diagram for UPnpCDSMusic:

Public Member Functions
	UPnpCDSMusic ()
	Music Extension for UPnP ContentDirectory Service. More...

	~UPnpCDSMusic () override=default

Public Member Functions inherited from UPnpCDSExtension
	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 ()

Protected Member Functions
bool	IsBrowseRequestForUs (UPnpCDSRequest *pRequest) override

bool	IsSearchRequestForUs (UPnpCDSRequest *pRequest) override

void	CreateRoot () override

bool	LoadMetadata (const UPnpCDSRequest pRequest, UPnpCDSExtensionResults pResults, const IDTokenMap &tokens, const QString &currentToken) override
	Fetch just the metadata for the item identified in the request. More...

bool	LoadChildren (const UPnpCDSRequest pRequest, UPnpCDSExtensionResults pResults, const IDTokenMap &tokens, const QString &currentToken) override
	Fetch the children of the container identified in the request. More...

Protected Member Functions inherited from UPnpCDSExtension
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...

Private Member Functions
void	PopulateArtworkURIS (CDSObject *pItem, int songID)

bool	LoadAlbums (const UPnpCDSRequest pRequest, UPnpCDSExtensionResults pResults, const IDTokenMap &tokens)

bool	LoadTracks (const UPnpCDSRequest pRequest, UPnpCDSExtensionResults pResults, const IDTokenMap &tokens)

Static Private Member Functions
static bool	LoadArtists (const UPnpCDSRequest pRequest, UPnpCDSExtensionResults pResults, const IDTokenMap &tokens)

static bool	LoadGenres (const UPnpCDSRequest pRequest, UPnpCDSExtensionResults pResults, const IDTokenMap &tokens)

static QString	BuildWhereClause (QStringList clauses, IDTokenMap tokens)

static void	BindValues (MSqlQuery &query, IDTokenMap tokens)

Private Attributes
QUrl	m_uriBase

Additional Inherited Members
Public Attributes inherited from UPnpCDSExtension
QString	m_sExtensionId

QString	m_sName

QString	m_sClass

CDSShortCutList	m_shortcuts

Static Protected Member Functions inherited from UPnpCDSExtension
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 inherited from UPnpCDSExtension
CDSObject *	m_pRoot {nullptr}

Detailed Description

Definition at line 22 of file upnpcdsmusic.h.

Constructor & Destructor Documentation

◆ UPnpCDSMusic()

UPnpCDSMusic::UPnpCDSMusic ( )

Music Extension for UPnP ContentDirectory Service.

Music Music

All Music Music/Track
- <Track 1> Music/Track=1
- <Track 2> Music/Track=2
- <Track 3> Music/Track=3
PlayLists // TODO
By Artist Music/Artist
- <Artist 1> Music/Artist=123
  - <Album 1> Music/Artist=123/Album=345
    - <Track 1> Music/Artist=123/Album=345/Track=1
    - <Track 2> Music/Artist=123/Album=345/Track=2
By Album Music/Album
- <Album 1> Music/Album=789
  - <Track 1> Music/Album=789/Track=1
  - <Track 2> Music/Album=789/Track=2
By Recently Added // TODO
- <Track 1>
- <Track 2>
By Genre Music/Genre
- <Genre 1> Music/Genre=252
  - By Artist Music/Genre=252/Artist
    - <Artist 1> Music/Genre=252/Artist=123
      - <Album 1> Music/Genre=252/Artist=123/Album=345
        
        <Track 1> Music/Genre=252/Artist=123/Album=345/Track=1
        
        <Track 2> Music/Genre=252/Artist=123/Album=345/Track=2

Definition at line 64 of file upnpcdsmusic.cpp.

◆ ~UPnpCDSMusic()

UPnpCDSMusic::~UPnpCDSMusic ( )

overridedefault

Member Function Documentation

◆ BindValues()

void UPnpCDSMusic::BindValues	(	MSqlQuery &	query,
		IDTokenMap	tokens
	)

staticprivate

Definition at line 885 of file upnpcdsmusic.cpp.

Referenced by LoadAlbums(), LoadArtists(), LoadGenres(), and LoadTracks().

◆ BuildWhereClause()

QString UPnpCDSMusic::BuildWhereClause	(	QStringList	clauses,
		IDTokenMap	tokens
	)

staticprivate

Definition at line 850 of file upnpcdsmusic.cpp.

Referenced by LoadAlbums(), LoadArtists(), LoadGenres(), and LoadTracks().

◆ CreateRoot()

void UPnpCDSMusic::CreateRoot ( )

overrideprotectedvirtual

Reimplemented from UPnpCDSExtension.

Definition at line 86 of file upnpcdsmusic.cpp.

◆ IsBrowseRequestForUs()

bool UPnpCDSMusic::IsBrowseRequestForUs ( UPnpCDSRequest * pRequest )

overrideprotectedvirtual

Reimplemented from UPnpCDSExtension.

Definition at line 188 of file upnpcdsmusic.cpp.

◆ IsSearchRequestForUs()

bool UPnpCDSMusic::IsSearchRequestForUs ( UPnpCDSRequest * pRequest )

overrideprotectedvirtual

Reimplemented from UPnpCDSExtension.

Definition at line 221 of file upnpcdsmusic.cpp.

◆ LoadAlbums()

bool UPnpCDSMusic::LoadAlbums	(	const UPnpCDSRequest *	pRequest,
		UPnpCDSExtensionResults *	pResults,
		const IDTokenMap &	tokens
	)

private

Definition at line 465 of file upnpcdsmusic.cpp.

Referenced by CreateRoot(), LoadChildren(), and LoadMetadata().

◆ LoadArtists()

bool UPnpCDSMusic::LoadArtists	(	const UPnpCDSRequest *	pRequest,
		UPnpCDSExtensionResults *	pResults,
		const IDTokenMap &	tokens
	)

staticprivate

Definition at line 557 of file upnpcdsmusic.cpp.

Referenced by CreateRoot(), LoadChildren(), and LoadMetadata().

◆ LoadChildren()

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

overrideprotectedvirtual

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 from UPnpCDSExtension.

Definition at line 330 of file upnpcdsmusic.cpp.

◆ LoadGenres()

bool UPnpCDSMusic::LoadGenres	(	const UPnpCDSRequest *	pRequest,
		UPnpCDSExtensionResults *	pResults,
		const IDTokenMap &	tokens
	)

staticprivate

Definition at line 640 of file upnpcdsmusic.cpp.

Referenced by CreateRoot(), LoadChildren(), and LoadMetadata().

◆ LoadMetadata()

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

overrideprotectedvirtual

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 from UPnpCDSExtension.

Definition at line 266 of file upnpcdsmusic.cpp.

◆ LoadTracks()

bool UPnpCDSMusic::LoadTracks	(	const UPnpCDSRequest *	pRequest,
		UPnpCDSExtensionResults *	pResults,
		const IDTokenMap &	tokens
	)

private

Definition at line 712 of file upnpcdsmusic.cpp.

Referenced by CreateRoot(), LoadChildren(), and LoadMetadata().

◆ PopulateArtworkURIS()

void UPnpCDSMusic::PopulateArtworkURIS	(	CDSObject *	pItem,
		int	songID
	)

private

Definition at line 374 of file upnpcdsmusic.cpp.

Referenced by LoadAlbums(), and LoadTracks().

Member Data Documentation

◆ m_uriBase

QUrl UPnpCDSMusic::m_uriBase

private

Definition at line 47 of file upnpcdsmusic.h.

Referenced by LoadTracks(), PopulateArtworkURIS(), and UPnpCDSMusic().

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

mythtv/programs/mythbackend/upnpcdsmusic.h
mythtv/programs/mythbackend/upnpcdsmusic.cpp

Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UPnpCDSMusic()

◆ ~UPnpCDSMusic()

Member Function Documentation

◆ BindValues()

◆ BuildWhereClause()

◆ CreateRoot()

◆ IsBrowseRequestForUs()

◆ IsSearchRequestForUs()

◆ LoadAlbums()

◆ LoadArtists()

◆ LoadChildren()

◆ LoadGenres()

◆ LoadMetadata()

◆ LoadTracks()

◆ PopulateArtworkURIS()

Member Data Documentation

◆ m_uriBase