Skip to content
Back to top
View this page

# XEP-0118: User Tune

XEP-0118 on xmpp.org

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

  XEP-0118: User Tune

  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 (`str` | `None`) – The artist or performer of the song.

      - length (`int` | `None`) – The length of the song in seconds.

      - rating (`int` | `None`) – The user’s rating of the song (from 1 to 10)

      - source (`str` | `None`) – The album name, website, or other source of the song.

      - title (`str` | `None`) – The title of the song.

      - track (`str` | `None`) – The song’s track number, or other unique identifier.

      - uri (`str` | `None`) – 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.