From OpenHome

(Difference between revisions)
Jump to: navigation, search
(→State Variables: added description of remaining state variables)
 
(11 intermediate revisions not shown)
Line 1: Line 1:
-
= Architectural Overview =
+
= Overview =
-
The Info service provides information concerning the currently playing media. The information provided is based on the concept of a track, which has a uri and metadata in DIDL-Lite format. Some time after the track changes further information becomes available such as the bit-rate, sample-rate, bit-depth, etc. Optionally a track may contain dynamic textual information (known as metatext) that is updated as the track is played. Metatext is typically used to convey broadcast information from internet radio stations.
+
The Info service provides information concerning the currently playing media. The information provided is based on the concept of a track, which has a URI and metadata in DIDL-Lite format. Some time after the track changes further information becomes available such as the bit-rate, sample-rate, bit-depth, etc. Optionally a track may contain dynamic textual information (known as metatext) that is updated as the track is played. Metatext is typically used to convey broadcast information from Internet radio stations.
= Actions =
= Actions =
==Counters==
==Counters==
-
Counters are used to manage the changing of the Track, Details, and Metatext information.
+
Counters are used to version Track, Details, and Metatext information in the face of dynamic changes.
-
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.
+
The Counters action can be used by clients that are unable to partake in UPnP eventing in order to track changes in the information provided by the Info Service.
-
Subsequent updates to the Details and Metatext are accompanied by increments in their respective Counters.
+
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.
-
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.
+
Subsequent updates to the Details and Metatext are accompanied by increments in their respective Counters.
==Track==
==Track==
Reports current track information concerning the current media:
Reports current track information concerning the current media:
-
*Uri
+
*URI
*Metadata
*Metadata
Line 30: Line 30:
Reports dynamic textual information concerning the current media.
Reports dynamic textual information concerning the current media.
-
This currently amounts to broadcast information from internet radio stations, but the same mechanism could be used for other purposes in the future.
+
This currently amounts to broadcast information from Internet radio stations, but the same mechanism could be used for other purposes in the future.
 +
 
 +
= State Variables =
 +
== TrackCount ==
 +
the strictly monotonically increasing integer number of tracks played (incl. current one)
 +
 
 +
== DetailsCount ==
 +
the strictly monotonically increasing integer number versioning changes in track encoding parameters (duration, bitrate, bitdepth, samplerate, lossy compression, codec);  reset to zero on each track change
 +
 
 +
== MetatextCount ==
 +
the strictly monotonicallyl increasing integer number versioning changes in any text associated with the currently playing track;  reset to zero on each track change
 +
 
 +
== Uri ==
 +
the Universal Resource Indicator, indicating the currently playing track;  initially empty string
 +
 
 +
== Metadata ==
 +
the DIDL-Lite encoded string of information about the currently playing track (e.g. artist, album, year, etc.);  initially empty string
 +
 
 +
== Duration ==
 +
the length of the currently playing track in seconds
 +
 
 +
== BitRate ==
 +
the dataflow rate in bits per second of the currently playing track in its encoded representation(XXX)
 +
XXX MP3: CBR vs. VBR
 +
 
 +
== BitDepth ==
 +
the sample (data) resolution in bits per channel sample of the currently playing track
 +
 
 +
== SampleRate ==
 +
the time resolution of samples per second in kHz of the currently playing track
 +
 
 +
== Lossless ==
 +
the indication of whether the currently playing track can be decoded (decompressed) to a bit-accurate representation of the original audio data (lossless) or merely to a good approximation (lossy encoding)
 +
 
 +
== CodecName ==
 +
the shorthand name for the audio encoding and container format used to represent the currently playing track (e.g. AAC);  initially empty string
 +
 
 +
== Metatext ==
 +
the additional textual information (if any) associated with the currently playing track
= Technical Details =
= Technical Details =
Line 38: Line 76:
     Version : 1
     Version : 1
</code>
</code>
-
[http://oss.linn.co.uk/trac/browser/Main/LibUpnpCil/Services/Openhome/Info1.xml Info Service Description (XML)]
+
 
 +
== Info Service Description (XML) ==
 +
<syntaxhighlight lang="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>Counters</name>
 +
            <argumentList>
 +
                <argument>
 +
                    <name>TrackCount</name>
 +
                    <direction>out</direction>
 +
                    <relatedStateVariable>TrackCount</relatedStateVariable>
 +
                </argument>
 +
                <argument>
 +
                    <name>DetailsCount</name>
 +
                    <direction>out</direction>
 +
                    <relatedStateVariable>DetailsCount</relatedStateVariable>
 +
                </argument>
 +
                <argument>
 +
                    <name>MetatextCount</name>
 +
                    <direction>out</direction>
 +
                    <relatedStateVariable>MetatextCount</relatedStateVariable>
 +
                </argument>
 +
            </argumentList>
 +
        </action>
 +
        <action>
 +
            <name>Track</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>Details</name>
 +
            <argumentList>
 +
                <argument>
 +
                    <name>Duration</name>
 +
                    <direction>out</direction>
 +
                    <relatedStateVariable>Duration</relatedStateVariable>
 +
                </argument>
 +
                <argument>
 +
                    <name>BitRate</name>
 +
                    <direction>out</direction>
 +
                    <relatedStateVariable>BitRate</relatedStateVariable>
 +
                </argument>
 +
                <argument>
 +
                    <name>BitDepth</name>
 +
                    <direction>out</direction>
 +
                    <relatedStateVariable>BitDepth</relatedStateVariable>
 +
                </argument>
 +
                <argument>
 +
                    <name>SampleRate</name>
 +
                    <direction>out</direction>
 +
                    <relatedStateVariable>SampleRate</relatedStateVariable>
 +
                </argument>
 +
                <argument>
 +
                    <name>Lossless</name>
 +
                    <direction>out</direction>
 +
                    <relatedStateVariable>Lossless</relatedStateVariable>
 +
                </argument>
 +
                <argument>
 +
                    <name>CodecName</name>
 +
                    <direction>out</direction>
 +
                    <relatedStateVariable>CodecName</relatedStateVariable>
 +
                </argument>
 +
            </argumentList>
 +
        </action>
 +
        <action>
 +
            <name>Metatext</name>
 +
            <argumentList>
 +
                <argument>
 +
                    <name>Value</name>
 +
                    <direction>out</direction>
 +
                    <relatedStateVariable>Metatext</relatedStateVariable>
 +
                </argument>
 +
            </argumentList>
 +
        </action>
 +
    </actionList>
 +
    <serviceStateTable>
 +
        <stateVariable sendEvents="yes">
 +
            <name>TrackCount</name>
 +
            <dataType>ui4</dataType>
 +
        </stateVariable>
 +
        <stateVariable sendEvents="yes">
 +
            <name>DetailsCount</name>
 +
            <dataType>ui4</dataType>
 +
        </stateVariable>
 +
        <stateVariable sendEvents="yes">
 +
            <name>MetatextCount</name>
 +
            <dataType>ui4</dataType>
 +
        </stateVariable>
 +
        <stateVariable sendEvents="yes">
 +
          <name>Uri</name>
 +
          <dataType>string</dataType>
 +
        </stateVariable>
 +
        <stateVariable sendEvents="yes">
 +
          <name>Metadata</name>
 +
          <dataType>string</dataType>
 +
        </stateVariable>
 +
        <stateVariable sendEvents="yes">
 +
            <name>Duration</name>
 +
            <dataType>ui4</dataType>
 +
        </stateVariable>
 +
        <stateVariable sendEvents="yes">
 +
            <name>BitRate</name>
 +
            <dataType>ui4</dataType>
 +
        </stateVariable>
 +
        <stateVariable sendEvents="yes">
 +
            <name>BitDepth</name>
 +
            <dataType>ui4</dataType>
 +
        </stateVariable>
 +
        <stateVariable sendEvents="yes">
 +
            <name>SampleRate</name>
 +
            <dataType>ui4</dataType>
 +
        </stateVariable>
 +
        <stateVariable sendEvents="yes">
 +
            <name>Lossless</name>
 +
            <dataType>boolean</dataType>
 +
        </stateVariable>
 +
        <stateVariable sendEvents="yes">
 +
            <name>CodecName</name>
 +
            <dataType>string</dataType>
 +
        </stateVariable>
 +
        <stateVariable sendEvents="yes">
 +
          <name>Metatext</name>
 +
          <dataType>string</dataType>
 +
        </stateVariable>
 +
  </serviceStateTable>
 +
</scpd>
 +
</syntaxhighlight>

Latest revision as of 13:34, 7 August 2013

Contents

Overview

The Info service provides information concerning the currently playing media. The information provided is based on the concept of a track, which has a URI and metadata in DIDL-Lite format. Some time after the track changes further information becomes available such as the bit-rate, sample-rate, bit-depth, etc. Optionally a track may contain dynamic textual information (known as metatext) that is updated as the track is played. Metatext is typically used to convey broadcast information from Internet radio stations.

Actions

Counters

Counters are used to version Track, Details, and Metatext information in the face of dynamic changes.

The Counters action can be used by clients that are unable to partake in UPnP eventing in order to track changes in the information provided by the Info Service.

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.

Subsequent updates to the Details and Metatext are accompanied by increments in their respective Counters.

Track

Reports current track information concerning the current media:

  • URI
  • Metadata

Details

Reports details concerning the current media:

  • Duration
  • Bit Rate
  • Bit Depth
  • Sample Rate
  • Lossless
  • Codec Name

Metatext

Reports dynamic textual information concerning the current media.

This currently amounts to broadcast information from Internet radio stations, but the same mechanism could be used for other purposes in the future.

State Variables

TrackCount

the strictly monotonically increasing integer number of tracks played (incl. current one)

DetailsCount

the strictly monotonically increasing integer number versioning changes in track encoding parameters (duration, bitrate, bitdepth, samplerate, lossy compression, codec); reset to zero on each track change

MetatextCount

the strictly monotonicallyl increasing integer number versioning changes in any text associated with the currently playing track; reset to zero on each track change

Uri

the Universal Resource Indicator, indicating the currently playing track; initially empty string

Metadata

the DIDL-Lite encoded string of information about the currently playing track (e.g. artist, album, year, etc.); initially empty string

Duration

the length of the currently playing track in seconds

BitRate

the dataflow rate in bits per second of the currently playing track in its encoded representation(XXX) XXX MP3: CBR vs. VBR

BitDepth

the sample (data) resolution in bits per channel sample of the currently playing track

SampleRate

the time resolution of samples per second in kHz of the currently playing track

Lossless

the indication of whether the currently playing track can be decoded (decompressed) to a bit-accurate representation of the original audio data (lossless) or merely to a good approximation (lossy encoding)

CodecName

the shorthand name for the audio encoding and container format used to represent the currently playing track (e.g. AAC); initially empty string

Metatext

the additional textual information (if any) associated with the currently playing track

Technical Details 

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

Info 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>Counters</name>
            <argumentList>
                <argument>
                    <name>TrackCount</name>
                    <direction>out</direction>
                    <relatedStateVariable>TrackCount</relatedStateVariable>
                </argument>
                <argument>
                    <name>DetailsCount</name>
                    <direction>out</direction>
                    <relatedStateVariable>DetailsCount</relatedStateVariable>
                </argument>
                <argument>
                    <name>MetatextCount</name>
                    <direction>out</direction>
                    <relatedStateVariable>MetatextCount</relatedStateVariable>
                </argument>
            </argumentList>
        </action>
        <action>
            <name>Track</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>Details</name>
            <argumentList>
                <argument>
                    <name>Duration</name>
                    <direction>out</direction>
                    <relatedStateVariable>Duration</relatedStateVariable>
                </argument>
                <argument>
                    <name>BitRate</name>
                    <direction>out</direction>
                    <relatedStateVariable>BitRate</relatedStateVariable>
                </argument>
                <argument>
                    <name>BitDepth</name>
                    <direction>out</direction>
                    <relatedStateVariable>BitDepth</relatedStateVariable>
                </argument>
                <argument>
                    <name>SampleRate</name>
                    <direction>out</direction>
                    <relatedStateVariable>SampleRate</relatedStateVariable>
                </argument>
                <argument>
                    <name>Lossless</name>
                    <direction>out</direction>
                    <relatedStateVariable>Lossless</relatedStateVariable>
                </argument>
                <argument>
                    <name>CodecName</name>
                    <direction>out</direction>
                    <relatedStateVariable>CodecName</relatedStateVariable>
                </argument>
            </argumentList>
        </action>
        <action>
            <name>Metatext</name>
            <argumentList>
                <argument>
                    <name>Value</name>
                    <direction>out</direction>
                    <relatedStateVariable>Metatext</relatedStateVariable>
                </argument>
            </argumentList>
        </action>
    </actionList>
    <serviceStateTable>
        <stateVariable sendEvents="yes">
            <name>TrackCount</name>
            <dataType>ui4</dataType>
        </stateVariable>
        <stateVariable sendEvents="yes">
            <name>DetailsCount</name>
            <dataType>ui4</dataType>
        </stateVariable>
        <stateVariable sendEvents="yes">
            <name>MetatextCount</name>
            <dataType>ui4</dataType>
        </stateVariable>
        <stateVariable sendEvents="yes">
          <name>Uri</name>
          <dataType>string</dataType>
        </stateVariable>
        <stateVariable sendEvents="yes">
          <name>Metadata</name>
          <dataType>string</dataType>
        </stateVariable>
        <stateVariable sendEvents="yes">
            <name>Duration</name>
            <dataType>ui4</dataType>
        </stateVariable>
        <stateVariable sendEvents="yes">
            <name>BitRate</name>
            <dataType>ui4</dataType>
        </stateVariable>
        <stateVariable sendEvents="yes">
            <name>BitDepth</name>
            <dataType>ui4</dataType>
        </stateVariable>
        <stateVariable sendEvents="yes">
            <name>SampleRate</name>
            <dataType>ui4</dataType>
        </stateVariable>
        <stateVariable sendEvents="yes">
            <name>Lossless</name>
            <dataType>boolean</dataType>
        </stateVariable>
        <stateVariable sendEvents="yes">
            <name>CodecName</name>
            <dataType>string</dataType>
        </stateVariable>
        <stateVariable sendEvents="yes">
          <name>Metatext</name>
          <dataType>string</dataType>
        </stateVariable>
   </serviceStateTable>
</scpd>
Retrieved from "http://wiki.openhome.org/wiki/Av:Developer:InfoService"