Audio-video add-on tutorial - Revision history

Takoi: Same. This page is not at place to dump links to external tutorials

2016-01-13T13:29:02Z

Same. This page is not at place to dump links to external tutorials

← Older revision		Revision as of 13:29, 13 January 2016
Line 2:		Line 2:

	This page will outline the basics of creating your first Python add-on for Kodi. It assumes you're at least familiar with the basics of Python (or at least, programming in general). If not, we recommend visiting the [http://docs.python.org/2/tutorial/ Python tutorial] first, and then returning here.		This page will outline the basics of creating your first Python add-on for Kodi. It assumes you're at least familiar with the basics of Python (or at least, programming in general). If not, we recommend visiting the [http://docs.python.org/2/tutorial/ Python tutorial] first, and then returning here.

	~~=Video Tutorial=~~
	~~{{youtube\|FtQgZ2bxFkk}}~~

	~~[https://youtu.be/FtQgZ2bxFkk Video's Description.]~~

	*This video will help you make a video add-on for Kodi. The video's steps might be different from the written tutorial below.


	= Before we get started =		= Before we get started =

SimpleKodi: Added a Video Tutorial

2016-01-10T09:35:42Z

Added a Video Tutorial

← Older revision		Revision as of 09:35, 10 January 2016
Line 2:		Line 2:

	This page will outline the basics of creating your first Python add-on for Kodi. It assumes you're at least familiar with the basics of Python (or at least, programming in general). If not, we recommend visiting the [http://docs.python.org/2/tutorial/ Python tutorial] first, and then returning here.		This page will outline the basics of creating your first Python add-on for Kodi. It assumes you're at least familiar with the basics of Python (or at least, programming in general). If not, we recommend visiting the [http://docs.python.org/2/tutorial/ Python tutorial] first, and then returning here.

			=Video Tutorial=
			{{youtube\|FtQgZ2bxFkk}}

			[https://youtu.be/FtQgZ2bxFkk Video's Description.]

			*This video will help you make a video add-on for Kodi. The video's steps might be different from the written tutorial below.


	= Before we get started =		= Before we get started =

Takoi: xbmc -> kodi

2015-10-31T11:13:26Z

xbmc -> kodi

← Older revision		Revision as of 11:13, 31 October 2015
Line 1:		Line 1:
	{{mininav\|[[Development]]\|[[Add-on development]]}}		{{mininav\|[[Development]]\|[[Add-on development]]}}

	This page will outline the basics of creating your first Python add-on for ~~XBMC~~. It assumes you're at least familiar with the basics of Python (or at least, programming in general). If not, we recommend visiting the [http://docs.python.org/2/tutorial/ Python tutorial] first, and then returning here.		This page will outline the basics of creating your first Python add-on for Kodi. It assumes you're at least familiar with the basics of Python (or at least, programming in general). If not, we recommend visiting the [http://docs.python.org/2/tutorial/ Python tutorial] first, and then returning here.

	= Before we get started =		= Before we get started =
Line 158:		Line 158:
	== Info labels ==		== Info labels ==

	~~XBMC~~ also lets you add useful information about each list item, like the cast, episode number, play count, and duration. The specific fields available depend on whether your list item is video, audio, or a picture. In all cases though, the format is roughly the same. For example, to add info labels to a movie, you might do the following:		Kodi also lets you add useful information about each list item, like the cast, episode number, play count, and duration. The specific fields available depend on whether your list item is video, audio, or a picture. In all cases though, the format is roughly the same. For example, to add info labels to a movie, you might do the following:

	<syntaxhighlight lang="python" enclose="div">		<syntaxhighlight lang="python" enclose="div">

Takoi: update documentation links

2015-10-31T11:11:52Z

update documentation links

← Older revision		Revision as of 11:11, 31 October 2015
Line 134:		Line 134:
	= Showing additional metadata =		= Showing additional metadata =

	We've already seen how to show some basic metadata, like the icon image and the type of the item (<code>'video'</code> in our case). However, there are many more pieces of metadata that Kodi understands, and adding them can make life easier on your users. We'll take a look at some of the more important ones. You can also find a full list in the [http://mirrors.kodi.tv/docs/python-docs Python documentation] for <code>[http://mirrors.kodi.tv/docs/python-docs/12.2-~~frodo~~/xbmcgui.html#ListItem xbmcgui.ListItem]</code>.		We've already seen how to show some basic metadata, like the icon image and the type of the item (<code>'video'</code> in our case). However, there are many more pieces of metadata that Kodi understands, and adding them can make life easier on your users. We'll take a look at some of the more important ones. You can also find a full list in the [http://mirrors.kodi.tv/docs/python-docs/ Python documentation] for <code>[http://mirrors.kodi.tv/docs/python-docs/16.x-jarvis/xbmcgui.html#ListItem xbmcgui.ListItem]</code>.

	== Icons, thumbnails and artwork ==		== Icons, thumbnails and artwork ==
Line 148:		Line 148:
	{{Note\|In Kodi Isengard and earlier the 'icon' type is not available for setArt. You must use <code>ListItem.setIconImage(...)</code>}}		{{Note\|In Kodi Isengard and earlier the 'icon' type is not available for setArt. You must use <code>ListItem.setIconImage(...)</code>}}

	If you'd prefer to show the default fanart from your add-on, you can get the path to that image from the <code>[http://mirrors.kodi.tv/docs/python-docs/12.2-~~frodo~~/xbmcaddon.html#Addon xbmcaddon.Addon]</code> object:		If you'd prefer to show the default fanart from your add-on, you can get the path to that image from the <code>[http://mirrors.kodi.tv/docs/python-docs/16.x-jarvis/xbmcaddon.html#Addon xbmcaddon.Addon]</code> object:

	<syntaxhighlight lang="python" enclose="div">		<syntaxhighlight lang="python" enclose="div">
Line 169:		Line 169:
	</syntaxhighlight>		</syntaxhighlight>

	For a full list of the available info labels, consult the documentation for <code>[http://mirrors.kodi.tv/docs/python-docs/12.2-~~frodo~~/xbmcgui.html#ListItem-setInfo ListItem.setInfo]</code>.		For a full list of the available info labels, consult the documentation for <code>[http://mirrors.kodi.tv/docs/python-docs/16.x-jarvis/xbmcgui.html#ListItem-setInfo ListItem.setInfo]</code>.

	== Stream info ==		== Stream info ==
Line 187:		Line 187:
	</syntaxhighlight>		</syntaxhighlight>

	For complete documentation about this function, see <code>[http://mirrors.kodi.tv/docs/python-docs/12.2-~~frodo~~/xbmcgui.html#ListItem-addStreamInfo ListItem.addStreamInfo]</code>.		For complete documentation about this function, see <code>[http://mirrors.kodi.tv/docs/python-docs/16.x-jarvis/xbmcgui.html#ListItem-addStreamInfo ListItem.addStreamInfo]</code>.

	= Adding context menus =		= Adding context menus =

Takoi: improve code formatting

2015-10-31T11:07:26Z

improve code formatting

← Older revision		Revision as of 11:07, 31 October 2015
Line 161:		Line 161:

	<syntaxhighlight lang="python" enclose="div">		<syntaxhighlight lang="python" enclose="div">
	~~li.setInfo('video',~~ { 'genre': 'Horror',		info = {
	'year': 1979,		'genre': 'Horror',
	'title': 'Alien' })		'year': 1979,
			'title': 'Alien',
			}
			li.setInfo('video', info)
	</syntaxhighlight>		</syntaxhighlight>

Line 173:		Line 176:

	<syntaxhighlight lang="python" enclose="div">		<syntaxhighlight lang="python" enclose="div">
	~~li.addStreamInfo('video',~~ { 'codec': 'h264', 'aspect': 1.78, 'width': 1280,		video_info = {
	'height': 720, '~~duration~~'~~: 60 }~~)		'codec': 'h264',
	li.addStreamInfo('audio', { 'codec': 'dts', 'language': 'en', 'channels': 2 })		'aspect': 1.78,
	li.addStreamInfo('subtitle', { 'language': 'en' })		'width': 1280,
			'height': 720,
			}
			li.addStreamInfo('video', video_info)
			li.addStreamInfo('audio', {'codec': 'dts', 'language': 'en', 'channels': 2})
			li.addStreamInfo('subtitle', {'language': 'en'})
	</syntaxhighlight>		</syntaxhighlight>

Takoi: /* Icons and thumbnails */

2015-10-31T11:00:38Z

Icons and thumbnails

← Older revision		Revision as of 11:00, 31 October 2015
Line 136:		Line 136:
	We've already seen how to show some basic metadata, like the icon image and the type of the item (<code>'video'</code> in our case). However, there are many more pieces of metadata that Kodi understands, and adding them can make life easier on your users. We'll take a look at some of the more important ones. You can also find a full list in the [http://mirrors.kodi.tv/docs/python-docs Python documentation] for <code>[http://mirrors.kodi.tv/docs/python-docs/12.2-frodo/xbmcgui.html#ListItem xbmcgui.ListItem]</code>.		We've already seen how to show some basic metadata, like the icon image and the type of the item (<code>'video'</code> in our case). However, there are many more pieces of metadata that Kodi understands, and adding them can make life easier on your users. We'll take a look at some of the more important ones. You can also find a full list in the [http://mirrors.kodi.tv/docs/python-docs Python documentation] for <code>[http://mirrors.kodi.tv/docs/python-docs/12.2-frodo/xbmcgui.html#ListItem xbmcgui.ListItem]</code>.

	== Icons and ~~thumbnails~~ ==		== Icons, thumbnails and artwork ==

	Our previous examples already showed how to set an icon, but you can also set a thumbnail, fanart (full-screen background images) and other artwork. They can be set with the <code>ListItem.setArt</code> method:		Our previous examples already showed how to set an icon, but you can also set a thumbnail, fanart (full-screen background images) and other artwork. They can be set with the <code>ListItem.setArt</code> method:

Takoi: remove use of deprecated methods

2015-10-31T10:59:20Z

remove use of deprecated methods

← Older revision		Revision as of 10:59, 31 October 2015
Line 138:		Line 138:
	== Icons and thumbnails ==		== Icons and thumbnails ==

	Our previous examples already showed how to set an icon, but you can also set a ~~larger~~ thumbnail ~~for each list item~~. ~~Both of these~~ can be set in the <code>ListItem</code> ~~constructor:~~		Our previous examples already showed how to set an icon, but you can also set a thumbnail, fanart (full-screen background images) and other artwork. They can be set with the <code>ListItem.setArt</code> method:

	~~<syntaxhighlight lang="python" enclose="div">~~
	~~li = xbmcgui.ListItem(label='My video', iconImage='icon.png', thumbnailImage='thumbnail.png')~~
	~~</syntaxhighlight>~~

	~~You can also set these ''after'' creating the list item~~:

	<syntaxhighlight lang="python" enclose="div">		<syntaxhighlight lang="python" enclose="div">
			li = xbmcgui.ListItem(label='My video')
	li.setIconImage('icon.png')		li.setIconImage('icon.png')
	li.~~setThumbnailImage~~('thumbnail.~~png~~')		li.setArt({'thumb': 'thumbnail.jpg', 'poster': 'poster.jpg' 'fanart': 'fanart.jpg'})
	</syntaxhighlight>		</syntaxhighlight>

	~~== Fanart ==~~		{{Note\|In Kodi Isengard and earlier the 'icon' type is not available for setArt. You must use <code>ListItem.setIconImage(...)</code>}}

	~~Fanart (full-screen background images) are another common thing~~ for ~~add-ons to show~~. ~~This works a bit differently from icons and thumbnails, but it's still a simple process:~~

	<~~syntaxhighlight lang="python" enclose="div"~~>
	li.~~setProperty~~(~~'fanart_image', 'fanart~~.~~jpg'~~)
	</~~syntaxhighlight~~>

	If you'd prefer to show the default fanart from your add-on, you can get the path to that image from the <code>[http://mirrors.kodi.tv/docs/python-docs/12.2-frodo/xbmcaddon.html#Addon xbmcaddon.Addon]</code> object:		If you'd prefer to show the default fanart from your add-on, you can get the path to that image from the <code>[http://mirrors.kodi.tv/docs/python-docs/12.2-frodo/xbmcaddon.html#Addon xbmcaddon.Addon]</code> object:
Line 164:		Line 153:
	my_addon = xbmcaddon.Addon('plugin.video.myaddon')		my_addon = xbmcaddon.Addon('plugin.video.myaddon')
	# ...		# ...
	li.~~setProperty~~('~~fanart_image~~', my_addon.getAddonInfo('fanart'))		li.setArt({'fanart': my_addon.getAddonInfo('fanart')})
	</syntaxhighlight>		</syntaxhighlight>

Learningit at 02:53, 19 June 2015

2015-06-19T02:53:34Z

← Older revision		Revision as of 02:53, 19 June 2015
Line 23:		Line 23:
	url = 'http://localhost/some_video.mkv'		url = 'http://localhost/some_video.mkv'
	li = xbmcgui.ListItem('My First Video!', iconImage='DefaultVideo.png')		li = xbmcgui.ListItem('My First Video!', iconImage='DefaultVideo.png')
	~~li.setProperty('IsPlayable', 'true')~~
	xbmcplugin.addDirectoryItem(handle=addon_handle, url=url, listitem=li)		xbmcplugin.addDirectoryItem(handle=addon_handle, url=url, listitem=li)

Line 97:		Line 96:
	url = 'http://localhost/some_video.mkv'		url = 'http://localhost/some_video.mkv'
	li = xbmcgui.ListItem(foldername + ' Video', iconImage='DefaultVideo.png')		li = xbmcgui.ListItem(foldername + ' Video', iconImage='DefaultVideo.png')
	~~li.setProperty('IsPlayable', 'true')~~
	xbmcplugin.addDirectoryItem(handle=addon_handle, url=url, listitem=li)		xbmcplugin.addDirectoryItem(handle=addon_handle, url=url, listitem=li)
	xbmcplugin.endOfDirectory(addon_handle)		xbmcplugin.endOfDirectory(addon_handle)

Learningit at 02:43, 19 June 2015

2015-06-19T02:43:26Z

← Older revision		Revision as of 02:43, 19 June 2015
Line 23:		Line 23:
	url = 'http://localhost/some_video.mkv'		url = 'http://localhost/some_video.mkv'
	li = xbmcgui.ListItem('My First Video!', iconImage='DefaultVideo.png')		li = xbmcgui.ListItem('My First Video!', iconImage='DefaultVideo.png')
			li.setProperty('IsPlayable', 'true')
	xbmcplugin.addDirectoryItem(handle=addon_handle, url=url, listitem=li)		xbmcplugin.addDirectoryItem(handle=addon_handle, url=url, listitem=li)

Line 96:		Line 97:
	url = 'http://localhost/some_video.mkv'		url = 'http://localhost/some_video.mkv'
	li = xbmcgui.ListItem(foldername + ' Video', iconImage='DefaultVideo.png')		li = xbmcgui.ListItem(foldername + ' Video', iconImage='DefaultVideo.png')
			li.setProperty('IsPlayable', 'true')
	xbmcplugin.addDirectoryItem(handle=addon_handle, url=url, listitem=li)		xbmcplugin.addDirectoryItem(handle=addon_handle, url=url, listitem=li)
	xbmcplugin.endOfDirectory(addon_handle)		xbmcplugin.endOfDirectory(addon_handle)

NedBot: web link corrections for xbmc -> kodi

2015-05-13T00:39:30Z

web link corrections for xbmc -> kodi

← Older revision		Revision as of 00:39, 13 May 2015
Line 134:		Line 134:
	= Showing additional metadata =		= Showing additional metadata =

	We've already seen how to show some basic metadata, like the icon image and the type of the item (<code>'video'</code> in our case). However, there are many more pieces of metadata that Kodi understands, and adding them can make life easier on your users. We'll take a look at some of the more important ones. You can also find a full list in the [http://mirrors.~~xbmc~~.~~org~~/docs/python-docs Python documentation] for <code>[http://mirrors.~~xbmc~~.~~org~~/docs/python-docs/12.2-frodo/xbmcgui.html#ListItem xbmcgui.ListItem]</code>.		We've already seen how to show some basic metadata, like the icon image and the type of the item (<code>'video'</code> in our case). However, there are many more pieces of metadata that Kodi understands, and adding them can make life easier on your users. We'll take a look at some of the more important ones. You can also find a full list in the [http://mirrors.kodi.tv/docs/python-docs Python documentation] for <code>[http://mirrors.kodi.tv/docs/python-docs/12.2-frodo/xbmcgui.html#ListItem xbmcgui.ListItem]</code>.

	== Icons and thumbnails ==		== Icons and thumbnails ==
Line 159:		Line 159:
	</syntaxhighlight>		</syntaxhighlight>

	If you'd prefer to show the default fanart from your add-on, you can get the path to that image from the <code>[http://mirrors.~~xbmc~~.~~org~~/docs/python-docs/12.2-frodo/xbmcaddon.html#Addon xbmcaddon.Addon]</code> object:		If you'd prefer to show the default fanart from your add-on, you can get the path to that image from the <code>[http://mirrors.kodi.tv/docs/python-docs/12.2-frodo/xbmcaddon.html#Addon xbmcaddon.Addon]</code> object:

	<syntaxhighlight lang="python" enclose="div">		<syntaxhighlight lang="python" enclose="div">
Line 177:		Line 177:
	</syntaxhighlight>		</syntaxhighlight>

	For a full list of the available info labels, consult the documentation for <code>[http://mirrors.~~xbmc~~.~~org~~/docs/python-docs/12.2-frodo/xbmcgui.html#ListItem-setInfo ListItem.setInfo]</code>.		For a full list of the available info labels, consult the documentation for <code>[http://mirrors.kodi.tv/docs/python-docs/12.2-frodo/xbmcgui.html#ListItem-setInfo ListItem.setInfo]</code>.

	== Stream info ==		== Stream info ==
Line 190:		Line 190:
	</syntaxhighlight>		</syntaxhighlight>

	For complete documentation about this function, see <code>[http://mirrors.~~xbmc~~.~~org~~/docs/python-docs/12.2-frodo/xbmcgui.html#ListItem-addStreamInfo ListItem.addStreamInfo]</code>.		For complete documentation about this function, see <code>[http://mirrors.kodi.tv/docs/python-docs/12.2-frodo/xbmcgui.html#ListItem-addStreamInfo ListItem.addStreamInfo]</code>.

	= Adding context menus =		= Adding context menus =