Kodi's game info tag class. More...

Classes
class	XBMCAddon::xbmc::InfoTagGame

Functions
	XBMCAddon::xbmc::InfoTagGame::InfoTagGame (const KODI::GAME::CGameInfoTag *tag)

	XBMCAddon::xbmc::InfoTagGame::InfoTagGame (KODI::GAME::CGameInfoTag *tag, bool offscreen=false)

	XBMCAddon::xbmc::InfoTagGame::InfoTagGame (...)
	`Function: xbmc.InfoTagGame([offscreen])` Create a game info tag.

	XBMCAddon::xbmc::InfoTagGame::~InfoTagGame () override

	XBMCAddon::xbmc::InfoTagGame::getTitle ()
	`Function: getTitle()` Gets the title of the game.

	XBMCAddon::xbmc::InfoTagGame::getPlatform ()
	`Function: getPlatform()` Gets the platform on which the game is run.

	XBMCAddon::xbmc::InfoTagGame::getGenres ()
	`Function: getGenres()` Gets the genres of the game.

	XBMCAddon::xbmc::InfoTagGame::getPublisher ()
	`Function: getPublisher()` Gets the publisher of the game.

	XBMCAddon::xbmc::InfoTagGame::getDeveloper ()
	`Function: getDeveloper()` Gets the developer of the game.

	XBMCAddon::xbmc::InfoTagGame::getOverview ()
	`Function: getOverview()` Gets the overview of the game.

	XBMCAddon::xbmc::InfoTagGame::getYear ()
	`Function: getYear()` Gets the year in which the game was published.

	XBMCAddon::xbmc::InfoTagGame::getGameClient ()
	`Function: getGameClient()` Gets the add-on ID of the game client executing the game.

	XBMCAddon::xbmc::InfoTagGame::setTitle (...)
	`Function: setTitle(title)` Sets the title of the game.

	XBMCAddon::xbmc::InfoTagGame::setPlatform (...)
	`Function: setPlatform(platform)` Sets the platform on which the game is run.

	XBMCAddon::xbmc::InfoTagGame::setGenres (...)
	`Function: setGenres(genres)` Sets the genres of the game.

	XBMCAddon::xbmc::InfoTagGame::setPublisher (...)
	`Function: setPublisher(publisher)` Sets the publisher of the game.

	XBMCAddon::xbmc::InfoTagGame::setDeveloper (...)
	`Function: setDeveloper(developer)` Sets the developer of the game.

	XBMCAddon::xbmc::InfoTagGame::setOverview (...)
	`Function: setOverview(overview)` Sets the overview of the game.

	XBMCAddon::xbmc::InfoTagGame::setYear (...)
	`Function: setYear(year)` Sets the year in which the game was published.

	XBMCAddon::xbmc::InfoTagGame::setGameClient (...)
	`Function: setGameClient(gameClient)` Sets the add-on ID of the game client executing the game.

static void	XBMCAddon::xbmc::InfoTagGame::setTitleRaw (KODI::GAME::CGameInfoTag *infoTag, const String &title)

static void	XBMCAddon::xbmc::InfoTagGame::setPlatformRaw (KODI::GAME::CGameInfoTag *infoTag, const String &platform)

static void	XBMCAddon::xbmc::InfoTagGame::setGenresRaw (KODI::GAME::CGameInfoTag *infoTag, const std::vector< String > &genres)

static void	XBMCAddon::xbmc::InfoTagGame::setPublisherRaw (KODI::GAME::CGameInfoTag *infoTag, const String &publisher)

static void	XBMCAddon::xbmc::InfoTagGame::setDeveloperRaw (KODI::GAME::CGameInfoTag *infoTag, const String &developer)

static void	XBMCAddon::xbmc::InfoTagGame::setOverviewRaw (KODI::GAME::CGameInfoTag *infoTag, const String &overview)

static void	XBMCAddon::xbmc::InfoTagGame::setYearRaw (KODI::GAME::CGameInfoTag *infoTag, unsigned int year)

static void	XBMCAddon::xbmc::InfoTagGame::setGameClientRaw (KODI::GAME::CGameInfoTag *infoTag, const String &gameClient)

Detailed Description

Kodi's game info tag class.

`Class: InfoTagGame()`

Access and / or modify the game metadata of a ListItem.

v20 Python API changes: New class added.

Example:

...
tag = item.getGameInfoTag()
 
title = tag.getTitle()
tag.setDeveloper('John Doe')
...

Function Documentation

◆ getDeveloper()

String XBMCAddon::xbmc::InfoTagGame::getDeveloper ( )

`Function: getDeveloper()`

Gets the developer of the game.

Returns: [string] developer

v20 Python API changes: New function added.

◆ getGameClient()

String XBMCAddon::xbmc::InfoTagGame::getGameClient ( )

`Function: getGameClient()`

Gets the add-on ID of the game client executing the game.

Returns: [string] game client

v20 Python API changes: New function added.

◆ getGenres()

std::vector< String > XBMCAddon::xbmc::InfoTagGame::getGenres ( )

`Function: getGenres()`

Gets the genres of the game.

Returns: [list] genres

v20 Python API changes: New function added.

◆ getOverview()

String XBMCAddon::xbmc::InfoTagGame::getOverview ( )

`Function: getOverview()`

Gets the overview of the game.

Returns: [string] overview

v20 Python API changes: New function added.

◆ getPlatform()

String XBMCAddon::xbmc::InfoTagGame::getPlatform ( )

`Function: getPlatform()`

Gets the platform on which the game is run.

Returns: [string] platform

v20 Python API changes: New function added.

◆ getPublisher()

String XBMCAddon::xbmc::InfoTagGame::getPublisher ( )

`Function: getPublisher()`

Gets the publisher of the game.

Returns: [string] publisher

v20 Python API changes: New function added.

◆ getTitle()

String XBMCAddon::xbmc::InfoTagGame::getTitle ( )

`Function: getTitle()`

Gets the title of the game.

Returns: [string] title

v20 Python API changes: New function added.

◆ getYear()

unsigned int XBMCAddon::xbmc::InfoTagGame::getYear ( )

`Function: getYear()`

Gets the year in which the game was published.

Returns: [integer] year

v20 Python API changes: New function added.

◆ InfoTagGame() [1/3]

XBMCAddon::xbmc::InfoTagGame::InfoTagGame ( ... )

`Function: xbmc.InfoTagGame([offscreen])`

Create a game info tag.

Parameters

offscreen [opt] bool (default False) - if GUI based locks should be avoided. Most of the times listitems are created offscreen and added later to a container for display (e.g. plugins) or they are not even displayed (e.g. python scrapers). In such cases, there is no need to lock the GUI when creating the items (increasing your addon performance). Note however, that if you are creating listitems and managing the container itself (e.g using WindowXML or WindowXMLDialog classes) subsquent modifications to the item will require locking. Thus, in such cases, use the default value (False).

v20 Python API changes: New function added.

Example:

...
gameinfo = xbmc.InfoTagGame(offscreen=False)
...

◆ InfoTagGame() [2/3]

XBMCAddon::xbmc::InfoTagGame::InfoTagGame ( const KODI::GAME::CGameInfoTag * tag )

explicit

◆ InfoTagGame() [3/3]

XBMCAddon::xbmc::InfoTagGame::InfoTagGame	(	KODI::GAME::CGameInfoTag *	tag,
		bool	offscreen = false )

explicit

◆ setDeveloper()

void XBMCAddon::xbmc::InfoTagGame::setDeveloper ( ... )

`Function: setDeveloper(developer)`

Sets the developer of the game.

Parameters

developer string - title.

v20 Python API changes: New function added.

◆ setDeveloperRaw()

void XBMCAddon::xbmc::InfoTagGame::setDeveloperRaw	(	KODI::GAME::CGameInfoTag *	infoTag,
		const String &	developer )

static

◆ setGameClient()

void XBMCAddon::xbmc::InfoTagGame::setGameClient ( ... )

`Function: setGameClient(gameClient)`

Sets the add-on ID of the game client executing the game.

Parameters

gameClient string - game client.

v20 Python API changes: New function added.

◆ setGameClientRaw()

void XBMCAddon::xbmc::InfoTagGame::setGameClientRaw	(	KODI::GAME::CGameInfoTag *	infoTag,
		const String &	gameClient )

static

◆ setGenres()

void XBMCAddon::xbmc::InfoTagGame::setGenres ( ... )

`Function: setGenres(genres)`

Sets the genres of the game.

Parameters

genres list - genres.

v20 Python API changes: New function added.

◆ setGenresRaw()

void XBMCAddon::xbmc::InfoTagGame::setGenresRaw	(	KODI::GAME::CGameInfoTag *	infoTag,
		const std::vector< String > &	genres )

static

◆ setOverview()

void XBMCAddon::xbmc::InfoTagGame::setOverview ( ... )

`Function: setOverview(overview)`

Sets the overview of the game.

Parameters

overview string - overview.

v20 Python API changes: New function added.

◆ setOverviewRaw()

void XBMCAddon::xbmc::InfoTagGame::setOverviewRaw	(	KODI::GAME::CGameInfoTag *	infoTag,
		const String &	overview )

static

◆ setPlatform()

void XBMCAddon::xbmc::InfoTagGame::setPlatform ( ... )

`Function: setPlatform(platform)`

Sets the platform on which the game is run.

Parameters

platform string - platform.

v20 Python API changes: New function added.

◆ setPlatformRaw()

void XBMCAddon::xbmc::InfoTagGame::setPlatformRaw	(	KODI::GAME::CGameInfoTag *	infoTag,
		const String &	platform )

static

◆ setPublisher()

void XBMCAddon::xbmc::InfoTagGame::setPublisher ( ... )

`Function: setPublisher(publisher)`

Sets the publisher of the game.

Parameters

publisher string - publisher.

v20 Python API changes: New function added.

◆ setPublisherRaw()

void XBMCAddon::xbmc::InfoTagGame::setPublisherRaw	(	KODI::GAME::CGameInfoTag *	infoTag,
		const String &	publisher )

static

◆ setTitle()

void XBMCAddon::xbmc::InfoTagGame::setTitle ( ... )

`Function: setTitle(title)`

Sets the title of the game.

Parameters

title string - title.

v20 Python API changes: New function added.

◆ setTitleRaw()

void XBMCAddon::xbmc::InfoTagGame::setTitleRaw	(	KODI::GAME::CGameInfoTag *	infoTag,
		const String &	title )

static

◆ setYear()

void XBMCAddon::xbmc::InfoTagGame::setYear ( ... )

`Function: setYear(year)`

Sets the year in which the game was published.

Parameters

year	integer - year.

v20 Python API changes: New function added.

◆ setYearRaw()

void XBMCAddon::xbmc::InfoTagGame::setYearRaw	(	KODI::GAME::CGameInfoTag *	infoTag,
		unsigned int	year )

static

◆ ~InfoTagGame()

XBMCAddon::xbmc::InfoTagGame::~InfoTagGame ( )

override

Classes

Functions

Function: xbmc.InfoTagGame([offscreen])

Function: getTitle()

Function: getPlatform()

Function: getGenres()

Function: getPublisher()

Function: getDeveloper()

Function: getOverview()

Function: getYear()

Function: getGameClient()

Function: setTitle(title)

Function: setPlatform(platform)

Function: setGenres(genres)

Function: setPublisher(publisher)

Function: setDeveloper(developer)

Function: setOverview(overview)

Function: setYear(year)

Function: setGameClient(gameClient)

Detailed Description

Class: InfoTagGame()

Function Documentation

◆ getDeveloper()

Function: getDeveloper()

◆ getGameClient()

Function: getGameClient()

◆ getGenres()

Function: getGenres()

◆ getOverview()

Function: getOverview()

◆ getPlatform()

Function: getPlatform()

◆ getPublisher()

Function: getPublisher()

◆ getTitle()

Function: getTitle()

◆ getYear()

Function: getYear()

◆ InfoTagGame() [1/3]

Function: xbmc.InfoTagGame([offscreen])

◆ InfoTagGame() [2/3]

◆ InfoTagGame() [3/3]

◆ setDeveloper()

Function: setDeveloper(developer)

◆ setDeveloperRaw()

◆ setGameClient()

Function: setGameClient(gameClient)

◆ setGameClientRaw()

◆ setGenres()

Function: setGenres(genres)

◆ setGenresRaw()

◆ setOverview()

Function: setOverview(overview)

◆ setOverviewRaw()

◆ setPlatform()

Function: setPlatform(platform)

◆ setPlatformRaw()

◆ setPublisher()

Function: setPublisher(publisher)

◆ setPublisherRaw()

◆ setTitle()

Function: setTitle(title)

◆ setTitleRaw()

◆ setYear()

Function: setYear(year)

◆ setYearRaw()

◆ ~InfoTagGame()

`Function: xbmc.InfoTagGame([offscreen])`

`Function: getTitle()`

`Function: getPlatform()`

`Function: getGenres()`

`Function: getPublisher()`

`Function: getDeveloper()`

`Function: getOverview()`

`Function: getYear()`

`Function: getGameClient()`

`Function: setTitle(title)`

`Function: setPlatform(platform)`

`Function: setGenres(genres)`

`Function: setPublisher(publisher)`

`Function: setDeveloper(developer)`

`Function: setOverview(overview)`

`Function: setYear(year)`

`Function: setGameClient(gameClient)`

`Class: InfoTagGame()`

`Function: getDeveloper()`

`Function: getGameClient()`

`Function: getGenres()`

`Function: getOverview()`

`Function: getPlatform()`

`Function: getPublisher()`

`Function: getTitle()`

`Function: getYear()`

`Function: xbmc.InfoTagGame([offscreen])`

`Function: setDeveloper(developer)`

`Function: setGameClient(gameClient)`

`Function: setGenres(genres)`

`Function: setOverview(overview)`

`Function: setPlatform(platform)`

`Function: setPublisher(publisher)`

`Function: setTitle(title)`

`Function: setYear(year)`