From OpenHome
(→Architectural Overview: added mention of TrackCount) |
(added section on State Variables) |
||
Line 3: | Line 3: | ||
This service is intentionally separated from the Info service. When a track is being played, this service delivers an event every second, which can overwhelm some primitive control points. The Time service is kept separate from the Info service so that control points can decide to subscribe to it independently. | This service is intentionally separated from the Info service. When a track is being played, this service delivers an event every second, which can overwhelm some primitive control points. The Time service is kept separate from the Info service so that control points can decide to subscribe to it independently. | ||
+ | |||
+ | = State Variables = | ||
+ | == Track Count == | ||
+ | The number of tracks that have been played, including any currently playing one. (read-only) | ||
+ | |||
+ | == Duration == | ||
+ | The total length of the current track in seconds. Zero for live streams. (read-only) | ||
+ | |||
+ | == Seconds == | ||
+ | The total length of time in seconds for which the current track has been playing. (read-only) | ||
= Actions = | = Actions = |
Revision as of 12:41, 19 July 2013
Contents |
Architectural 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.
This service is intentionally separated from the Info service. When a track is being played, this service delivers an event every second, which can overwhelm some primitive control points. The Time service is kept separate from the Info service so that control points can decide to subscribe to it independently.
State Variables
Track Count
The number of tracks that have been played, including any currently playing one. (read-only)
Duration
The total length of the current track in seconds. Zero for live streams. (read-only)
Seconds
The total length of time in seconds for which the current track has been playing. (read-only)
Actions
Time
This reports TrackCount, which increments each time a new track is played; Duration, which is the duration of the current track in seconds; and Seconds, which is the number of seconds so far played.
TrackCount corresponds with TrackCount reported in the Info Service, but bears no relation to a Track Id or Preset Id reported from the Playlist Service or Radio Service.
Technical Details
Domain : av.openhome.org Name : Time Version : 1
Time Service Description (XML)
<?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>