Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
JSONRPC::CVideoLibrary Class Reference

#include <VideoLibrary.h>

Inheritance diagram for JSONRPC::CVideoLibrary:
JSONRPC::CFileItemHandler JSONRPC::CJSONUtils

Static Public Member Functions

static JSONRPC_STATUS GetMovies (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS GetMovieDetails (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS GetMovieSets (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS GetMovieSetDetails (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS GetTVShows (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS GetTVShowDetails (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS GetSeasons (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS GetSeasonDetails (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS GetEpisodes (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS GetEpisodeDetails (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS GetMusicVideos (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS GetMusicVideoDetails (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS GetRecentlyAddedMovies (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS GetRecentlyAddedEpisodes (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS GetRecentlyAddedMusicVideos (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS GetInProgressTVShows (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 GetTags (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 SetMovieDetails (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS SetMovieSetDetails (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS SetTVShowDetails (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS SetSeasonDetails (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS SetEpisodeDetails (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS SetMusicVideoDetails (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS RefreshMovie (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS RefreshTVShow (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS RefreshEpisode (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS RefreshMusicVideo (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS RemoveMovie (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS RemoveTVShow (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS RemoveEpisode (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)
 
static JSONRPC_STATUS RemoveMusicVideo (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 void UpdateResumePoint (const CVariant &parameterObject, CVideoInfoTag &details, CVideoDatabase &videodatabase)
 
static int GetDetailsFromJsonParameters (const CVariant &parameterObject)
 Provided the JSON-RPC parameter object compute the VideoDbDetails mask.
 
- 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 CVideoLibrary::Clean ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ Export()

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

◆ FillFileItem()

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

◆ FillFileItemList()

bool CVideoLibrary::FillFileItemList ( const CVariant & parameterObject,
CFileItemList & list )
static
Todo
API support for video version id

◆ GetAvailableArt()

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

◆ GetAvailableArtTypes()

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

◆ GetDetailsFromJsonParameters()

int CVideoLibrary::GetDetailsFromJsonParameters ( const CVariant & parameterObject)
static

Provided the JSON-RPC parameter object compute the VideoDbDetails mask.

Parameters
parameterObjectthe JSON parameter mask
Returns
the mask value for the requested properties

◆ GetEpisodeDetails()

JSONRPC_STATUS CVideoLibrary::GetEpisodeDetails ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ GetEpisodes()

JSONRPC_STATUS CVideoLibrary::GetEpisodes ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ GetGenres()

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

◆ GetInProgressTVShows()

JSONRPC_STATUS CVideoLibrary::GetInProgressTVShows ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ GetMovieDetails()

JSONRPC_STATUS CVideoLibrary::GetMovieDetails ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static
Todo
API support for video version id

◆ GetMovies()

JSONRPC_STATUS CVideoLibrary::GetMovies ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ GetMovieSetDetails()

JSONRPC_STATUS CVideoLibrary::GetMovieSetDetails ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ GetMovieSets()

JSONRPC_STATUS CVideoLibrary::GetMovieSets ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ GetMusicVideoDetails()

JSONRPC_STATUS CVideoLibrary::GetMusicVideoDetails ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ GetMusicVideos()

JSONRPC_STATUS CVideoLibrary::GetMusicVideos ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ GetRecentlyAddedEpisodes()

JSONRPC_STATUS CVideoLibrary::GetRecentlyAddedEpisodes ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ GetRecentlyAddedMovies()

JSONRPC_STATUS CVideoLibrary::GetRecentlyAddedMovies ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ GetRecentlyAddedMusicVideos()

JSONRPC_STATUS CVideoLibrary::GetRecentlyAddedMusicVideos ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ GetSeasonDetails()

JSONRPC_STATUS CVideoLibrary::GetSeasonDetails ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ GetSeasons()

JSONRPC_STATUS CVideoLibrary::GetSeasons ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ GetTags()

JSONRPC_STATUS CVideoLibrary::GetTags ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ GetTVShowDetails()

JSONRPC_STATUS CVideoLibrary::GetTVShowDetails ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ GetTVShows()

JSONRPC_STATUS CVideoLibrary::GetTVShows ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ RefreshEpisode()

JSONRPC_STATUS CVideoLibrary::RefreshEpisode ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ RefreshMovie()

JSONRPC_STATUS CVideoLibrary::RefreshMovie ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static
Todo
API support for video version id

◆ RefreshMusicVideo()

JSONRPC_STATUS CVideoLibrary::RefreshMusicVideo ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ RefreshTVShow()

JSONRPC_STATUS CVideoLibrary::RefreshTVShow ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ RemoveEpisode()

JSONRPC_STATUS CVideoLibrary::RemoveEpisode ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ RemoveMovie()

JSONRPC_STATUS CVideoLibrary::RemoveMovie ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ RemoveMusicVideo()

JSONRPC_STATUS CVideoLibrary::RemoveMusicVideo ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ RemoveTVShow()

JSONRPC_STATUS CVideoLibrary::RemoveTVShow ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ Scan()

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

◆ SetEpisodeDetails()

JSONRPC_STATUS CVideoLibrary::SetEpisodeDetails ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ SetMovieDetails()

JSONRPC_STATUS CVideoLibrary::SetMovieDetails ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static
Todo
API support for video version id)

◆ SetMovieSetDetails()

JSONRPC_STATUS CVideoLibrary::SetMovieSetDetails ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ SetMusicVideoDetails()

JSONRPC_STATUS CVideoLibrary::SetMusicVideoDetails ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ SetSeasonDetails()

JSONRPC_STATUS CVideoLibrary::SetSeasonDetails ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ SetTVShowDetails()

JSONRPC_STATUS CVideoLibrary::SetTVShowDetails ( const std::string & method,
ITransportLayer * transport,
IClient * client,
const CVariant & parameterObject,
CVariant & result )
static

◆ UpdateResumePoint()

void CVideoLibrary::UpdateResumePoint ( const CVariant & parameterObject,
CVideoInfoTag & details,
CVideoDatabase & videodatabase )
static

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