Difference between revisions of "Developer:Davaar:VolumeService"

From LinnDocs
Jump to: navigation, search
(Mute)
m
 
(59 intermediate revisions by 3 users not shown)
Line 1: Line 1:
= Architecture Overview =
+
#redirect[http://wiki.openhome.org/wiki/Av:Developer:VolumeService  http://wiki.openhome.org/wiki/Av:Developer:VolumeService]
The Volume service 
 
 
 
==Volume==
 
Volume can be set to an absolute value or incremented/decremented in single steps. Volume can be adjusted in the range 0-100%.
 
A setting of 80 represents 0dB (unity gain) with reference to the volume of the input signal. Each step adjustment in the volume represents a 1dB change (79=-1dB, 78=-2dB, 100=+20dB).
 
 
 
==Balance==
 
==Fade==
 
==Mute==
 
 
 
== Volume Limit ==
 
The VolumeLimit parameter allows the master volume limit to be reduced. Any attempt to set the master volume above the VolumeLimit will reset the volume to the value of the VolumeLimit. Whenever the VolumeLimit is adjusted, the current master volume is checked and automatically reduced if necessary.
 
 
 
==Characterstics==
 
====VolumeMax====
 
====VolumeUnity====
 
====VolumeSteps====
 
====VolumeMilliDbPerStep====
 
====BalanceMax====
 
====FadeMax====
 
 
 
==Volume Actions==
 
 
 
==== Volume ====
 
The Volume action reports the current master volume setting of the product.
 
 
 
==== SetVolume====
 
The SetVolume action provides a means of setting the Volume to a specific value. The minimum value that can be applied is zero. The maximum value that can be applied is determined by the VolumeMax and VolumeLimit settings. If an attempt is made to set the Volume above VolumeMax, an error will  be reported. If an attempt is made to set the Volume above VolumeLimit, the Volume will be set to the VolumLimit value and no error will be repoprted. 
 
==== 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 FadeIncaction 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.
 
 
 
= API Reference =
 
 
 
[http://oss.linn.co.uk/trac/browser/Main/LibUpnpCil/Services/Openhome/Volume1.xml Volume Service Description (XML)]
 
 
 
= Migration Guide =
 
None.
 
 
 
== Upnp Action Name Changes ==
 
None.
 
 
 
 
 
== Obsolete Functions ==
 
 
 
None.
 

Latest revision as of 08:36, 13 March 2020