Av:Developer:RadioService - Revision history

Simonc: /* Architectural Overview */

2013-08-02T10:58:19Z

Architectural Overview

← Older revision		Revision as of 10:58, 2 August 2013
Line 1:		Line 1:
-	= ~~Architectural~~ Overview =	+	= Overview =
	The Radio service primarily offers the means for controlling radio presets; it also offers an API to allow arbitrary URLs to be played.		The Radio service primarily offers the means for controlling radio presets; it also offers an API to allow arbitrary URLs to be played.
	If a device’s Product service reports a source of type 'Radio', then the device that bears that Product service is guaranteed to also bear the Radio service.		If a device’s Product service reports a source of type 'Radio', then the device that bears that Product service is guaranteed to also bear the Radio service.

Simonc at 09:46, 13 June 2013

2013-06-13T09:46:38Z

← Older revision		Revision as of 09:46, 13 June 2013
Line 2:		Line 2:
	The Radio service primarily offers the means for controlling radio presets; it also offers an API to allow arbitrary URLs to be played.		The Radio service primarily offers the means for controlling radio presets; it also offers an API to allow arbitrary URLs to be played.
	If a device’s Product service reports a source of type 'Radio', then the device that bears that Product service is guaranteed to also bear the Radio service.		If a device’s Product service reports a source of type 'Radio', then the device that bears that Product service is guaranteed to also bear the Radio service.
		+
		+	= State Variables =
		+	== ChannelsMax ==
		+	The maximum number of presets (and so the number of elements in IdArray). Read-only.
		+	== Id ==
		+	The id of the currently selected preset (as set by the last call to SetId). Or 0 if no preset has ever been selected or SetChannel was called more recently than SetId.
		+	== IdArray ==
		+	Base64-encoded array of 32-bit big endian unsigned integers. Will always be (ChannelsMax * 4) bytes long. Each id represents a preset id. A value of 0 implies that no preset is set for that slot.
		+	== Metadata ==
		+	Metadata for the last track to be selected (via a call to either SetChannel or SetId).
		+	== ProtocolInfo ==
		+	Audio formats and networking protocols supported by the device. Will be the same as reported by Playlist and AVTransport if these services are present. Read-only.
		+	== TransportState ==
		+	One of Stopped, Playing, Paused or Buffering.
		+	== Uri ==
		+	The last uri to be set (via a call to either SetChannel or SetId).

	= Actions =		= Actions =
Line 67:		Line 83:
	Return the value of the TransportState state variable.		Return the value of the TransportState state variable.

-	~~= State Variables =~~
-	~~== ChannelsMax ==~~
-	~~The maximum number of presets (and so the number of elements in IdArray). Read-only.~~
-	~~== Id ==~~
-	~~The id of the currently selected preset (as set by the last call to SetId). Or 0 if no preset has ever been selected or SetChannel was called more recently than SetId.~~
-	~~== IdArray ==~~
-	Base64-encoded array of 32-bit big endian unsigned integers. Will always be (ChannelsMax * 4) bytes long. Each id represents a preset id. A value of 0 implies that no preset is set for that slot.
-	~~== Metadata ==~~
-	~~Metadata for the last track to be selected (via a call to either SetChannel or SetId).~~
-	~~== ProtocolInfo ==~~
-	~~Audio formats and networking protocols supported by the device. Will be the same as reported by Playlist and AVTransport if these services are present. Read-only.~~
-	~~== TransportState ==~~
-	~~One of Stopped, Playing, Paused or Buffering.~~
-	~~== Uri ==~~
-	~~The last uri to be set (via a call to either SetChannel or SetId).~~
	= Technical Details =		= Technical Details =
	<code>		<code>

Simonc: /* ReadList */

2013-06-12T13:02:34Z

ReadList

← Older revision		Revision as of 13:02, 12 June 2013
Line 50:		Line 50:
	</ChannelList>		</ChannelList>
	</syntaxhighlight>		</syntaxhighlight>
		+
	Note that the content of each metadata will be fully xml escaped (so metadata for a given id won't be byte-for-byte identical to that returned by Read).		Note that the content of each metadata will be fully xml escaped (so metadata for a given id won't be byte-for-byte identical to that returned by Read).

Simonc: /* ReadList */

2013-06-12T13:02:23Z

ReadList

← Older revision		Revision as of 13:02, 12 June 2013
Line 39:		Line 39:
	== ReadList ==		== ReadList ==
	Given a space separated list of channel preset Ids, return their associated metadata. The metadata will be of the form		Given a space separated list of channel preset Ids, return their associated metadata. The metadata will be of the form
-	<ChannelList>	+	<syntaxhighlight lang="xml">
-	<Entry>	+	<ChannelList>
-	<Id>[preset Id]</Id>	+	<Entry>
-	<Metadata>[as for Read]</Metadata>	+	<Id>[preset Id]</Id>
-	</Entry>	+	<Metadata>[as for Read]</Metadata>
-	<Entry>	+	</Entry>
-	....	+	<Entry>
-	</Entry>	+	....
-	</ChannelList>	+	</Entry>
		+	</ChannelList>
		+	</syntaxhighlight>
	Note that the content of each metadata will be fully xml escaped (so metadata for a given id won't be byte-for-byte identical to that returned by Read).		Note that the content of each metadata will be fully xml escaped (so metadata for a given id won't be byte-for-byte identical to that returned by Read).

Simonc: /* Read */

2013-06-12T13:01:56Z

Read

← Older revision		Revision as of 13:01, 12 June 2013
Line 34:		Line 34:
	</item>		</item>
	</DIDL-Lite>		</DIDL-Lite>
		+	</syntaxhighlight>
	Note that additional elements may be present. The elements listed above are guaranteed to be present. The contents of all elements will be XML escaped.		Note that additional elements may be present. The elements listed above are guaranteed to be present. The contents of all elements will be XML escaped.

Simonc: /* Read */

2013-06-12T13:01:36Z

Read

← Older revision		Revision as of 13:01, 12 June 2013
Line 23:		Line 23:
	== Read ==		== Read ==
	Given a channel preset Id, return its associated metadata. The metadata will be of the form		Given a channel preset Id, return its associated metadata. The metadata will be of the form
-	<DIDL-Lite xmlns:dc="http://purl.org/dc/elements/1.1/"	+	<syntaxhighlight lang="xml">
-	xmlns:upnp="urn:schemas-upnp-org:metadata-1-0/upnp/"	+	<DIDL-Lite xmlns:dc="http://purl.org/dc/elements/1.1/"
-	xmlns="urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/">	+	xmlns:upnp="urn:schemas-upnp-org:metadata-1-0/upnp/"
-	<item id="" parentID="" restricted="True">	+	xmlns="urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/">
-	<dc:title>[title]</dc:title>	+	<item id="" parentID="" restricted="True">
-	<res protocolInfo=":::" bitrate="6000">[track url]</res>	+	<dc:title>[title]</dc:title>
-	<upnp:albumArtURI>[image url]</upnp:albumArtURI>	+	<res protocolInfo=":::" bitrate="6000">[track url]</res>
-	<upnp:class>object.item.audioItem</upnp:class>	+	<upnp:albumArtURI>[image url]</upnp:albumArtURI>
-	</item>	+	<upnp:class>object.item.audioItem</upnp:class>
-	</DIDL-Lite>	+	</item>
		+	</DIDL-Lite>
	Note that additional elements may be present. The elements listed above are guaranteed to be present. The contents of all elements will be XML escaped.		Note that additional elements may be present. The elements listed above are guaranteed to be present. The contents of all elements will be XML escaped.

Simonc at 12:42, 12 June 2013

2013-06-12T12:42:10Z

← Older revision		Revision as of 12:42, 12 June 2013
Line 8:		Line 8:

	== ChannelsMax ==		== ChannelsMax ==
-	~~Retrieve~~ the value of the ChannelsMax state variable.	+	Return the value of the ChannelsMax state variable.
	== Id ==		== Id ==
	Report the value of the Id state variable.		Report the value of the Id state variable.
	== IdArray ==		== IdArray ==
-	~~Retrieve~~ the value of the IdArray state variable.	+	Return the value of the IdArray state variable.
	== IdArrayChanged ==		== IdArrayChanged ==
	Check to see if the IdArray state variable has changed since gathering the specified IdArrayToken. This Token must have been previously collected from the IdArray action. This action is provided specifically for clients which do not use UPnP eventing.		Check to see if the IdArray state variable has changed since gathering the specified IdArrayToken. This Token must have been previously collected from the IdArray action. This action is provided specifically for clients which do not use UPnP eventing.
Line 20:		Line 20:
	Play any previously selected track (the last uri to be set via either SetChannel or SetId). Switches source to Radio if that wasn’t already selected.		Play any previously selected track (the last uri to be set via either SetChannel or SetId). Switches source to Radio if that wasn’t already selected.
	== ProtocolInfo ==		== ProtocolInfo ==
-	~~Retrieve~~ the value of the ProtocolInfo state variable.	+	Return the value of the ProtocolInfo state variable.
	== Read ==		== Read ==
-	Given a channel preset Id, ~~retrieve~~ its associated metadata. The metadata will be of the form	+	Given a channel preset Id, return its associated metadata. The metadata will be of the form
	<DIDL-Lite xmlns:dc="http://purl.org/dc/elements/1.1/"		<DIDL-Lite xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:upnp="urn:schemas-upnp-org:metadata-1-0/upnp/"		xmlns:upnp="urn:schemas-upnp-org:metadata-1-0/upnp/"
Line 36:		Line 36:

	== ReadList ==		== ReadList ==
-	Given a space separated list of channel preset Ids, ~~retrieve~~ their associated metadata. The metadata will be of the form	+	Given a space separated list of channel preset Ids, return their associated metadata. The metadata will be of the form
	<ChannelList>		<ChannelList>
	<Entry>		<Entry>
Line 60:		Line 60:
	Stop any currently playing radio stream. Should only be called when the Radio source is currently selected		Stop any currently playing radio stream. Should only be called when the Radio source is currently selected
	== TransportState ==		== TransportState ==
-	~~Retrieve~~ the value of the TransportState state variable.	+	Return the value of the TransportState state variable.

	= State Variables =		= State Variables =

Simonc: /* Channel */

2013-06-12T12:41:13Z

Channel

← Older revision		Revision as of 12:41, 12 June 2013
Line 5:		Line 5:
	= Actions =		= Actions =
	== Channel ==		== Channel ==
-	~~Retrieve~~ the values of the Uri and Metadata state variables.	+	Return the values of the Uri and Metadata state variables.
		+
	== ChannelsMax ==		== ChannelsMax ==
	Retrieve the value of the ChannelsMax state variable.		Retrieve the value of the ChannelsMax state variable.

Simonc: /* ReadList */

2013-06-12T12:38:21Z

ReadList

← Older revision		Revision as of 12:38, 12 June 2013
Line 45:		Line 45:
	</Entry>		</Entry>
	</ChannelList>		</ChannelList>
		+	Note that the content of each metadata will be fully xml escaped (so metadata for a given id won't be byte-for-byte identical to that returned by Read).
		+
	== SeekSecondAbsolute ==		== SeekSecondAbsolute ==
	Seek to an absolute (seconds) position in the currently playing stream, retaining the existing TransportState. Note that most radio streams are not seekable so this action is probably only applicable to a subset of tracks played via SetChannel that the Info service reports are seekable.		Seek to an absolute (seconds) position in the currently playing stream, retaining the existing TransportState. Note that most radio streams are not seekable so this action is probably only applicable to a subset of tracks played via SetChannel that the Info service reports are seekable.

Simonc: /* Read */

2013-06-12T12:37:04Z

Read

← Older revision		Revision as of 12:37, 12 June 2013
Line 32:		Line 32:
	</item>		</item>
	</DIDL-Lite>		</DIDL-Lite>
-	Note that additional elements may be present. The elements listed above are guaranteed to be present.	+	Note that additional elements may be present. The elements listed above are guaranteed to be present. The contents of all elements will be XML escaped.
		+
	== ReadList ==		== ReadList ==
	Given a space separated list of channel preset Ids, retrieve their associated metadata. The metadata will be of the form		Given a space separated list of channel preset Ids, retrieve their associated metadata. The metadata will be of the form