Simonc: Created page with "= Sender Service = == Overview == The Sender service indicates the presence of a Songcast sender and provides information concerning that sender. A Songcast sender broadcasts mu..."

2015-12-15T13:15:44Z

Created page with "= Sender Service = == Overview == The Sender service indicates the presence of a Songcast sender and provides information concerning that sender. A Songcast sender broadcasts mu..."

New page

= Sender Service =
== Overview ==
The Sender service indicates the presence of a Songcast sender and provides information concerning that sender.

A Songcast sender broadcasts music on a network in a way that is playable by a Songcast [[Av:Developer:Eriskay:ReceiverService | receiver]].

If a device's [[Av:Developer:Eriskay:ProductService | Product]] service reports an attribute <tt>"Sender"</tt>, then that device is guaranteed to bear the Sender service. Alternatively, Songcast senders can be discovered independently of the Product service by checking for the <tt>openhome.org.sender</tt> attribute on the [[Av:Developer:Eriskay:DeviceService | Device]] service.

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

== Evented Properties ==
=== Audio ===
<tt>true</tt> if audio is currently available from this Sender; <tt>false</tt> otherwise.

=== Metadata ===
Provides basic information about the sender in OpenHome Metadata format.
<tt>
{
"Title" : "[sender name]",
"Origin" : "openhome.org.sender",
"Uri" : "[ohz uri. ohu/ohm if ohz is not supported]",
"Artwork" : "[uri to icon for sender]",
"Channel" : "Songcast"
}
</tt>

=== Status ===
Reports the status of the sender:
* <tt>Enabled</tt> - sender enabled by user configuration (default)
* <tt>Disabled</tt> - sender disabled by user configuration
* <tt>Blocked</tt> - audio from another sender detected on the same channel (mis-configuration)

== Actions ==
=== Audio ===
<tt>
Arguments: (out bool audio)
</tt> 
Return the value of the <tt>Audio</tt> property.

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

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

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

<tt>name: "Sender"
 domain: "openhome.org.eriskay"
 version: "1"</tt>

<syntaxhighlight lang="xml">
<?xml version="1.0"?>
<scpd xmlns="urn:schemas-upnp-org:service-1-0">
<specVersion>
<major>1</major>
<minor>0</minor>
</specVersion>

<actionList>
<action>
<name>Audio</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Audio</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>Metadata</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Metadata</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>Status</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Status</relatedStateVariable>
</argument>
</argumentList>
</action>
</actionList>

<serviceStateTable>
<stateVariable sendEvents="yes">
<name>Audio</name>
<dataType>boolean</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>Metadata</name>
<dataType>string</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>Status</name>
<dataType>string</dataType>
<allowedValueList>
<allowedValue>Enabled</allowedValue>
<allowedValue>Disabled</allowedValue>
<allowedValue>Blocked</allowedValue>
</allowedValueList>
</stateVariable>
</serviceStateTable>
</scpd>
</syntaxhighlight>

Av:Developer:Eriskay:SenderService - Revision history

Simonc: Created page with "= Sender Service = == Overview == The Sender service indicates the presence of a Songcast sender and provides information concerning that sender. A Songcast sender broadcasts mu..."