Difference between revisions of "Developer:Davaar:VolumeService"

From LinnDocs
Jump to: navigation, search
(Volume)
Line 20: Line 20:
 
The Volume action reports the current master volume setting of the product.
 
The Volume action reports the current master volume setting of the product.
  
==== Set Volume====
+
==== SetVolume====
 +
The SetVolume action provides a means of setting the current master volume of the product. 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====
 
==== Volume Inc====
 +
The VolumeInc action provides a means of increasing the Volume by 1.
 
==== Volume Dec ====
 
==== Volume Dec ====
==== Volume Limit ====
+
The VolumeDec action provides a means of decreasing the Volume by 1.
 +
==== VolumeLimit ====
 +
The VolumeDec action reports the current VolumeLimit setting of the product.
 
==== Balance ====
 
==== Balance ====
==== Set Balance ====
+
The Balance action reports the current Balance setting of the product.
==== Balance Inc====
+
==== SetBalance ====
==== Balance Dec ====
+
==== BalanceInc====
 +
==== BalanceDec ====
 
==== Fade ====
 
==== Fade ====
==== Set Fade ====
+
The Fade action reports the current Fade setting of the product.
==== Fade Inc====
+
==== SetFade ====
==== Fade Dec ====
+
==== FadeInc====
 +
==== FadeDec ====
 
==== Mute ====
 
==== Mute ====
==== Set Mute ====
+
The Mute action reports the current Mute state of the product.
 +
==== SetMute ====
 
==== Characteristics ====
 
==== Characteristics ====
 +
The Characteristics action reports the current Mute state of the product.
  
  
==DelayMaximum==
 
FadeMax specifies the maximum possible Fade value that can be applied to the product.
 
  
  

Revision as of 12:20, 23 November 2010

Architecture Overview

The Volume service

Volume

Balance

Fade

Mute

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 current master volume of the product. 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 VolumeDec action reports the current VolumeLimit setting of the product.

Balance

The Balance action reports the current Balance setting of the product.

SetBalance

BalanceInc

BalanceDec

Fade

The Fade action reports the current Fade setting of the product.

SetFade

FadeInc

FadeDec

Mute

The Mute action reports the current Mute state of the product.

SetMute

Characteristics

The Characteristics action reports the current Mute state of the product.



API Reference

Volume Service Description (XML)

Migration Guide

None.

Upnp Action Name Changes

None.


Obsolete Functions

None.