From OpenHome

(Difference between revisions)
Jump to: navigation, search
(→Technical Details)
(→Receiver Service Description (XML))
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>

Revision as of 14:12, 5 May 2011

Contents

Architectural Overview

The Receiver service provides the means for controlling a Receiver source. If a device's 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 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 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 

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

Receiver 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>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>

Retrieved from "http://wiki.openhome.org/wiki/Av:Developer:ReceiverService"