Difference between revisions of "Service add-ons"

From Official Kodi Wiki
Jump to navigation Jump to search
(Fix dead-end page and edit for concision)
 
Line 1: Line 1:
Service [[add-ons]] will be automatically started when a [[Profiles|user profile]] logs in or on Kodi startup, and stopped when the user profile logs out. They must offer the '''<code>xbmc.service</code>''' extension point. Here's a typical example of the contents of the [[addon.xml]] file such add-ons need to provide:


Service addons will be automatically started when a user profile logs in or on Kodi startup, and stopped when the user profile logs out. These addons must offer the '''xbmc.service''' extension point. Here's a typical example of the addon.xml the addon needs to provide:
<syntaxhighlight lang="xml">
 
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon id="service.example"
<addon id="service.example"
Line 19: Line 18:
</syntaxhighlight>
</syntaxhighlight>


If your addon is meant to be run while Kodi is running, you need to periodically check if Kodi is exiting. The addon is responsible for terminating when Kodi wants to exit. This can be checked by creating a <code>xbmc.Monitor</code> instance and calling the <code>abortRequested()</code> method. To wait for this event instead, call <code>waitForAbort()</code>.
If your add-on is meant to be run while Kodi is running, you need to periodically check if Kodi is exiting. The add-on is responsible for terminating when Kodi wants to exit. This can be checked by creating an <code>xbmc.Monitor</code> instance and calling the <code>abortRequested()</code> method. To wait for this event instead, call the <code>waitForAbort()</code> method.


Example service that prints "hello addon!" every 10 second until Kodi exits:
Below is an example service that prints "hello addon!" every 10 seconds until Kodi exits:


<syntaxhighlight lang=python>
<syntaxhighlight lang="python">
import time
import time
import xbmc
import xbmc
Line 37: Line 36:
         xbmc.log("hello addon! %s" % time.time(), level=xbmc.LOGDEBUG)
         xbmc.log("hello addon! %s" % time.time(), level=xbmc.LOGDEBUG)
</syntaxhighlight>
</syntaxhighlight>


== Gotham and earlier ==
== Gotham and earlier ==
<code>abortRequested()</code> and <code>waitForAbort()</code> are new in Helix. In Gotham and earlier, use <code>xbmc.sleep</code> and check the <code>xbmc.abortRequested</code> attribute periodically.
<code>abortRequested()</code> and <code>waitForAbort()</code> are new methods introduced with Kodi [[Archive:Helix|Helix]]. In [[Archive:Gotham API changes|Gotham]] and earlier, use <code>xbmc.sleep</code> and check the <code>xbmc.abortRequested</code> attribute periodically.


Example:
Example:


<syntaxhighlight lang=python>
<syntaxhighlight lang="python">
import xbmc
import xbmc
   
   
Line 53: Line 51:
</syntaxhighlight>
</syntaxhighlight>


 
== Leia and earlier ==
Prior to Kodi 18 Leia there was an additional option ''start="startup"'' that would start the service add-on before the first profile login, but that functionality and usefulness were limited so this option was removed.
Prior to Kodi v18 [[Leia]], there was an additional option, <code>start="startup"</code>, that would start the service add-on before the first profile login, but the usefulness of that functionality was found to be negligible, and it was removed.




[[Category:Add-on development]]
[[Category:Add-on development]]

Latest revision as of 01:41, 23 September 2021

Service add-ons will be automatically started when a user profile logs in or on Kodi startup, and stopped when the user profile logs out. They must offer the xbmc.service extension point. Here's a typical example of the contents of the addon.xml file such add-ons need to provide:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon id="service.example"
       name="Example service"
       version="1.0.0"
       provider-name="">
  <requires>
    <import addon="xbmc.python" version="2.1.0"/>
  </requires>
  <extension point="xbmc.service" library="service.py" />
  <extension point="xbmc.addon.metadata">
    <platform>all</platform>
    <summary lang="en"></summary>
  </extension>
</addon>

If your add-on is meant to be run while Kodi is running, you need to periodically check if Kodi is exiting. The add-on is responsible for terminating when Kodi wants to exit. This can be checked by creating an xbmc.Monitor instance and calling the abortRequested() method. To wait for this event instead, call the waitForAbort() method.

Below is an example service that prints "hello addon!" every 10 seconds until Kodi exits:

import time
import xbmc

if __name__ == '__main__':
    monitor = xbmc.Monitor()
    
    while not monitor.abortRequested():
        # Sleep/wait for abort for 10 seconds
        if monitor.waitForAbort(10):
            # Abort was requested while waiting. We should exit
            break
        xbmc.log("hello addon! %s" % time.time(), level=xbmc.LOGDEBUG)

1 Gotham and earlier

abortRequested() and waitForAbort() are new methods introduced with Kodi Helix. In Gotham and earlier, use xbmc.sleep and check the xbmc.abortRequested attribute periodically.

Example:

import xbmc
 
if __name__ == '__main__':
    while not xbmc.abortRequested:
        # some code
        xbmc.sleep(500)

2 Leia and earlier

Prior to Kodi v18 Leia, there was an additional option, start="startup", that would start the service add-on before the first profile login, but the usefulness of that functionality was found to be negligible, and it was removed.