Revision as of 10:27, 27 June 2011

Architectural Overview

The Sender service indicates the presence of an OpenHome Av sender and provides information concerning that sender.

An OpenHome Av sender broadcasts music on a network in a way that is playable by an OpenHome Av receiver.

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.

Actions

Attributes

Reports a space separated list of attributes that identify additional functionality that can be found on the same device as this Sender.

Currently defined attributes are:

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

Provides a representation of this audio item in DIDL-Lite format.

PresentationUrl

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 is empty.

Status

Reports the status of the sender (normally only for debugging purposes):

Sending - currently sending audio over the network
Ready - ready to send audio but no listeners
Blocked - audio from another sender detected on the same channel (mis-configuration)
Inactive - no audio source currently assigned to this sender
Disabled - sender disabled by user configuration

Technical Details


   Domain  : av.openhome.org
   Name    : Sender
   Version : 1

Sender Service Description (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>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>

@@ 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.
-If the sender has no presentation page, the PresentationUrl should be empty.
+If the sender has no presentation page, the PresentationUrl is empty.
 == Status ==

From OpenHome