Av:Developer:ReceiverService - Revision history

Simonc: /* ProtocolInfo */

2013-11-05T11:12:18Z

ProtocolInfo

← Older revision		Revision as of 11:12, 5 November 2013
Line 10:		Line 10:
	Reports the protocols supported in the normal UPnP forum format – a comma separated list of elements of the form		Reports the protocols supported in the normal UPnP forum format – a comma separated list of elements of the form

-	<tt><protocol>: <network>:<contentFormat>:<additionalInfo></tt>	+	<tt><protocol>:<network>:<contentFormat>:<additionalInfo></tt>

	Supported <tt>protocol</tt> elements are <tt><ohz></tt>, <tt><ohm></tt> and <tt><ohu></tt>. Other elements are normally wildcards <tt>*</tt>		Supported <tt>protocol</tt> elements are <tt><ohz></tt>, <tt><ohm></tt> and <tt><ohu></tt>. Other elements are normally wildcards <tt>*</tt>
		+
	== TransportState ==		== TransportState ==
	Report the current transport state, which can be: <tt>Playing</tt>, <tt>Waiting</tt>, <tt>Stopped</tt> or <tt>Buffering</tt>.		Report the current transport state, which can be: <tt>Playing</tt>, <tt>Waiting</tt>, <tt>Stopped</tt> or <tt>Buffering</tt>.

Simonc: /* Product Service Description (XML) */

2013-11-05T11:06:16Z

Product Service Description (XML)

← Older revision		Revision as of 11:06, 5 November 2013
Line 30:		Line 30:
	Report the value of the <tt>TransportState</tt> state variable.		Report the value of the <tt>TransportState</tt> state variable.

-	= ~~Product~~ Service Description (XML) =	+	= Receiver Service Description (XML) =
	<code>		<code>
	Domain : av.openhome.org		Domain : av.openhome.org

Simonc at 11:05, 5 November 2013

2013-11-05T11:05:43Z

← Older revision		Revision as of 11:05, 5 November 2013
Line 1:		Line 1:
-	= ~~Architectural~~ Overview =	+	= Overview =
		+	A Songcast receiver plays audio broadcast from a [[Developer:SenderService\|Songcast sender]].
		+	<br>The Receiver service provides the means for controlling a Receiver source. If a device's [[Developer:ProductService\|Product service]] reports a source of type <tt>Receiver</tt>, then that device is guaranteed to bear the Receiver service.
		+	= State Variables =
		+	== Metadata ==
		+	The metadata of the sender to listen to. In the DIDL-lite format provided by the [[Developer:SenderService\|Sender service]].
		+	== Uri ==
		+	The uri of the [[Developer:SenderService\|Sender]] to listen to. This must match the uri from the sender’s metadata.
		+	== ProtocolInfo ==
		+	Reports the protocols supported in the normal UPnP forum format – a comma separated list of elements of the form

-	~~The Receiver service provides the means for controlling a Receiver source. If a device's [[Developer~~:~~ProductService\|Product service]] reports a source of type 'Receiver', then that device is guaranteed to bear the Receiver service.~~	+	<tt><protocol>: <network>:<contentFormat>:<additionalInfo></tt>
-		+
-	~~A receiver plays audio broadcast from a [[Developer~~:~~SenderService\|sender]].~~	+

		+	Supported <tt>protocol</tt> elements are <tt><ohz></tt>, <tt><ohm></tt> and <tt><ohu></tt>. Other elements are normally wildcards <tt>*</tt>
		+	== TransportState ==
		+	Report the current transport state, which can be: <tt>Playing</tt>, <tt>Waiting</tt>, <tt>Stopped</tt> or <tt>Buffering</tt>.
		+	<br>Note that network conditions may prevent a Receiver from accurately differentiating between <tt>Waiting</tt> and <tt>Buffering</tt> states.
	= Actions =		= Actions =
		+	== Play ==
		+	Play audio from the current sender.
		+	== Stop ==
		+	Stop playing audio from the current sender.
		+	== SetSender ==
		+	Set the <tt>uri</tt> and <tt>metadata</tt> of the sender to listen to.
	== Sender ==		== Sender ==
-	Report the ~~Uri and Metadata~~ of the ~~sender this receiver is currently listening to.~~	+	Report the values of the <tt>Uri</tt> and <tt>Metadata</tt> state variables.
-		+	== ProtocolInfo ==
-	~~==SetSender==~~	+	Report the value of the <tt>ProtocolInfo</tt> state variable.
-	~~Set the~~ Uri and Metadata ~~of the sender to listen to~~.	+	== TransportState ==
-		+	Report the value of the <tt>TransportState</tt> state variable.
-	~~The Metadata must have originated from a device bearing the [[Developer:SenderService\|Sender service]].~~	+
-		+
-	~~The Uri must be the result of applying this receiver's ProtocolInfo to this Metadata.~~	+
-		+
-	==ProtocolInfo==	+
-	Report the ~~receiver's protocol info~~.	+
-		+
-	==TransportState==	+
-		+
-	Report the ~~current transport~~ state~~, which can be: 'Playing', 'Paused', 'Stopped', or 'Buffering'~~.	+
-		+
-	~~==Play==~~	+
-	~~Play audio from the current sender~~	+
-		+
-	~~==Stop==~~	+
-	~~Stop playing audio from the current sender~~	+

-	= ~~Technical Details~~ =	+	= Product Service Description (XML) =
	<code>		<code>
	Domain : av.openhome.org		Domain : av.openhome.org
Line 36:		Line 37:
	</code>		</code>

-	~~== Receiver Service Description (XML) ==~~
	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml">
	<?xml version="1.0"?>		<?xml version="1.0"?>

Openhome at 15:17, 5 May 2011

2011-05-05T15:17:33Z

← Older revision		Revision as of 15:17, 5 May 2011
Line 37:		Line 37:

	== Receiver Service Description (XML) ==		== Receiver Service Description (XML) ==
-	<~~code~~>	+	<syntaxhighlight lang="xml">
	<?xml version="1.0"?>		<?xml version="1.0"?>
	<scpd xmlns="urn:schemas-upnp-org:service-1-0">		<scpd xmlns="urn:schemas-upnp-org:service-1-0">
Line 128:		Line 128:
	</serviceStateTable>		</serviceStateTable>
	</scpd>		</scpd>
-	</~~code~~>	+	</syntaxhighlight>

Joshh: /* Receiver Service Description (XML) */

2011-05-05T14:12:59Z

Receiver Service Description (XML)

← Older revision		Revision as of 14:12, 5 May 2011
Line 38:		Line 38:
	== Receiver Service Description (XML) ==		== Receiver Service Description (XML) ==
	<code>		<code>
		+	<?xml version="1.0"?>
		+	<scpd xmlns="urn:schemas-upnp-org:service-1-0">
		+	<specVersion>
		+	<major>1</major>
		+	<minor>0</minor>
		+	</specVersion>
		+	<actionList>
		+	<action>
		+	<name>Play</name>
		+	</action>
		+	<action>
		+	<name>Stop</name>
		+	</action>
		+	<action>
		+	<name>SetSender</name>
		+	<argumentList>
		+	<argument>
		+	<name>Uri</name>
		+	<direction>in</direction>
		+	<relatedStateVariable>Uri</relatedStateVariable>
		+	</argument>
		+	<argument>
		+	<name>Metadata</name>
		+	<direction>in</direction>
		+	<relatedStateVariable>Metadata</relatedStateVariable>
		+	</argument>
		+	</argumentList>
		+	</action>
		+	<action>
		+	<name>Sender</name>
		+	<argumentList>
		+	<argument>
		+	<name>Uri</name>
		+	<direction>out</direction>
		+	<relatedStateVariable>Uri</relatedStateVariable>
		+	</argument>
		+	<argument>
		+	<name>Metadata</name>
		+	<direction>out</direction>
		+	<relatedStateVariable>Metadata</relatedStateVariable>
		+	</argument>
		+	</argumentList>
		+	</action>
		+	<action>
		+	<name>ProtocolInfo</name>
		+	<argumentList>
		+	<argument>
		+	<name>Value</name>
		+	<direction>out</direction>
		+	<relatedStateVariable>ProtocolInfo</relatedStateVariable>
		+	</argument>
		+	</argumentList>
		+	</action>
		+	<action>
		+	<name>TransportState</name>
		+	<argumentList>
		+	<argument>
		+	<name>Value</name>
		+	<direction>out</direction>
		+	<relatedStateVariable>TransportState</relatedStateVariable>
		+	</argument>
		+	</argumentList>
		+	</action>
		+	</actionList>
		+
		+	<serviceStateTable>
		+	<stateVariable sendEvents="yes">
		+	<name>Uri</name>
		+	<dataType>string</dataType>
		+	</stateVariable>
		+	<stateVariable sendEvents="yes">
		+	<name>Metadata</name>
		+	<dataType>string</dataType>
		+	</stateVariable>
		+	<stateVariable sendEvents="yes">
		+	<name>TransportState</name>
		+	<dataType>string</dataType>
		+	<allowedValueList>
		+	<allowedValue>Stopped</allowedValue>
		+	<allowedValue>Playing</allowedValue>
		+	<allowedValue>Waiting</allowedValue>
		+	<allowedValue>Buffering</allowedValue>
		+	</allowedValueList>
		+	</stateVariable>
		+	<stateVariable sendEvents="yes">
		+	<name>ProtocolInfo</name>
		+	<dataType>string</dataType>
		+	</stateVariable>
		+	</serviceStateTable>
		+	</scpd>
	</code>		</code>

Joshh: /* Technical Details */

2011-05-05T14:07:30Z

Technical Details

← Older revision		Revision as of 14:07, 5 May 2011
Line 35:		Line 35:
	Version : 1		Version : 1
	</code>		</code>
-	~~[http://oss.linn.co.uk/trac/browser/Main/LibUpnpCil/Services/Openhome/Receiver1.xml~~ Receiver Service Description (XML)]	+
		+	== Receiver Service Description (XML) ==
		+	<code>
		+	</code>

Keith: moved Developer:ReceiverService to Av:Developer:ReceiverService

2011-04-28T14:00:39Z

moved Developer:ReceiverService to Av:Developer:ReceiverService

← Older revision

Revision as of 14:00, 28 April 2011

Joshh: Created page with "= Architectural Overview = The Receiver service provides the means for controlling a Receiver source. If a device's Product service reports a source..."

2011-04-28T12:37:01Z

Created page with "= Architectural Overview = The Receiver service provides the means for controlling a Receiver source. If a device's Product service reports a source..."

New page

= Architectural Overview =

The Receiver service provides the means for controlling a Receiver source. If a device's [[Developer:ProductService|Product service]] reports a source of type 'Receiver', then that device is guaranteed to bear the Receiver service.

A receiver plays audio broadcast from a [[Developer:SenderService|sender]].

= Actions =
== Sender ==
Report the Uri and Metadata of the sender this receiver is currently listening to.

==SetSender==
Set the Uri and Metadata of the sender to listen to.

The Metadata must have originated from a device bearing the [[Developer:SenderService|Sender service]].

The Uri must be the result of applying this receiver's ProtocolInfo to this Metadata.

==ProtocolInfo==
Report the receiver's protocol info.

==TransportState==

Report the current transport state, which can be: 'Playing', 'Paused', 'Stopped', or 'Buffering'.

==Play==
Play audio from the current sender

==Stop==
Stop playing audio from the current sender

= Technical Details =
<code>
Domain : av.openhome.org
Name : Receiver
Version : 1
</code>
[http://oss.linn.co.uk/trac/browser/Main/LibUpnpCil/Services/Openhome/Receiver1.xml Receiver Service Description (XML)]