User Tune This specification defines a payload format for communicating information about music to which a user is listening, including the title, track number, collection, performer, composer, length, and user rating. The payload format is typically transported using the personal eventing protocol, a profile of XMPP publish-subscribe specified in XEP-0163. This XMPP Extension Protocol is copyright © 1999 – 2024 by the XMPP Standards Foundation (XSF). Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation. ## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ## In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages. This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at <https://xmpp.org/about/xsf/ipr-policy> or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA). 0118 Draft Standards Track Standards Council XMPP Core XEP-0163 tune http://www.xmpp.org/schemas/tune.xsd Peter Saint-Andre stpeter@stpeter.im stpeter@jabber.org https://stpeter.im/ 1.3.0 2020-10-20 mwb

Add further tags for non-pop music

 1.2 2008-01-30 psa

Added rating element.

 1.1 2007-06-04 psa

Removed non-PEP examples; added uri element.

 1.0 2004-11-12 psa

Per a vote of the Jabber Council, advanced status to Draft.

 0.10 2004-10-29 psa

Added example with URL.

 0.9 2004-10-27 psa

Changed recommendation to not include the <length/> element if the track time is unknown.

 0.8 2004-10-26 psa

Added implementation notes; clarified nature of <source/> and <track/> elements; if length is unknown, set to zero.

 0.7 2004-05-20 psa

Changed <length/> datatype from xs:duration to xs:unsignedShort.

 0.6 2004-04-25 psa

Corrected several errors; added reference to XEP-0033.

 0.5 2004-02-19 psa

Reverted from infobits to tune elements.

 0.4 2003-12-14 psa

Slight modifications to track changes to infobits specifications.

 0.3 2003-10-23 psa

Replaced tune elements with infobits.

 0.2 2003-09-10 psa

Added "stop" function via empty <tune/> element.

 0.1 2003-09-08 psa

Initial version.

This document defines a protocol for communicating information about the music to which a user is listening. Such information may be seen as a kind of "extended presence", and users may want to communicate such information to their contacts on the network as a fun add-on to traditional IM applications or to provide integration with common music-player applications.

Information about tunes is provided by the user and propagated on the network by the user's client. The information container for tune data is a <tune/> element that is qualified by the 'http://jabber.org/protocol/tune' namespace. The tune information itself is provided as the XML character data of the following children of the <tune/> element:

Element Description Example Datatype
artist The artist of the song or piece Yes xs:string
composer The composer of the song or piece Дмитрий Дмитриевич Шостакович (Dmitri Shostakovich) xs:string
date The recording or publication date of the song or piece 2003-02-15 xs:string
genre The genre of the song or piece Opera xs:string
language The language of the song or piece, SHOULD be an ISO-639 three letter code rus xs:string
length The duration of the song or piece in seconds 686 xs:unsignedShort
lyricist The lyricist of the song or piece William Shakespeare xs:string
rating The user's rating of the song or piece, from 1 (lowest) to 10 (highest). 8 xs:positiveInteger
performer The performer of the song or piece Елена Жидкова (Elena Zhidkova) xs:string
source The collection (e.g., album) or other source (e.g., a band website that hosts streams or audio files) Yessongs xs:string
title The title of the song or piece Heart of the Sunrise xs:string
track A unique identifier for the tune; e.g., the track number within a collection or the specific URI for the object (e.g., a stream or audio file) 3 xs:string
uri A URI or URL pointing to information about the song, collection, or artist http://www.yesworld.com/lyrics/Fragile.html#9 xs:anyURI

NOTE: The datatypes specified above are defined in XML Schema Part 2 XML Schema Part 2: Datatypes <http://www.w3.org/TR/xmlschema11-2/>..

Tune information SHOULD be communicated and transported by means of the Publish-Subscribe (XEP-0060) XEP-0060: Publish-Subscribe <https://xmpp.org/extensions/xep-0060.html>. subset specified in Personal Eventing Protocol (XEP-0163) XEP-0163: Personal Eventing Protocol <https://xmpp.org/extensions/xep-0163.html>.. Because tune information is not pure presence information and can change independently of the user's availability, it SHOULD NOT be provided as an extension to <presence/>.

Yes 686 8 Yessongs Heart of the Sunrise 3 http://www.yesworld.com/lyrics/Fragile.html#9 ]]>

The tune information is then delivered to all subscribers:

Yes 686 8 Yessongs Heart of the Sunrise 3 http://www.yesworld.com/lyrics/Fragile.html#9 ]]>

In order to indicate that the user is no longer listening to any tunes (or has simply disabled publication), the user's client shall send an empty <tune/> element, which can be considered a "stop command" for user tunes:

]]> ]]>

To prevent a large number of updates when a user is skipping through tracks, an implementation SHOULD wait several seconds before publishing new tune information.

If the length is unknown (e.g., the user is listening to a stream), the <length/> element SHOULD NOT be included.

A typical interface for user ratings is to show one to five star icons such as ★★★★. If this interface is used, the numbers 2, 4, 6, 8, and 10 should be mapped to one, two, three, four, and five stars respectively, and odd numbers should be mapped to half stars (e.g., the number 9 would be mapped to four-and-a-half stars).

The publication of user tune information is not known to introduce any new security considerations above and beyond those defined in XEP-0060: Publish-Subscribe.

This document requires no interaction with the Internet Assigned Numbers Authority (IANA) The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <http://www.iana.org/>..

The XMPP Registrar The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see <https://xmpp.org/registrar/>. includes 'http://jabber.org/protocol/tune' in its registry of protocol namespaces.

 The protocol documented by this schema is defined in XEP-0118: http://www.xmpp.org/extensions/xep-0118.html ]]>