Difference between revisions of "Developer:Davaar:SenderService"

From LinnDocs
Jump to: navigation, search
(Architectural Overview)
(Actions)
Line 6: Line 6:
  
 
= Actions =
 
= Actions =
==Counters==
+
== Attributes ==
Counters are used to manage the changing of the Track, Details, and Metatext information.
+
Reports a space separated list of attributes that identify additional functionality that can be found on the same device as this Sender.
  
When a track changes, the Track Count is incremented, the Uri and Metadata are set, the Details Count is set to zero, the Details are defaulted to blank and zero values, the Metatext Count is set to zero, and the Metatext is set to blank.
+
Currently defined attributes are:
  
Subsequent updates to the Details and Metatext are accompanied by increments in their respective Counters.
+
Info - this device reports on the current media using the Info service
 +
Time - this device reports on the current media using the Time service
  
The Counters action can be used by clients that are unable to partake in UPnP eventing in order to establish changes in the information provided by the Info Service.
 
  
==Track==
+
== Audio ==  
Reports current track information concerning the current media:
+
Reports whether audio is currently present on this sender.
*Uri
 
*Metadata
 
  
==Details==
+
== Metadata ==
Reports details concerning the current media:
+
Provides a representation of this audio item in DIDL-Lite format.
*Duration
 
*Bit Rate
 
*Bit Depth
 
*Sample Rate
 
*Lossless
 
*Codec Name
 
  
==Metatext==
+
== PresentationUrl ==
Reports dynamic textual information concerning the current media.
+
Reports the Url of a presentation page for further information concerning the sender, or for controlling the sender in some application secific way.
  
This currently amounts to broadcast information from internet radio stations, but the same mechanism could be used for other purposes in the future.
+
If this sender has no presentation page, the PresentationUrl should be empty.
 +
 
 +
== Ststus ==
 +
Reports the status of the sender (normally only for debugging purposes):
 +
 
 +
* Sending - currently sending out audio
 +
* Ready - ready to send audio but no listeners
 +
* Blocked - audio from another sender detected on the same channel
 +
* Inactive - currently no audio to send on this channel
 +
* Disabled - sender disabled by user configuration
  
 
= Technical Details =
 
= Technical Details =

Revision as of 14:31, 24 November 2010

Architectural Overview

The Sender service indicates the presence of and provides information concerning an Openhome Sender.

An Openhome Sender broadcasts music on a network in a way that is playable by an Openhome Receiver.

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 secific way.

If this sender has no presentation page, the PresentationUrl should be empty.

Ststus

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

  • Sending - currently sending out audio
  • Ready - ready to send audio but no listeners
  • Blocked - audio from another sender detected on the same channel
  • Inactive - currently no audio to send on this channel
  • Disabled - sender disabled by user configuration

Technical Details

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

Info Service Description (XML)

Migration Guide From Cara

The domain for the Info service has changed to av.openhome.org

Actions

Counters

The arguments have changed their names as follows:

  • aTrackCount -> TrackCount
  • aDetailsCount -> DetailsCount
  • aMetatextCount -> MetatextCount

Track

The arguments have changed their names as follows:

  • aUri -> Uri
  • aMetadata -> Metadata

Details

The arguments have changed their names as follows:

  • aDuration -> Duration
  • aBitRate -> BitRate
  • aBitDepth -> BitDepth
  • aSampleRate -> SampleRate
  • aLossless -> Lossless
  • aCodecName -> CodecName

Metatext

The argument has changed its name as follows:

  • aMetatext -> Value