OpenHome - User contributions [en]

Av:Developer:VolumeService

2013-08-09T15:24:32Z

Johnh: added documentation for state variables

= Architecture Overview =
The Volume Service provides a means of controlling various settings which affect the product's volume (signal amplitude) measured at the output channels. A product may have one or more output channels. Balance or Fade settings may result in different volumes at each output. In the Mute state, all output channels are reduced to zero volume.

==Volume==
Volume is an adjustable setting that controls the loudness of the audio at the output channels of the product. Volume can be set to an absolute value or incremented/decremented in single steps. The maximum Volume setting is defined by the current value of '''VolumeLimit'''. The minimum Volume setting is zero. If an attempt is made to set the Volume above VolumeLimit, the Volume will be set to the '''VolumLimit'''. If an attempt is made to set the Volume above '''VolumeMax''', an error will be reported.

== Volume Limit ==
VolumeLimit specifies the upper limit of the Volume. Any attempt to set Volume above the VolumeLimit will reset Volume to the value of VolumeLimit. If VolumeLimit is changed, Volume is checked and automatically reduced if necessary. The maximum VolumeLimit setting is defined by the '''VolumeMax''' Characteristic.

==Balance==
Balance is an adjustable setting that specifies the '''bias''' in volume between the '''left and right''' output channels of the product. Balance can be set to an absolute value or incremented/decremented in single steps. The maximum Balance setting is defined by the '''BalanceMax''' Characteristic. The minimum Balance setting is defined by ('''-BalanceMax''').

A setting of zero results in neutral balance (i.e. no bias applied) between left and right output channels. Negative values amplify left and attenuate right output channels. Conversely, positive values attenuate left and amplify right output channels. Increasing absolute values result in progressively larger amplification/attenuation being applied to output channels in this asymmetric manner. At or near the maximum settings, the attenuated channels may ended up being effectively reduced to volume zero.

==Fade==
Fade is an adjustable setting that specifies the '''bias''' in volume between the '''front and rear''' output channels of the products. Fade can be set to an absolute value or incremented/decremented in single steps. The maximum Fade setting is defined by the '''FadeMax''' Characteristic. The minimum Fade setting is defined by ('''-FadeMax''') .

==Mute==
Mute is an adjustable state that determines if the output channels of the product are muted or not. When muted, all output channels of the product are silent.

==Characteristics==
Each product has six read-only values that define value ranges and their granularity -- as well as notable values within these ranges -- for volume, balance, and fade.

====VolumeMax====
VolumeMax defines the absolute maximum Volume setting.

====VolumeUnity====
VolumeUnity defines the value of Volume that will result in unity system gain (i.e. ''output amplitude'' = ''input amplitude'').

====VolumeSteps====
VolumeSteps defines the number of step increments required to increase the Volume from zero to VolumeMax.

====VolumeMilliDbPerStep====
VolumeMilliDbPerStep defines the size of each volume step in '''binary milli decibels''' (mibi dB). [''1024mibi dB = 1dB'']

====BalanceMax====
BalanceMax defines the maximum Balance setting. The minimum Balance setting is (-BalanceMax).

====FadeMax====
FadeMax defines the maximum Fade setting. The minimum Fade setting is (-FadeMax).

=Actions=

=== Volume ===
The Volume action reports the current Volume setting.

=== SetVolume===
The SetVolume action provides a means of setting the Volume to an absolute value.

=== Volume Inc===
The VolumeInc action provides a means of increasing the Volume by 1.
=== Volume Dec ===
The VolumeDec action provides a means of decreasing the Volume by 1.
=== VolumeLimit ===
The VolumeLimit action reports the current VolumeLimit setting.
=== Balance ===
The Balance action reports the current Balance setting.
=== SetBalance ===
The SetBalance action provides a means of setting the Balance to a specific value.

=== BalanceInc===
The BalanceInc action provides a means of increasing the Balance by 1.
=== BalanceDec ===
The BalanceDec action provides a means of decreasing the Balance by 1.
=== Fade ===
The Fade action reports the current Fade setting of the product.
=== SetFade ===
The SetFade action provides a means of setting the Fade to a specific value.
=== FadeInc===
The FadeInc action provides a means of increasing the Fade by 1.

=== FadeDec ===
The FadeDec action provides a means of decreasing the Fade by 1.
=== Mute ===
The Mute action reports the current Mute state of the product.
=== SetMute ===
The SetMute action provides a means of setting the Mute state.

=== Characteristics ===
The Characteristics action returns all six characteristic values of the product.

= State Variables =

== Volume ==
the current user volume setting, i.e. an integer value in the range [0..VolumeLimit]

== Mute ==
the boolean setting indicating whether all output channels are currently forced to zero volume

== Balance ==
the current setting of bias between left and right output channels, i.e. an integer value in the range [-BalanceMax..+BalanceMax]

== Fade ==
the current setting of bias between front and back output channels, i.e. an integer value in the range [-FadeMax..+FadeMax]

== VolumeLimit ==
the user-imposed (soft) maximum volume setting, i.e. an integer in the range [0..VolumeMax]; read-only

== VolumeMax ==
the system-imposed (hard) maximum volume setting; read-only

== VolumeUnity ==
the system-specific volume setting that results in the input signal amplitude equalling the output signal amplitude (0dB gain), i.e. an integer in the range [0..VolumeMax]; read-only

== VolumeSteps ==
the system-specific number of user-visible volume steps that would increase the volume from zero to VolumeMax; read-only

== VolumeMilliDbPerStep ==
the system-specific gain increase with each volume step in binary milli decibel (mibi dB); read-only

== BalanceMax ==
the system-specific balance value that leads to maximum bias towards the right between output channels; read-only

== FadeMax ==
the system-specific fade value that leads to maximum bias towards the rear between output channels; read-only

= Technical Details =
<code>
Domain : av.openhome.org
Name : Volume
Version : 1
</code>

== Volume 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>Characteristics</name>
<argumentList>
<argument>
<name>VolumeMax</name>
<direction>out</direction>
<relatedStateVariable>VolumeMax</relatedStateVariable>
</argument>
<argument>
<name>VolumeUnity</name>
<direction>out</direction>
<relatedStateVariable>VolumeUnity</relatedStateVariable>
</argument>
<argument>
<name>VolumeSteps</name>
<direction>out</direction>
<relatedStateVariable>VolumeSteps</relatedStateVariable>
</argument>
<argument>
<name>VolumeMilliDbPerStep</name>
<direction>out</direction>
<relatedStateVariable>VolumeMilliDbPerStep</relatedStateVariable>
</argument>
<argument>
<name>BalanceMax</name>
<direction>out</direction>
<relatedStateVariable>BalanceMax</relatedStateVariable>
</argument>
<argument>
<name>FadeMax</name>
<direction>out</direction>
<relatedStateVariable>FadeMax</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>SetVolume</name>
<argumentList>
<argument>
<name>Value</name>
<direction>in</direction>
<relatedStateVariable>Volume</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>VolumeInc</name>
</action>
<action>
<name>VolumeDec</name>
</action>
<action>
<name>Volume</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Volume</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>SetBalance</name>
<argumentList>
<argument>
<name>Value</name>
<direction>in</direction>
<relatedStateVariable>Balance</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>BalanceInc</name>
</action>
<action>
<name>BalanceDec</name>
</action>
<action>
<name>Balance</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Balance</relatedStateVariable>
</argument>
</argumentList>
</action>

<action>
<name>SetFade</name>
<argumentList>
<argument>
<name>Value</name>
<direction>in</direction>
<relatedStateVariable>Fade</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>FadeInc</name>
</action>
<action>
<name>FadeDec</name>
</action>
<action>
<name>Fade</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Fade</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>SetMute</name>
<argumentList>
<argument>
<name>Value</name>
<direction>in</direction>
<relatedStateVariable>Mute</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>Mute</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Mute</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>VolumeLimit</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>VolumeLimit</relatedStateVariable>
</argument>
</argumentList>
</action>
</actionList>
<serviceStateTable>
<stateVariable sendEvents="yes">
<name>Volume</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>Mute</name>
<dataType>boolean</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>Balance</name>
<dataType>i4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>Fade</name>
<dataType>i4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeLimit</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeMax</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeUnity</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeSteps</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeMilliDbPerStep</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>BalanceMax</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>FadeMax</name>
<dataType>ui4</dataType>
</stateVariable>
</serviceStateTable>
</scpd>
</syntaxhighlight>

Av:Developer:VolumeService

2013-08-09T14:51:05Z

Johnh: moved expanded discussion of balance setting to Architecture section

= Architecture Overview =
The Volume Service provides a means of controlling various settings which affect the product's volume (signal amplitude) measured at the output channels. A product may have one or more output channels. Balance or Fade settings may result in different volumes at each output. In the Mute state, all output channels are reduced to zero volume.

==Volume==
Volume is an adjustable setting that controls the loudness of the audio at the output channels of the product. Volume can be set to an absolute value or incremented/decremented in single steps. The maximum Volume setting is defined by the current value of '''VolumeLimit'''. The minimum Volume setting is zero. If an attempt is made to set the Volume above VolumeLimit, the Volume will be set to the '''VolumLimit'''. If an attempt is made to set the Volume above '''VolumeMax''', an error will be reported.

== Volume Limit ==
VolumeLimit specifies the upper limit of the Volume. Any attempt to set Volume above the VolumeLimit will reset Volume to the value of VolumeLimit. If VolumeLimit is changed, Volume is checked and automatically reduced if necessary. The maximum VolumeLimit setting is defined by the '''VolumeMax''' Characteristic.

==Balance==
Balance is an adjustable setting that specifies the '''bias''' in volume between the '''left and right''' output channels of the product. Balance can be set to an absolute value or incremented/decremented in single steps. The maximum Balance setting is defined by the '''BalanceMax''' Characteristic. The minimum Balance setting is defined by ('''-BalanceMax''').

A setting of zero results in neutral balance (i.e. no bias applied) between left and right output channels. Negative values amplify left and attenuate right output channels. Conversely, positive values attenuate left and amplify right output channels. Increasing absolute values result in progressively larger amplification/attenuation being applied to output channels in this asymmetric manner. At or near the maximum settings, the attenuated channels may ended up being effectively reduced to volume zero.

==Fade==
Fade is an adjustable setting that specifies the '''bias''' in volume between the '''front and rear''' output channels of the products. Fade can be set to an absolute value or incremented/decremented in single steps. The maximum Fade setting is defined by the '''FadeMax''' Characteristic. The minimum Fade setting is defined by ('''-FadeMax''') .

==Mute==
Mute is an adjustable state that determines if the output channels of the product are muted or not. When muted, all output channels of the product are silent.

==Characteristics==
Each product has six read-only values that define value ranges and their granularity -- as well as notable values within these ranges -- for volume, balance, and fade.

====VolumeMax====
VolumeMax defines the absolute maximum Volume setting.

====VolumeUnity====
VolumeUnity defines the value of Volume that will result in unity system gain (i.e. ''output amplitude'' = ''input amplitude'').

====VolumeSteps====
VolumeSteps defines the number of step increments required to increase the Volume from zero to VolumeMax.

====VolumeMilliDbPerStep====
VolumeMilliDbPerStep defines the size of each volume step in '''binary milli decibels''' (mibi dB). [''1024mibi dB = 1dB'']

====BalanceMax====
BalanceMax defines the maximum Balance setting. The minimum Balance setting is (-BalanceMax).

====FadeMax====
FadeMax defines the maximum Fade setting. The minimum Fade setting is (-FadeMax).

=Actions=

=== Volume ===
The Volume action reports the current Volume setting.

=== SetVolume===
The SetVolume action provides a means of setting the Volume to an absolute value.

=== Volume Inc===
The VolumeInc action provides a means of increasing the Volume by 1.
=== Volume Dec ===
The VolumeDec action provides a means of decreasing the Volume by 1.
=== VolumeLimit ===
The VolumeLimit action reports the current VolumeLimit setting.
=== Balance ===
The Balance action reports the current Balance setting.
=== SetBalance ===
The SetBalance action provides a means of setting the Balance to a specific value.

=== BalanceInc===
The BalanceInc action provides a means of increasing the Balance by 1.
=== BalanceDec ===
The BalanceDec action provides a means of decreasing the Balance by 1.
=== Fade ===
The Fade action reports the current Fade setting of the product.
=== SetFade ===
The SetFade action provides a means of setting the Fade to a specific value.
=== FadeInc===
The FadeInc action provides a means of increasing the Fade by 1.

=== FadeDec ===
The FadeDec action provides a means of decreasing the Fade by 1.
=== Mute ===
The Mute action reports the current Mute state of the product.
=== SetMute ===
The SetMute action provides a means of setting the Mute state.

=== Characteristics ===
The Characteristics action returns all six characteristic values of the product.

= Technical Details =
<code>
Domain : av.openhome.org
Name : Volume
Version : 1
</code>

== Volume 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>Characteristics</name>
<argumentList>
<argument>
<name>VolumeMax</name>
<direction>out</direction>
<relatedStateVariable>VolumeMax</relatedStateVariable>
</argument>
<argument>
<name>VolumeUnity</name>
<direction>out</direction>
<relatedStateVariable>VolumeUnity</relatedStateVariable>
</argument>
<argument>
<name>VolumeSteps</name>
<direction>out</direction>
<relatedStateVariable>VolumeSteps</relatedStateVariable>
</argument>
<argument>
<name>VolumeMilliDbPerStep</name>
<direction>out</direction>
<relatedStateVariable>VolumeMilliDbPerStep</relatedStateVariable>
</argument>
<argument>
<name>BalanceMax</name>
<direction>out</direction>
<relatedStateVariable>BalanceMax</relatedStateVariable>
</argument>
<argument>
<name>FadeMax</name>
<direction>out</direction>
<relatedStateVariable>FadeMax</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>SetVolume</name>
<argumentList>
<argument>
<name>Value</name>
<direction>in</direction>
<relatedStateVariable>Volume</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>VolumeInc</name>
</action>
<action>
<name>VolumeDec</name>
</action>
<action>
<name>Volume</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Volume</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>SetBalance</name>
<argumentList>
<argument>
<name>Value</name>
<direction>in</direction>
<relatedStateVariable>Balance</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>BalanceInc</name>
</action>
<action>
<name>BalanceDec</name>
</action>
<action>
<name>Balance</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Balance</relatedStateVariable>
</argument>
</argumentList>
</action>

<action>
<name>SetFade</name>
<argumentList>
<argument>
<name>Value</name>
<direction>in</direction>
<relatedStateVariable>Fade</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>FadeInc</name>
</action>
<action>
<name>FadeDec</name>
</action>
<action>
<name>Fade</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Fade</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>SetMute</name>
<argumentList>
<argument>
<name>Value</name>
<direction>in</direction>
<relatedStateVariable>Mute</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>Mute</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Mute</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>VolumeLimit</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>VolumeLimit</relatedStateVariable>
</argument>
</argumentList>
</action>
</actionList>
<serviceStateTable>
<stateVariable sendEvents="yes">
<name>Volume</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>Mute</name>
<dataType>boolean</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>Balance</name>
<dataType>i4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>Fade</name>
<dataType>i4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeLimit</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeMax</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeUnity</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeSteps</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeMilliDbPerStep</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>BalanceMax</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>FadeMax</name>
<dataType>ui4</dataType>
</stateVariable>
</serviceStateTable>
</scpd>
</syntaxhighlight>

Av:Developer:VolumeService

2013-08-09T14:24:04Z

Johnh: /* Actions */ elevated SetFade action to same level as all others

= Architecture Overview =
The Volume Service provides a means of controlling various settings which affect the product's volume (signal amplitude) measured at the output channels. A product may have one or more output channels. Balance or Fade settings may result in different volumes at each output. In the Mute state, all output channels are reduced to zero volume.

==Volume==
Volume is an adjustable setting that controls the loudness of the audio at the output channels of the product. Volume can be set to an absolute value or incremented/decremented in single steps. The maximum Volume setting is defined by the current value of '''VolumeLimit'''. The minimum Volume setting is zero. If an attempt is made to set the Volume above VolumeLimit, the Volume will be set to the '''VolumLimit'''. If an attempt is made to set the Volume above '''VolumeMax''', an error will be reported.

== Volume Limit ==
VolumeLimit specifies the upper limit of the Volume. Any attempt to set Volume above the VolumeLimit will reset Volume to the value of VolumeLimit. If VolumeLimit is changed, Volume is checked and automatically reduced if necessary. The maximum VolumeLimit setting is defined by the '''VolumeMax''' Characteristic.

==Balance==
Balance is an adjustable setting that specifies the '''bias''' in volume between the '''left and right''' output channels of the product. Balance can be set to an absolute value or incremented/decremented in single steps. The maximum Balance setting is defined by the '''BalanceMax''' Characteristic. The minimum Balance setting is defined by ('''-BalanceMax''') .

==Fade==
Fade is an adjustable setting that specifies the '''bias''' in volume between the '''front and rear''' output channels of the products. Fade can be set to an absolute value or incremented/decremented in single steps. The maximum Fade setting is defined by the '''FadeMax''' Characteristic. The minimum Fade setting is defined by ('''-FadeMax''') .

==Mute==
Mute is an adjustable state that determines if the output channels of the product are muted or not. When muted, all output channels of the product are silent.

==Characteristics==
Each product has six read-only values that define value ranges and their granularity -- as well as notable values within these ranges -- for volume, balance, and fade.

====VolumeMax====
VolumeMax defines the absolute maximum Volume setting.

====VolumeUnity====
VolumeUnity defines the value of Volume that will result in unity system gain (i.e. ''output amplitude'' = ''input amplitude'').

====VolumeSteps====
VolumeSteps defines the number of step increments required to increase the Volume from zero to VolumeMax.

====VolumeMilliDbPerStep====
VolumeMilliDbPerStep defines the size of each volume step in '''binary milli decibels''' (mibi dB). [''1024mibi dB = 1dB'']

====BalanceMax====
BalanceMax defines the maximum Balance setting. The minimum Balance setting is (-BalanceMax). A setting of zero results in neutral balance (i.e. no artificial bias) between left and right output channels.

====FadeMax====
FadeMax defines the maximum Fade setting. The minimum Fade setting is (-FadeMax). A setting of zero results in neutral fade (i.e. no artificial bias) between front and back output channels.

=Actions=

=== Volume ===
The Volume action reports the current Volume setting.

=== SetVolume===
The SetVolume action provides a means of setting the Volume to an absolute value.

=== Volume Inc===
The VolumeInc action provides a means of increasing the Volume by 1.
=== Volume Dec ===
The VolumeDec action provides a means of decreasing the Volume by 1.
=== VolumeLimit ===
The VolumeLimit action reports the current VolumeLimit setting.
=== Balance ===
The Balance action reports the current Balance setting.
=== SetBalance ===
The SetBalance action provides a means of setting the Balance to a specific value.

=== BalanceInc===
The BalanceInc action provides a means of increasing the Balance by 1.
=== BalanceDec ===
The BalanceDec action provides a means of decreasing the Balance by 1.
=== Fade ===
The Fade action reports the current Fade setting of the product.
=== SetFade ===
The SetFade action provides a means of setting the Fade to a specific value.
=== FadeInc===
The FadeInc action provides a means of increasing the Fade by 1.

=== FadeDec ===
The FadeDec action provides a means of decreasing the Fade by 1.
=== Mute ===
The Mute action reports the current Mute state of the product.
=== SetMute ===
The SetMute action provides a means of setting the Mute state.

=== Characteristics ===
The Characteristics action returns all six characteristic values of the product.

= Technical Details =
<code>
Domain : av.openhome.org
Name : Volume
Version : 1
</code>

== Volume 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>Characteristics</name>
<argumentList>
<argument>
<name>VolumeMax</name>
<direction>out</direction>
<relatedStateVariable>VolumeMax</relatedStateVariable>
</argument>
<argument>
<name>VolumeUnity</name>
<direction>out</direction>
<relatedStateVariable>VolumeUnity</relatedStateVariable>
</argument>
<argument>
<name>VolumeSteps</name>
<direction>out</direction>
<relatedStateVariable>VolumeSteps</relatedStateVariable>
</argument>
<argument>
<name>VolumeMilliDbPerStep</name>
<direction>out</direction>
<relatedStateVariable>VolumeMilliDbPerStep</relatedStateVariable>
</argument>
<argument>
<name>BalanceMax</name>
<direction>out</direction>
<relatedStateVariable>BalanceMax</relatedStateVariable>
</argument>
<argument>
<name>FadeMax</name>
<direction>out</direction>
<relatedStateVariable>FadeMax</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>SetVolume</name>
<argumentList>
<argument>
<name>Value</name>
<direction>in</direction>
<relatedStateVariable>Volume</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>VolumeInc</name>
</action>
<action>
<name>VolumeDec</name>
</action>
<action>
<name>Volume</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Volume</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>SetBalance</name>
<argumentList>
<argument>
<name>Value</name>
<direction>in</direction>
<relatedStateVariable>Balance</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>BalanceInc</name>
</action>
<action>
<name>BalanceDec</name>
</action>
<action>
<name>Balance</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Balance</relatedStateVariable>
</argument>
</argumentList>
</action>

<action>
<name>SetFade</name>
<argumentList>
<argument>
<name>Value</name>
<direction>in</direction>
<relatedStateVariable>Fade</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>FadeInc</name>
</action>
<action>
<name>FadeDec</name>
</action>
<action>
<name>Fade</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Fade</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>SetMute</name>
<argumentList>
<argument>
<name>Value</name>
<direction>in</direction>
<relatedStateVariable>Mute</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>Mute</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Mute</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>VolumeLimit</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>VolumeLimit</relatedStateVariable>
</argument>
</argumentList>
</action>
</actionList>
<serviceStateTable>
<stateVariable sendEvents="yes">
<name>Volume</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>Mute</name>
<dataType>boolean</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>Balance</name>
<dataType>i4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>Fade</name>
<dataType>i4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeLimit</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeMax</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeUnity</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeSteps</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeMilliDbPerStep</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>BalanceMax</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>FadeMax</name>
<dataType>ui4</dataType>
</stateVariable>
</serviceStateTable>
</scpd>
</syntaxhighlight>

Av:Developer:VolumeService

2013-08-09T14:23:17Z

Johnh: /* Characteristics */ de-emphasised number of values returned by Characteristics action

= Architecture Overview =
The Volume Service provides a means of controlling various settings which affect the product's volume (signal amplitude) measured at the output channels. A product may have one or more output channels. Balance or Fade settings may result in different volumes at each output. In the Mute state, all output channels are reduced to zero volume.

==Volume==
Volume is an adjustable setting that controls the loudness of the audio at the output channels of the product. Volume can be set to an absolute value or incremented/decremented in single steps. The maximum Volume setting is defined by the current value of '''VolumeLimit'''. The minimum Volume setting is zero. If an attempt is made to set the Volume above VolumeLimit, the Volume will be set to the '''VolumLimit'''. If an attempt is made to set the Volume above '''VolumeMax''', an error will be reported.

== Volume Limit ==
VolumeLimit specifies the upper limit of the Volume. Any attempt to set Volume above the VolumeLimit will reset Volume to the value of VolumeLimit. If VolumeLimit is changed, Volume is checked and automatically reduced if necessary. The maximum VolumeLimit setting is defined by the '''VolumeMax''' Characteristic.

==Balance==
Balance is an adjustable setting that specifies the '''bias''' in volume between the '''left and right''' output channels of the product. Balance can be set to an absolute value or incremented/decremented in single steps. The maximum Balance setting is defined by the '''BalanceMax''' Characteristic. The minimum Balance setting is defined by ('''-BalanceMax''') .

==Fade==
Fade is an adjustable setting that specifies the '''bias''' in volume between the '''front and rear''' output channels of the products. Fade can be set to an absolute value or incremented/decremented in single steps. The maximum Fade setting is defined by the '''FadeMax''' Characteristic. The minimum Fade setting is defined by ('''-FadeMax''') .

==Mute==
Mute is an adjustable state that determines if the output channels of the product are muted or not. When muted, all output channels of the product are silent.

==Characteristics==
Each product has six read-only values that define value ranges and their granularity -- as well as notable values within these ranges -- for volume, balance, and fade.

====VolumeMax====
VolumeMax defines the absolute maximum Volume setting.

====VolumeUnity====
VolumeUnity defines the value of Volume that will result in unity system gain (i.e. ''output amplitude'' = ''input amplitude'').

====VolumeSteps====
VolumeSteps defines the number of step increments required to increase the Volume from zero to VolumeMax.

====VolumeMilliDbPerStep====
VolumeMilliDbPerStep defines the size of each volume step in '''binary milli decibels''' (mibi dB). [''1024mibi dB = 1dB'']

====BalanceMax====
BalanceMax defines the maximum Balance setting. The minimum Balance setting is (-BalanceMax). A setting of zero results in neutral balance (i.e. no artificial bias) between left and right output channels.

====FadeMax====
FadeMax defines the maximum Fade setting. The minimum Fade setting is (-FadeMax). A setting of zero results in neutral fade (i.e. no artificial bias) between front and back output channels.

=Actions=

=== Volume ===
The Volume action reports the current Volume setting.

=== SetVolume===
The SetVolume action provides a means of setting the Volume to an absolute value.

=== Volume Inc===
The VolumeInc action provides a means of increasing the Volume by 1.
=== Volume Dec ===
The VolumeDec action provides a means of decreasing the Volume by 1.
=== VolumeLimit ===
The VolumeLimit action reports the current VolumeLimit setting.
=== Balance ===
The Balance action reports the current Balance setting.
=== SetBalance ===
The SetBalance action provides a means of setting the Balance to a specific value.

=== BalanceInc===
The BalanceInc action provides a means of increasing the Balance by 1.
=== BalanceDec ===
The BalanceDec action provides a means of decreasing the Balance by 1.
=== Fade ===
The Fade action reports the current Fade setting of the product.
==== SetFade ====
The SetFade action provides a means of setting the Fade to a specific value.
=== FadeInc===
The FadeInc action provides a means of increasing the Fade by 1.

=== FadeDec ===
The FadeDec action provides a means of decreasing the Fade by 1.
=== Mute ===
The Mute action reports the current Mute state of the product.
=== SetMute ===
The SetMute action provides a means of setting the Mute state.

=== Characteristics ===
The Characteristics action returns all six characteristic values of the product.

= Technical Details =
<code>
Domain : av.openhome.org
Name : Volume
Version : 1
</code>

== Volume 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>Characteristics</name>
<argumentList>
<argument>
<name>VolumeMax</name>
<direction>out</direction>
<relatedStateVariable>VolumeMax</relatedStateVariable>
</argument>
<argument>
<name>VolumeUnity</name>
<direction>out</direction>
<relatedStateVariable>VolumeUnity</relatedStateVariable>
</argument>
<argument>
<name>VolumeSteps</name>
<direction>out</direction>
<relatedStateVariable>VolumeSteps</relatedStateVariable>
</argument>
<argument>
<name>VolumeMilliDbPerStep</name>
<direction>out</direction>
<relatedStateVariable>VolumeMilliDbPerStep</relatedStateVariable>
</argument>
<argument>
<name>BalanceMax</name>
<direction>out</direction>
<relatedStateVariable>BalanceMax</relatedStateVariable>
</argument>
<argument>
<name>FadeMax</name>
<direction>out</direction>
<relatedStateVariable>FadeMax</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>SetVolume</name>
<argumentList>
<argument>
<name>Value</name>
<direction>in</direction>
<relatedStateVariable>Volume</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>VolumeInc</name>
</action>
<action>
<name>VolumeDec</name>
</action>
<action>
<name>Volume</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Volume</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>SetBalance</name>
<argumentList>
<argument>
<name>Value</name>
<direction>in</direction>
<relatedStateVariable>Balance</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>BalanceInc</name>
</action>
<action>
<name>BalanceDec</name>
</action>
<action>
<name>Balance</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Balance</relatedStateVariable>
</argument>
</argumentList>
</action>

<action>
<name>SetFade</name>
<argumentList>
<argument>
<name>Value</name>
<direction>in</direction>
<relatedStateVariable>Fade</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>FadeInc</name>
</action>
<action>
<name>FadeDec</name>
</action>
<action>
<name>Fade</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Fade</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>SetMute</name>
<argumentList>
<argument>
<name>Value</name>
<direction>in</direction>
<relatedStateVariable>Mute</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>Mute</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Mute</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>VolumeLimit</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>VolumeLimit</relatedStateVariable>
</argument>
</argumentList>
</action>
</actionList>
<serviceStateTable>
<stateVariable sendEvents="yes">
<name>Volume</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>Mute</name>
<dataType>boolean</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>Balance</name>
<dataType>i4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>Fade</name>
<dataType>i4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeLimit</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeMax</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeUnity</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeSteps</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeMilliDbPerStep</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>BalanceMax</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>FadeMax</name>
<dataType>ui4</dataType>
</stateVariable>
</serviceStateTable>
</scpd>
</syntaxhighlight>

Av:Developer:VolumeService

2013-08-09T14:20:38Z

Johnh: expanded def'n of Characteristics; added neutral balance and fade; fixed minor spelling, layout glitches

= Architecture Overview =
The Volume Service provides a means of controlling various settings which affect the product's volume (signal amplitude) measured at the output channels. A product may have one or more output channels. Balance or Fade settings may result in different volumes at each output. In the Mute state, all output channels are reduced to zero volume.

==Volume==
Volume is an adjustable setting that controls the loudness of the audio at the output channels of the product. Volume can be set to an absolute value or incremented/decremented in single steps. The maximum Volume setting is defined by the current value of '''VolumeLimit'''. The minimum Volume setting is zero. If an attempt is made to set the Volume above VolumeLimit, the Volume will be set to the '''VolumLimit'''. If an attempt is made to set the Volume above '''VolumeMax''', an error will be reported.

== Volume Limit ==
VolumeLimit specifies the upper limit of the Volume. Any attempt to set Volume above the VolumeLimit will reset Volume to the value of VolumeLimit. If VolumeLimit is changed, Volume is checked and automatically reduced if necessary. The maximum VolumeLimit setting is defined by the '''VolumeMax''' Characteristic.

==Balance==
Balance is an adjustable setting that specifies the '''bias''' in volume between the '''left and right''' output channels of the product. Balance can be set to an absolute value or incremented/decremented in single steps. The maximum Balance setting is defined by the '''BalanceMax''' Characteristic. The minimum Balance setting is defined by ('''-BalanceMax''') .

==Fade==
Fade is an adjustable setting that specifies the '''bias''' in volume between the '''front and rear''' output channels of the products. Fade can be set to an absolute value or incremented/decremented in single steps. The maximum Fade setting is defined by the '''FadeMax''' Characteristic. The minimum Fade setting is defined by ('''-FadeMax''') .

==Mute==
Mute is an adjustable state that determines if the output channels of the product are muted or not. When muted, all output channels of the product are silent.

==Characteristics==
Each product has six read-only values that define value ranges and their granularity -- as well as notable values within these ranges -- for volume, balance, and fade.

====VolumeMax====
VolumeMax defines the absolute maximum Volume setting.

====VolumeUnity====
VolumeUnity defines the value of Volume that will result in unity system gain (i.e. ''output amplitude'' = ''input amplitude'').

====VolumeSteps====
VolumeSteps defines the number of step increments required to increase the Volume from zero to VolumeMax.

====VolumeMilliDbPerStep====
VolumeMilliDbPerStep defines the size of each volume step in '''binary milli decibels''' (mibi dB). [''1024mibi dB = 1dB'']

====BalanceMax====
BalanceMax defines the maximum Balance setting. The minimum Balance setting is (-BalanceMax). A setting of zero results in neutral balance (i.e. no artificial bias) between left and right output channels.

====FadeMax====
FadeMax defines the maximum Fade setting. The minimum Fade setting is (-FadeMax). A setting of zero results in neutral fade (i.e. no artificial bias) between front and back output channels.

=Actions=

=== Volume ===
The Volume action reports the current Volume setting.

=== SetVolume===
The SetVolume action provides a means of setting the Volume to an absolute value.

=== Volume Inc===
The VolumeInc action provides a means of increasing the Volume by 1.
=== Volume Dec ===
The VolumeDec action provides a means of decreasing the Volume by 1.
=== VolumeLimit ===
The VolumeLimit action reports the current VolumeLimit setting.
=== Balance ===
The Balance action reports the current Balance setting.
=== SetBalance ===
The SetBalance action provides a means of setting the Balance to a specific value.

=== BalanceInc===
The BalanceInc action provides a means of increasing the Balance by 1.
=== BalanceDec ===
The BalanceDec action provides a means of decreasing the Balance by 1.
=== Fade ===
The Fade action reports the current Fade setting of the product.
==== SetFade ====
The SetFade action provides a means of setting the Fade to a specific value.
=== FadeInc===
The FadeInc action provides a means of increasing the Fade by 1.

=== FadeDec ===
The FadeDec action provides a means of decreasing the Fade by 1.
=== Mute ===
The Mute action reports the current Mute state of the product.
=== SetMute ===
The SetMute action provides a means of setting the Mute state.

=== Characteristics ===
The Characteristics action returns all '''six''' characteristic values of the product.

= Technical Details =
<code>
Domain : av.openhome.org
Name : Volume
Version : 1
</code>

== Volume 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>Characteristics</name>
<argumentList>
<argument>
<name>VolumeMax</name>
<direction>out</direction>
<relatedStateVariable>VolumeMax</relatedStateVariable>
</argument>
<argument>
<name>VolumeUnity</name>
<direction>out</direction>
<relatedStateVariable>VolumeUnity</relatedStateVariable>
</argument>
<argument>
<name>VolumeSteps</name>
<direction>out</direction>
<relatedStateVariable>VolumeSteps</relatedStateVariable>
</argument>
<argument>
<name>VolumeMilliDbPerStep</name>
<direction>out</direction>
<relatedStateVariable>VolumeMilliDbPerStep</relatedStateVariable>
</argument>
<argument>
<name>BalanceMax</name>
<direction>out</direction>
<relatedStateVariable>BalanceMax</relatedStateVariable>
</argument>
<argument>
<name>FadeMax</name>
<direction>out</direction>
<relatedStateVariable>FadeMax</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>SetVolume</name>
<argumentList>
<argument>
<name>Value</name>
<direction>in</direction>
<relatedStateVariable>Volume</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>VolumeInc</name>
</action>
<action>
<name>VolumeDec</name>
</action>
<action>
<name>Volume</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Volume</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>SetBalance</name>
<argumentList>
<argument>
<name>Value</name>
<direction>in</direction>
<relatedStateVariable>Balance</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>BalanceInc</name>
</action>
<action>
<name>BalanceDec</name>
</action>
<action>
<name>Balance</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Balance</relatedStateVariable>
</argument>
</argumentList>
</action>

<action>
<name>SetFade</name>
<argumentList>
<argument>
<name>Value</name>
<direction>in</direction>
<relatedStateVariable>Fade</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>FadeInc</name>
</action>
<action>
<name>FadeDec</name>
</action>
<action>
<name>Fade</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Fade</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>SetMute</name>
<argumentList>
<argument>
<name>Value</name>
<direction>in</direction>
<relatedStateVariable>Mute</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>Mute</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>Mute</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>VolumeLimit</name>
<argumentList>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>VolumeLimit</relatedStateVariable>
</argument>
</argumentList>
</action>
</actionList>
<serviceStateTable>
<stateVariable sendEvents="yes">
<name>Volume</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>Mute</name>
<dataType>boolean</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>Balance</name>
<dataType>i4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>Fade</name>
<dataType>i4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeLimit</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeMax</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeUnity</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeSteps</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>VolumeMilliDbPerStep</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>BalanceMax</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>FadeMax</name>
<dataType>ui4</dataType>
</stateVariable>
</serviceStateTable>
</scpd>
</syntaxhighlight>

Av:Developer:InfoService

2013-08-07T13:34:37Z

Johnh: /* State Variables */ added description of remaining state variables

= 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 =
<code>
Domain : av.openhome.org
Name : Info
Version : 1
</code>

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

Av:Developer:InfoService

2013-08-06T13:48:46Z

Johnh: /* TrackCount */ described TrackCount

= 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 track played (incl. current one)

== DetailsCount ==
== MetatextCount ==
== Uri ==
== Metadata ==
== Duration ==
== BitRate ==
== BitDepth ==
== SampleRate ==
== Lossless ==
== CodecName ==
== Metatext ==

= Technical Details =
<code>
Domain : av.openhome.org
Name : Info
Version : 1
</code>

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

Av:Developer:InfoService

2013-08-06T13:37:36Z

Johnh: added section on State Variables

= 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 ==
== DetailsCount ==
== MetatextCount ==
== Uri ==
== Metadata ==
== Duration ==
== BitRate ==
== BitDepth ==
== SampleRate ==
== Lossless ==
== CodecName ==
== Metatext ==

= Technical Details =
<code>
Domain : av.openhome.org
Name : Info
Version : 1
</code>

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

Av:Developer:InfoService

2013-08-06T13:23:10Z

Johnh: /* Metatext */ fixed capitalisation

= 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.

= Technical Details =
<code>
Domain : av.openhome.org
Name : Info
Version : 1
</code>

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

Av:Developer:InfoService

2013-08-06T13:22:05Z

Johnh: /* Track */ fixed capitalisation

= 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.

= Technical Details =
<code>
Domain : av.openhome.org
Name : Info
Version : 1
</code>

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

Av:Developer:InfoService

2013-08-06T13:20:40Z

Johnh: /* Counters */ minor reordering and rewording

= 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.

= Technical Details =
<code>
Domain : av.openhome.org
Name : Info
Version : 1
</code>

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

Av:Developer:InfoService

2013-08-06T13:13:56Z

Johnh: /* Overview */ minor edit

= 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 manage the changing of the Track, Details, and Metatext information.

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.

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==
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.

= Technical Details =
<code>
Domain : av.openhome.org
Name : Info
Version : 1
</code>

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

Av:Developer:TimeService

2013-07-19T12:41:02Z

Johnh: added section on State Variables

= 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 [[Developer:Davaar:PlaylistService|Playlist Service]] or [[Developer:Davaar:RadioService|Radio Service]].

= Technical Details =
<code>
Domain : av.openhome.org
Name : Time
Version : 1
</code>

== Time 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>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>
</syntaxhighlight>

Av:Developer:TimeService

2013-07-19T12:34:48Z

Johnh: /* Architectural Overview */ added mention of TrackCount

= 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.

= 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 [[Developer:Davaar:PlaylistService|Playlist Service]] or [[Developer:Davaar:RadioService|Radio Service]].

= Technical Details =
<code>
Domain : av.openhome.org
Name : Time
Version : 1
</code>

== Time 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>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>
</syntaxhighlight>