Simonc: /* UPnP Service Description */

2015-12-15T12:10:33Z

UPnP Service Description

← Older revision		Revision as of 12:10, 15 December 2015
Line 98:		Line 98:

	<tt>name: "Product"		<tt>name: "Product"
-	[[br]]domain: "openhome.org.eriskay"	+	<br>domain: "openhome.org.eriskay"
-	[[br]]version: "1"</tt>	+	<br>version: "1"</tt>
	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml">
	<?xml version="1.0" encoding="utf-8"?>		<?xml version="1.0" encoding="utf-8"?>

Simonc: Created page with "= Product Service = == Overview == The Product service contains a summary of a single product’s capabilities. After using the Device ..."

2015-12-15T12:10:15Z

Created page with "= Product Service = == Overview == The Product service contains a summary of a single product’s capabilities. After using the Device ..."

New page

= Product Service =

== Overview ==
The Product service contains a summary of a single product’s capabilities. After using the [[Av:Developer:Eriskay:DeviceService | Device]] service to confirm both compatibility and the presence of the <tt>openhome.org.product</tt> attribute, control points should begin their interaction with an OpenHome device by using the Product service. Presence of various other services can be inferred from the sources and attributes this reports.

If the Product service is available, all its properties and actions must be fully implemented.

== Evented Properties ==
=== SourceArray ===
Returns a summary of all sources as a JSON array:
<tt>
[
{
"name": "user name for source"
"type": "type of source"
"visible": "Boolean. Whether control points should display source"
"systemName": "default name for source"
}
]
</tt>
Source <tt>type</tt> may have any implementation-defined value. The following values have a commonly understood meaning:

* <tt>Playlist</tt> - the <tt>openhome.org.eriskay:Playlist:1</tt> service must be available
* <tt>Radio</tt> - the <tt>openhome.org.eriskay:Radio:1</tt> service must be available
* <tt>Receiver</tt> - the <tt>openhome.org.eriskay:Receiver:1</tt> service must be available
* <tt>UpnpAv</tt> - the <tt>upnp.org:MediaRenderer:1</tt> device must be available
* <tt>Single</tt> - software source that plays a single track
* <tt>NetAux</tt> - Specifies 3rd party, non OpenHome controllable, network protocols such as AirPlay
* <tt>Analog</tt> - Specifies an analog external input
* <tt>Digital</tt> - Specifies a digital external input
* <tt>Hdmi</tt> - Specifies a HDMI external input

Other implementation-defined values are possible. Control points that have not been developed to support them should treat such sources as comparable to external inputs.

Each <tt>systemName</tt> is guaranteed to be unique within the array.

=== SourceSystemName ===
The <tt>systemName</tt> of the currently active source.

=== Attributes ===
Space delimited set of values. Each value guarantees the availability of a service or resource, saving a control point from searching for each of these in turn. Supported values for attributes include

* <tt>Transport</tt> – the <tt>openhome.org.eriskay:Transport:1</tt> service must be available
* <tt>Time</tt> – the <tt>openhome.org.eriskay:Time:1</tt> service must be available
* <tt>Volume</tt> – the <tt>openhome.org.eriskay:Volume:1</tt> service must be available
* <tt>Sender</tt> - the <tt>openhome.org.eriskay:Sender:1</tt> service must be available
* <tt>Credentials</tt> - the <tt>openhome.org.eriskay:Credentials:1</tt> service must be available

=== Name ===
User-visible product name. By default this is set to the model name as reported by the Device service.
Note that the UPnP friendly name is derived by combining this with Room name in the form <tt>Room : Name</tt>.

=== Room ===
The name of the room where the Product is located. <tt>Room</tt> is used to group the Product with other related Products in the same physical room (e.g. a source with a pre-amp). Products which are physically linked must always share the same <tt>Room</tt> name.

=== Home ===
User-visible name for a home (a collection of rooms). Reserved for future use.

== Actions ==
=== SourceArray ===
<tt>
Arguments: (out string array)
</tt> 
Return the value of the <tt>SourceArray</tt> property.

=== SourceArrayChangeCount ===
<tt>
Arguments: (out uint count)
</tt> 
Query how often the <tt>SourceArray</tt> property has been updated. This action can be polled by clients that don’t support eventing. Whenever the value returned increases, <tt>SourceArray</tt> has been updated so should be queried again.

=== SourceSystemName ===
<tt>
Arguments: (out string systemName)
</tt> 
Return the value of the <tt>SourceSystemName</tt> property.

=== SetSource ===
<tt>
Arguments: (in string systemName)
</tt> 
Set the currently active source to the one with the specified system name.

=== Attributes ===
<tt>
Arguments: (out string attributes)
</tt> 
Return the value of the <tt>Attributes</tt> property.

=== Names ===
<tt>
Arguments: (out string room, out string name, out string home)
</tt> 
Return the values of the <tt>Room</tt>, <tt>Name</tt> and <tt>Home</tt> properties.

== UPnP Service Description ==
For devices supporting the UPnP protocol, the service description is

<tt>name: "Product"
[[br]]domain: "openhome.org.eriskay"
[[br]]version: "1"</tt>
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<scpd xmlns="urn:schemas-upnp-org:service-1-0">
<specVersion>
<major>1</major>
<minor>0</minor>
</specVersion>
<actionList>
<action>
<name>Names</name>
<argumentList>
<argument>
<name>Room</name>
<direction>out</direction>
<relatedStateVariable>Room</relatedStateVariable>
</argument>
<argument>
<name>Name</name>
<direction>out</direction>
<relatedStateVariable>Name</relatedStateVariable>
</argument>
<argument>
<name>Home</name>
<direction>out</direction>
<relatedStateVariable>Home</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>SourceArray</name>
<argumentList>
<argument>
<name>Array</name>
<direction>out</direction>
<relatedStateVariable>SourceArray</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>SetSource</name>
<argumentList>
<argument>
<name>Index</name>
<direction>in</direction>
<relatedStateVariable>SourceSystemName</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>Attributes</name>
<argumentList>
<argument>
<name>Attributes</name>
<direction>out</direction>
<relatedStateVariable>Attributes</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>SourceSystemName</name>
<argumentList>
<argument>
<name>SourceSystemName</name>
<direction>out</direction>
<relatedStateVariable>Attributes</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>SourceArrayChangeCount</name>
<argumentList>
<argument>
<name>Count</name>
<direction>out</direction>
<relatedStateVariable>SourceArrayChangeCount</relatedStateVariable>
</argument>
</argumentList>
</action>
</actionList>
<serviceStateTable>
<stateVariable sendEvents="yes">
<name>Room</name>
<dataType>string</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>Name</name>
<dataType>string</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>Home</name>
<dataType>string</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>SourceSystemName</name>
<dataType>string</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>SourceArray</name>
<dataType>string</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>Attributes</name>
<dataType>string</dataType>
</stateVariable>
<stateVariable sendEvents="no">
<name>SourceArrayChangeCount</name>
<dataType>ui4</dataType>
</stateVariable>
</serviceStateTable>
</scpd>
</syntaxhighlight>

Av:Developer:Eriskay:ProductService - Revision history

Simonc: /* UPnP Service Description */

Simonc: Created page with "= Product Service = == Overview == The Product service contains a summary of a single product’s capabilities. After using the Device ..."