JSONRPC::CAudioLibrary Class Reference

#include <AudioLibrary.h>

Inheritance diagram for JSONRPC::CAudioLibrary:

Static Public Member Functions
static JSONRPC_STATUS	GetProperties (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	GetArtists (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	GetArtistDetails (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	GetAlbums (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	GetAlbumDetails (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	GetSongs (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	GetSongDetails (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	GetGenres (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	GetRoles (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	GetSources (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	GetAvailableArtTypes (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	GetAvailableArt (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	GetRecentlyAddedAlbums (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	GetRecentlyAddedSongs (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	GetRecentlyPlayedAlbums (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	GetRecentlyPlayedSongs (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	SetArtistDetails (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	SetAlbumDetails (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	SetSongDetails (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	Scan (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	Export (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	Clean (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static bool	FillFileItem (const std::string &strFilename, std::shared_ptr< CFileItem > &item, const CVariant &parameterObject=CVariant(CVariant::VariantTypeArray))
static bool	FillFileItemList (const CVariant &parameterObject, CFileItemList &list)
static JSONRPC_STATUS	GetAdditionalDetails (const CVariant &parameterObject, CFileItemList &items)
static JSONRPC_STATUS	GetAdditionalArtistDetails (const CVariant &parameterObject, const CFileItemList &items, CMusicDatabase &musicdatabase)
static JSONRPC_STATUS	GetAdditionalAlbumDetails (const CVariant &parameterObject, const CFileItemList &items, CMusicDatabase &musicdatabase)
static JSONRPC_STATUS	GetAdditionalSongDetails (const CVariant &parameterObject, const CFileItemList &items, CMusicDatabase &musicdatabase)
static JSONRPC_STATUS	RefreshArtist (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
static JSONRPC_STATUS	RefreshAlbum (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
Static Public Member Functions inherited from JSONRPC::CJSONUtils
static void	MillisecondsToTimeObject (int time, CVariant &result)

Additional Inherited Members
Static Protected Member Functions inherited from JSONRPC::CFileItemHandler
static void	FillDetails (const ISerializable *info, const std::shared_ptr< CFileItem > &item, std::set< std::string > &fields, CVariant &result, CThumbLoader *thumbLoader=nullptr)
static void	HandleFileItemList (const char *ID, bool allowFile, const char *resultname, CFileItemList &items, const CVariant &parameterObject, CVariant &result, bool sortLimit=true)
static void	HandleFileItemList (const char *ID, bool allowFile, const char *resultname, CFileItemList &items, const CVariant &parameterObject, CVariant &result, int size, bool sortLimit=true)
static void	HandleFileItem (const char *ID, bool allowFile, const char *resultname, const std::shared_ptr< CFileItem > &item, const CVariant &parameterObject, const CVariant &validFields, CVariant &result, bool append=true, CThumbLoader *thumbLoader=nullptr)
static void	HandleFileItem (const char *ID, bool allowFile, const char *resultname, const std::shared_ptr< CFileItem > &item, const CVariant &parameterObject, const std::set< std::string > &validFields, CVariant &result, bool append=true, CThumbLoader *thumbLoader=nullptr)
static bool	FillFileItemList (const CVariant &parameterObject, CFileItemList &list)
Static Protected Member Functions inherited from JSONRPC::CJSONUtils
static void	HandleLimits (const CVariant &parameterObject, CVariant &result, int size, int &start, int &end)
static bool	ParseSorting (const CVariant &parameterObject, SortBy &sortBy, SortOrder &sortOrder, SortAttribute &sortAttributes)
static void	ParseLimits (const CVariant &parameterObject, int &limitStart, int &limitEnd)
static bool	ParameterExists (const CVariant &parameterObject, const std::string &key, unsigned int position)
	Checks if the given object contains a parameter.
static bool	IsValueMember (const CVariant &value, const std::string &key)
	Checks if the given object contains a value with the given key.
static CVariant	GetParameter (const CVariant &parameterObject, const std::string &key, unsigned int position)
	Returns the json value of a parameter.
static CVariant	GetParameter (const CVariant &parameterObject, const std::string &key, unsigned int position, const CVariant &fallback)
	Returns the json value of a parameter or the given default value.
static std::string	GetString (const CVariant &value, const char *defaultValue)
	Returns the given json value as a string.
static TransportLayerCapability	StringToTransportLayer (const std::string &transport)
	Returns a TransportLayerCapability value of the given string representation.
static JSONSchemaType	StringToSchemaValueType (const std::string &valueType)
	Returns a JSONSchemaType value for the given string representation.
static std::string	SchemaValueTypeToString (JSONSchemaType valueType)
	Returns a string representation for the given JSONSchemaType.
static void	SchemaValueTypeToJson (JSONSchemaType valueType, CVariant &jsonObject)
	Converts the given json schema type into a json object.
static const char *	ValueTypeToString (CVariant::VariantType valueType)
static bool	IsParameterType (const CVariant &parameterObject, const char *key, unsigned int position, JSONSchemaType valueType)
	Checks if the parameter with the given name or at the given position is of a certain type.
static bool	IsType (const CVariant &value, JSONSchemaType valueType)
	Checks if the given json value is of the given type.
static void	SetDefaultValue (CVariant &value, JSONSchemaType valueType)
	Sets the value of the given json value to the default value of the given type.
static bool	HasType (JSONSchemaType typeObject, JSONSchemaType type)
static bool	ParameterNotNull (const CVariant &parameterObject, const std::string &key)
static void	CopyStringArray (const CVariant &jsonStringArray, std::vector< std::string > &stringArray)
	Copies the values from the jsonStringArray to the stringArray. stringArray is cleared.
static void	SetFromDBDate (const CVariant &jsonDate, CDateTime &date)
static void	SetFromDBDateTime (const CVariant &jsonDate, CDateTime &date)
static bool	GetXspFiltering (const std::string &type, const CVariant &filter, std::string &xsp)

Member Function Documentation

Clean()

JSONRPC_STATUS CAudioLibrary::Clean ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

Export()

JSONRPC_STATUS CAudioLibrary::Export ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

FillFileItem()

bool CAudioLibrary::FillFileItem ( const std::string & strFilename, std::shared_ptr< CFileItem > & item, const CVariant & parameterObject = CVariant(CVariant::VariantTypeArray) )

static

FillFileItemList()

bool CAudioLibrary::FillFileItemList ( const CVariant & parameterObject, CFileItemList & list )

static

GetAdditionalAlbumDetails()

JSONRPC_STATUS CAudioLibrary::GetAdditionalAlbumDetails ( const CVariant & parameterObject, const CFileItemList & items, CMusicDatabase & musicdatabase )

static

GetAdditionalArtistDetails()

JSONRPC_STATUS CAudioLibrary::GetAdditionalArtistDetails ( const CVariant & parameterObject, const CFileItemList & items, CMusicDatabase & musicdatabase )

static

GetAdditionalDetails()

JSONRPC_STATUS CAudioLibrary::GetAdditionalDetails ( const CVariant & parameterObject, CFileItemList & items )

static

GetAdditionalSongDetails()

JSONRPC_STATUS CAudioLibrary::GetAdditionalSongDetails ( const CVariant & parameterObject, const CFileItemList & items, CMusicDatabase & musicdatabase )

static

GetAlbumDetails()

JSONRPC_STATUS CAudioLibrary::GetAlbumDetails ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

GetAlbums()

JSONRPC_STATUS CAudioLibrary::GetAlbums ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

GetArtistDetails()

JSONRPC_STATUS CAudioLibrary::GetArtistDetails ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

GetArtists()

JSONRPC_STATUS CAudioLibrary::GetArtists ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

GetAvailableArt()

JSONRPC_STATUS CAudioLibrary::GetAvailableArt ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

GetAvailableArtTypes()

JSONRPC_STATUS CAudioLibrary::GetAvailableArtTypes ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

GetGenres()

JSONRPC_STATUS CAudioLibrary::GetGenres ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

GetProperties()

JSONRPC_STATUS CAudioLibrary::GetProperties ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

GetRecentlyAddedAlbums()

JSONRPC_STATUS CAudioLibrary::GetRecentlyAddedAlbums ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

GetRecentlyAddedSongs()

JSONRPC_STATUS CAudioLibrary::GetRecentlyAddedSongs ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

GetRecentlyPlayedAlbums()

JSONRPC_STATUS CAudioLibrary::GetRecentlyPlayedAlbums ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

GetRecentlyPlayedSongs()

JSONRPC_STATUS CAudioLibrary::GetRecentlyPlayedSongs ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

GetRoles()

JSONRPC_STATUS CAudioLibrary::GetRoles ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

GetSongDetails()

JSONRPC_STATUS CAudioLibrary::GetSongDetails ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

GetSongs()

JSONRPC_STATUS CAudioLibrary::GetSongs ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

GetSources()

JSONRPC_STATUS JSONRPC::CAudioLibrary::GetSources ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

RefreshAlbum()

JSONRPC_STATUS CAudioLibrary::RefreshAlbum ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

RefreshArtist()

JSONRPC_STATUS CAudioLibrary::RefreshArtist ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

Scan()

JSONRPC_STATUS CAudioLibrary::Scan ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

SetAlbumDetails()

JSONRPC_STATUS CAudioLibrary::SetAlbumDetails ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

SetArtistDetails()

JSONRPC_STATUS CAudioLibrary::SetArtistDetails ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

SetSongDetails()

JSONRPC_STATUS CAudioLibrary::SetSongDetails ( const std::string & method, ITransportLayer * transport, IClient * client, const CVariant & parameterObject, CVariant & result )

static

---

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

• AudioLibrary.h
• AudioLibrary.cpp