XEP-0118: User Tune#

class slixmpp.plugins.xep_0118.XEP_0118(xmpp, config=None)[source]#

XEP-0118: User Tune

publish_tune(*, artist=None, length=None, rating=None, source=None, title=None, track=None, uri=None, **pubsubkwargs)[source]#

Publish the user’s current tune.

  • artist (Optional[str]) – The artist or performer of the song.

  • length (Optional[int]) – The length of the song in seconds.

  • rating (Optional[int]) – The user’s rating of the song (from 1 to 10)

  • source (Optional[str]) – The album name, website, or other source of the song.

  • title (Optional[str]) – The title of the song.

  • track (Optional[str]) – The song’s track number, or other unique identifier.

  • uri (Optional[str]) – A URL to more information about the song.

Return type



Clear existing user tune information to stop notifications.

Return type


Stanza elements#

class slixmpp.plugins.xep_0118.stanza.UserTune(xml=None, parent=None)[source]#
interfaces: ClassVar[Set[str]] = {'artist', 'length', 'rating', 'source', 'title', 'track', 'uri'}#

The set of keys that the stanza provides for accessing and manipulating the underlying XML object. This set may be augmented with the plugin_attrib value of any registered stanza plugins.

iterables: List[ElementBase]#

A list of child stanzas whose class is included in plugin_iterables.

loaded_plugins: Set[str]#
name: ClassVar[str] = 'tune'#

The XML tag name of the element, not including any namespace prefixes. For example, an ElementBase object for <message /> would use name = 'message'.

namespace: str = 'http://jabber.org/protocol/tune'#

The XML namespace for the element. Given <foo xmlns="bar" />, then namespace = "bar" should be used. The default namespace is jabber:client since this is being used in an XMPP library.

parent: Optional[ReferenceType[ElementBase]]#

A weakref.weakref to the parent stanza, if there is one. If not, then parent is None.

plugin_attrib: ClassVar[str] = 'tune'#

For ElementBase subclasses which are intended to be used as plugins, the plugin_attrib value defines the plugin name. Plugins may be accessed by using the plugin_attrib value as the interface. An example using plugin_attrib = 'foo':

register_stanza_plugin(Message, FooPlugin)
msg = Message()
plugins: Dict[Tuple[str, Optional[str]], ElementBase]#

An ordered dictionary of plugin stanzas, mapped by their plugin_attrib value.

sub_interfaces: ClassVar[Set[str]] = {'artist', 'length', 'rating', 'source', 'title', 'track', 'uri'}#

A subset of interfaces which maps interfaces to direct subelements of the underlying XML object. Using this set, the text of these subelements may be set, retrieved, or removed without needing to define custom methods.

tag: str#

The name of the tag for the stanza’s root element. It is the same as calling tag_name() and is formatted as '{namespace}elementname'.

xml: ET.Element#

The underlying XML object for the stanza. It is a standard xml.etree.ElementTree object.