XEP-0118: User Tune

class slixmpp.plugins.xep_0118.XEP_0118(xmpp, config=None)

XEP-0118: User Tune

dependencies: ClassVar[Set[str]] = {'xep_0163'}

Some plugins may depend on others in order to function properly. Any plugin names included in dependencies will be initialized as needed if this plugin is enabled.

description: str = 'XEP-0118: User Tune'

A longer name for the plugin, describing its purpose. For example, a plugin for XEP-0030 would use ‘Service Discovery’ as its description value.

name: str = 'xep_0118'

A short name for the plugin based on the implemented specification. For example, a plugin for XEP-0030 would use ‘xep_0030’.

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

Publish the user’s current tune.

Parameters:

• 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:

Future

stop(**pubsubkwargs)

Clear existing user tune information to stop notifications.

Return type:

Future

Stanza elements

class slixmpp.plugins.xep_0118.stanza.UserTune(xml=None, parent=None)

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.

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.

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()
msg['foo']['an_interface_from_the_foo_plugin']

set_length(value)

set_rating(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.