Av:Developer:SenderService - Revision history

Simonc: /* Enabled */

2017-04-26T10:30:31Z

Enabled

← Older revision		Revision as of 10:30, 26 April 2017
Line 45:		Line 45:
	* Disabled - sender disabled by user configuration		* Disabled - sender disabled by user configuration
	== Enabled ==		== Enabled ==
-	<tt>true</tt>	+	<tt>true</tt> if the device bearing this service is capable of acting as a Songcast sender (i.e. Songcast sending is enabled and the sender is not blocked due to a multicast port clash); <tt>false</tt> otherwise.

	= Actions =		= Actions =

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

2017-04-26T10:28:47Z

Sender Service Description (XML)

← Older revision		Revision as of 10:28, 26 April 2017
Line 63:		Line 63:
	Domain : av.openhome.org		Domain : av.openhome.org
	Name : Sender		Name : Sender
-	Version : 1	+	Version : 2
	</code>		</code>

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

2017-04-26T10:28:37Z

Sender Service Description (XML)

Show changes

Simonc at 07:40, 26 April 2017

2017-04-26T07:40:58Z

← Older revision		Revision as of 07:40, 26 April 2017
Line 31:		Line 31:
	If the sender has no presentation page, <tt>PresentationUrl</tt> is empty.		If the sender has no presentation page, <tt>PresentationUrl</tt> is empty.
	== Status ==		== Status ==
		+	Deprecated. Use <tt>Status2</tt> instead.
		+
		+	* Enabled - sender enabled by user configuration and not blocked
		+	* Blocked - audio from another sender detected on the same channel (mis-configuration)
		+	* Disabled - sender disabled by user configuration
		+	== Status2 ==
	Reports the status of the sender (normally only for debugging purposes):		Reports the status of the sender (normally only for debugging purposes):

	* Sending - currently sending audio over the network		* Sending - currently sending audio over the network
-	* Ready - ~~ready to send~~ audio but no listeners	+	* Ready - capable of sending audio but no listeners. Use <tt>Audio</tt> to determine whether audio would be sent immediately a listener joins.
	* Blocked - audio from another sender detected on the same channel (mis-configuration)		* Blocked - audio from another sender detected on the same channel (mis-configuration)
-	* Inactive - ~~no audio source currently assigned to this~~ sender	+	* Inactive - sender device is playing content which cannot be broadcast
	* Disabled - sender disabled by user configuration		* Disabled - sender disabled by user configuration
		+	== Enabled ==
		+	<tt>true</tt>

	= Actions =		= Actions =

Simonc: /* Technical Details */

2013-11-05T11:06:03Z

Technical Details

← Older revision		Revision as of 11:06, 5 November 2013
Line 51:		Line 51:
	Return the value of the <tt>Status</tt> state variable		Return the value of the <tt>Status</tt> state variable

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

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

Simonc at 08:53, 5 November 2013

2013-11-05T08:53:48Z

← Older revision		Revision as of 08:53, 5 November 2013
Line 1:		Line 1:
-	= ~~Architectural~~ Overview =	+	= Overview =
		+	The Sender service indicates the presence of a Songcast sender and provides information concerning that sender.

-	~~The Sender service indicates the presence of an OpenHome Av~~ sender ~~and provides information concerning~~ that ~~sender~~.	+	A Songcast sender broadcasts music on a network in a way that is playable by a Songcast [[Developer:ReceiverService\|receiver]].

-	~~An OpenHome Av sender broadcasts music on~~ a ~~network in a way~~ that is ~~playable~~ by ~~an OpenHome Av [[Developer:ReceiverService\|receiver]]~~.	+	If a device's Product service reports an attribute source of type 'Sender', then that device is guaranteed to bear the Sender service. Alternatively, Songcast senders can be discovered independently of the Product service by simply searching for devices bearing the Sender service.

-	OpenHome senders should be discovered independently of the standard algorithm for discovering OpenHome products and sources. An independent search should be made for devices bearing the Sender service.	+	= State Variables =
-		+
-	= ~~Actions~~ =	+
	== Attributes ==		== Attributes ==
-	~~Reports a space separated list of attributes that identify additional functionality that can be found on the same device as this Sender~~.	+	Reserved for future use.
-		+	== Audio ==
-	~~Currently defined attributes are:~~	+	<tt>true</tt> if audio is currently available from this Sender; <tt>false</tt> otherwise.
-		+
-	* Info - this device reports on the current media using the Info service	+
-	* Time - this device reports on the current media using the Time service	+
-		+
-	== Audio ==	+
-	~~Reports whether~~ audio is currently ~~present on~~ this ~~sender~~.	+
-		+
	== Metadata ==		== Metadata ==
-	Provides ~~a representation of this audio item~~ in DIDL-Lite format.	+	Provides basic information about the sender in DIDL-Lite format.
		+	<syntaxhighlight lang="xml">
		+	<DIDL-Lite xmlns:dc="http://purl.org/dc/elements/1.1/"
		+	xmlns:upnp="urn:schemas-upnp-org:metadata-1-0/upnp/"
		+	xmlns="urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/">
		+	<item id="0" restricted="True">
		+	<dc:title>[sender_name]</dc:title>"
		+	<res protocolInfo="ohz:::[m\|u]">ohz://239.255.255.250:51972/[device_udn]</res>
		+	<upnp:albumArtURI>[full_uri]</upnp:albumArtURI>
		+	<upnp:class>object.item.audioItem</upnp:class>
		+	</item>
		+	</DIDL-Lite>
		+	</syntaxhighlight>

		+	Note that protocolInfo takes the form <tt>ohz:::m</tt> or <tt>ohz:::u</tt> depending on whether multicast or unicast mode is enabled
	== PresentationUrl ==		== PresentationUrl ==
-	Reports the ~~Url~~ of a presentation page for further information concerning the sender, or for controlling the sender in some application-specific way.	+	Reports the url of a presentation page for further information concerning the sender, or for controlling the sender in some application-specific way.
-		+	If the sender has no presentation page, <tt>PresentationUrl</tt> is empty.
-	If the sender has no presentation page, ~~the~~ PresentationUrl is empty.	+
-		+
	== Status ==		== Status ==
	Reports the status of the sender (normally only for debugging purposes):		Reports the status of the sender (normally only for debugging purposes):
Line 35:		Line 38:
	* Inactive - no audio source currently assigned to this sender		* Inactive - no audio source currently assigned to this sender
	* Disabled - sender disabled by user configuration		* Disabled - sender disabled by user configuration
		+
		+	= Actions =
		+	== Attributes ==
		+	Return the value of the <tt>Attributes</tt> state variable
		+	== Audio ==
		+	Return the value of the <tt>Audio</tt> state variable
		+	== Metadata ==
		+	Return the value of the <tt>Metadata</tt> state variable
		+	== PresentationUrl ==
		+	Return the value of the <tt>PresentationUrl</tt> state variable
		+	== Status ==
		+	Return the value of the <tt>Status</tt> state variable

	= Technical Details =		= Technical Details =

Grahamd: /* PresentationUrl */

2011-06-27T10:27:08Z

PresentationUrl

← Older revision		Revision as of 10:27, 27 June 2011
Line 25:		Line 25:
	Reports the Url of a presentation page for further information concerning the sender, or for controlling the sender in some application-specific way.		Reports the Url of a presentation page for further information concerning the sender, or for controlling the sender in some application-specific way.

-	If the sender has no presentation page, the PresentationUrl ~~should be~~ empty.	+	If the sender has no presentation page, the PresentationUrl is empty.

	== Status ==		== Status ==

Openhome at 15:17, 5 May 2011

2011-05-05T15:17:07Z

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

	== Sender Service Description (XML) ==		== Sender 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 133:		Line 133:
	</serviceStateTable>		</serviceStateTable>
	</scpd>		</scpd>
-	</~~code~~>	+	</syntaxhighlight>

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

2011-05-05T14:13:16Z

Sender Service Description (XML)

← Older revision		Revision as of 14:13, 5 May 2011
Line 45:		Line 45:
	== Sender Service Description (XML) ==		== Sender 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>PresentationUrl</name>
		+	<argumentList>
		+	<argument>
		+	<name>Value</name>
		+	<direction>out</direction>
		+	<relatedStateVariable>PresentationUrl</relatedStateVariable>
		+	</argument>
		+	</argumentList>
		+	</action>
		+	<action>
		+	<name>Metadata</name>
		+	<argumentList>
		+	<argument>
		+	<name>Value</name>
		+	<direction>out</direction>
		+	<relatedStateVariable>Metadata</relatedStateVariable>
		+	</argument>
		+	</argumentList>
		+	</action>
		+	<action>
		+	<name>Audio</name>
		+	<argumentList>
		+	<argument>
		+	<name>Value</name>
		+	<direction>out</direction>
		+	<relatedStateVariable>Audio</relatedStateVariable>
		+	</argument>
		+	</argumentList>
		+	</action>
		+	<action>
		+	<name>Status</name>
		+	<argumentList>
		+	<argument>
		+	<name>Value</name>
		+	<direction>out</direction>
		+	<relatedStateVariable>Status</relatedStateVariable>
		+	</argument>
		+	</argumentList>
		+	</action>
		+	<action>
		+	<name>Attributes</name>
		+	<argumentList>
		+	<argument>
		+	<name>Value</name>
		+	<direction>out</direction>
		+	<relatedStateVariable>Attributes</relatedStateVariable>
		+	</argument>
		+	</argumentList>
		+	</action>
		+	</actionList>
		+
		+	<serviceStateTable>
		+	<stateVariable sendEvents="yes">
		+	<name>PresentationUrl</name>
		+	<dataType>string</dataType>
		+	</stateVariable>
		+	<stateVariable sendEvents="yes">
		+	<name>Metadata</name>
		+	<dataType>string</dataType>
		+	</stateVariable>
		+	<stateVariable sendEvents="yes">
		+	<name>Audio</name>
		+	<dataType>boolean</dataType>
		+	</stateVariable>
		+	<stateVariable sendEvents="yes">
		+	<name>Status</name>
		+	<dataType>string</dataType>
		+	<allowedValueList>
		+	<allowedValue>Enabled</allowedValue>
		+	<allowedValue>Disabled</allowedValue>
		+	<allowedValue>Blocked</allowedValue>
		+	</allowedValueList>
		+	</stateVariable>
		+	<stateVariable sendEvents="yes">
		+	<name>Attributes</name>
		+	<dataType>string</dataType>
		+	</stateVariable>
		+	</serviceStateTable>
		+	</scpd>
	</code>		</code>

Joshh: /* Technical Details */

2011-05-05T14:07:09Z

Technical Details

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