From OpenHome

Revision as of 12:15, 15 December 2015 by Simonc (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Contents

Time Service

Overview

The Time service reports the duration of the currently playing track and the number of seconds played so far. It also maintains a count of the total number of tracks played.

If a device's Product service reports an attribute "Time", then that device is guaranteed to bear the Time service.

This service is intentionally separated from the Transport service. When a track is being played, Time delivers an event every second, which can overwhelm some primitive control points. Keeping Time separate from the ["TransportServiceEriskay" Transport] service allows control points to decide whether to subscribe to it independently.

Evented Properties

Track Count

The number of tracks that have been played, including any currently playing one.

TrackCount corresponds with the TrackCount property reported by the ["TransportServiceEriskay" Transport] service, but bears no relation to a track or preset Id properties reported from the ["PlaylistServiceEriskay" Playlist] or ["RadioServiceEriskay" Radio] services.

Duration

The total length of the current track in seconds. Zero for live streams.

Seconds

The total length of time in seconds for which the current track has been playing.

Actions

Time

Return the values of the TrackCount, Duration and Seconds properties.

UPnP Service Description

For devices supporting the UPnP protocol, the service description is

name: "Time"
domain: "openhome.org.eriskay"
version: "1"

<?xml version="1.0" encoding="utf-8"?>
<scpd xmlns="urn:schemas-upnp-org:service-1-0">
  <specVersion>
    <major>1</major>
    <minor>0</minor>
  </specVersion>
  <actionList>
    <action>
      <name>Time</name>
      <argumentList>
        <argument>
          <name>TrackCount</name>
          <direction>out</direction>
          <relatedStateVariable>TrackCount</relatedStateVariable>
        </argument>
        <argument>
          <name>Duration</name>
          <direction>out</direction>
          <relatedStateVariable>Duration</relatedStateVariable>
        </argument>
        <argument>
          <name>Seconds</name>
          <direction>out</direction>
          <relatedStateVariable>Seconds</relatedStateVariable>
        </argument>
      </argumentList>
    </action>
  </actionList>
  <serviceStateTable>
    <stateVariable sendEvents="yes">
      <name>TrackCount</name>
      <dataType>ui4</dataType>
    </stateVariable>
    <stateVariable sendEvents="yes">
      <name>Duration</name>
      <dataType>ui4</dataType>
    </stateVariable>
    <stateVariable sendEvents="yes">
      <name>Seconds</name>
      <dataType>ui4</dataType>
    </stateVariable>
  </serviceStateTable>
</scpd>